@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SearchField extends Object implements Serializable, Cloneable, StructuredPojo
A Field
of the channel that you want to search.
Constructor and Description |
---|
SearchField() |
Modifier and Type | Method and Description |
---|---|
SearchField |
clone() |
boolean |
equals(Object obj) |
String |
getKey()
An
enum value that indicates the key to search the channel on. |
String |
getOperator()
The operator used to compare field values, currently
EQUALS or INCLUDES . |
List<String> |
getValues()
The values that you want to search for, a list of strings.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setKey(String key)
An
enum value that indicates the key to search the channel on. |
void |
setOperator(String operator)
The operator used to compare field values, currently
EQUALS or INCLUDES . |
void |
setValues(Collection<String> values)
The values that you want to search for, a list of strings.
|
String |
toString()
Returns a string representation of this object.
|
SearchField |
withKey(SearchFieldKey key)
An
enum value that indicates the key to search the channel on. |
SearchField |
withKey(String key)
An
enum value that indicates the key to search the channel on. |
SearchField |
withOperator(SearchFieldOperator operator)
The operator used to compare field values, currently
EQUALS or INCLUDES . |
SearchField |
withOperator(String operator)
The operator used to compare field values, currently
EQUALS or INCLUDES . |
SearchField |
withValues(Collection<String> values)
The values that you want to search for, a list of strings.
|
SearchField |
withValues(String... values)
The values that you want to search for, a list of strings.
|
public void setKey(String key)
An enum
value that indicates the key to search the channel on. MEMBERS
allows you to
search channels based on memberships. You can use it with the EQUALS
operator to get channels whose
memberships are equal to the specified values, and with the INCLUDES
operator to get channels whose
memberships include the specified values.
key
- An enum
value that indicates the key to search the channel on. MEMBERS
allows
you to search channels based on memberships. You can use it with the EQUALS
operator to get
channels whose memberships are equal to the specified values, and with the INCLUDES
operator
to get channels whose memberships include the specified values.SearchFieldKey
public String getKey()
An enum
value that indicates the key to search the channel on. MEMBERS
allows you to
search channels based on memberships. You can use it with the EQUALS
operator to get channels whose
memberships are equal to the specified values, and with the INCLUDES
operator to get channels whose
memberships include the specified values.
enum
value that indicates the key to search the channel on. MEMBERS
allows
you to search channels based on memberships. You can use it with the EQUALS
operator to get
channels whose memberships are equal to the specified values, and with the INCLUDES
operator
to get channels whose memberships include the specified values.SearchFieldKey
public SearchField withKey(String key)
An enum
value that indicates the key to search the channel on. MEMBERS
allows you to
search channels based on memberships. You can use it with the EQUALS
operator to get channels whose
memberships are equal to the specified values, and with the INCLUDES
operator to get channels whose
memberships include the specified values.
key
- An enum
value that indicates the key to search the channel on. MEMBERS
allows
you to search channels based on memberships. You can use it with the EQUALS
operator to get
channels whose memberships are equal to the specified values, and with the INCLUDES
operator
to get channels whose memberships include the specified values.SearchFieldKey
public SearchField withKey(SearchFieldKey key)
An enum
value that indicates the key to search the channel on. MEMBERS
allows you to
search channels based on memberships. You can use it with the EQUALS
operator to get channels whose
memberships are equal to the specified values, and with the INCLUDES
operator to get channels whose
memberships include the specified values.
key
- An enum
value that indicates the key to search the channel on. MEMBERS
allows
you to search channels based on memberships. You can use it with the EQUALS
operator to get
channels whose memberships are equal to the specified values, and with the INCLUDES
operator
to get channels whose memberships include the specified values.SearchFieldKey
public List<String> getValues()
The values that you want to search for, a list of strings. The values must be AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers
with large number of memberships.
AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers
with large number of memberships.
public void setValues(Collection<String> values)
The values that you want to search for, a list of strings. The values must be AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers
with large number of memberships.
values
- The values that you want to search for, a list of strings. The values must be
AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers
with large number of memberships.
public SearchField withValues(String... values)
The values that you want to search for, a list of strings. The values must be AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers
with large number of memberships.
NOTE: This method appends the values to the existing list (if any). Use
setValues(java.util.Collection)
or withValues(java.util.Collection)
if you want to override the
existing values.
values
- The values that you want to search for, a list of strings. The values must be
AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers
with large number of memberships.
public SearchField withValues(Collection<String> values)
The values that you want to search for, a list of strings. The values must be AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers
with large number of memberships.
values
- The values that you want to search for, a list of strings. The values must be
AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers
with large number of memberships.
public void setOperator(String operator)
The operator used to compare field values, currently EQUALS
or INCLUDES
. Use the
EQUALS
operator to find channels whose memberships equal the specified values. Use the
INCLUDES
operator to find channels whose memberships include the specified values.
operator
- The operator used to compare field values, currently EQUALS
or INCLUDES
. Use the
EQUALS
operator to find channels whose memberships equal the specified values. Use the
INCLUDES
operator to find channels whose memberships include the specified values.SearchFieldOperator
public String getOperator()
The operator used to compare field values, currently EQUALS
or INCLUDES
. Use the
EQUALS
operator to find channels whose memberships equal the specified values. Use the
INCLUDES
operator to find channels whose memberships include the specified values.
EQUALS
or INCLUDES
. Use
the EQUALS
operator to find channels whose memberships equal the specified values. Use the
INCLUDES
operator to find channels whose memberships include the specified values.SearchFieldOperator
public SearchField withOperator(String operator)
The operator used to compare field values, currently EQUALS
or INCLUDES
. Use the
EQUALS
operator to find channels whose memberships equal the specified values. Use the
INCLUDES
operator to find channels whose memberships include the specified values.
operator
- The operator used to compare field values, currently EQUALS
or INCLUDES
. Use the
EQUALS
operator to find channels whose memberships equal the specified values. Use the
INCLUDES
operator to find channels whose memberships include the specified values.SearchFieldOperator
public SearchField withOperator(SearchFieldOperator operator)
The operator used to compare field values, currently EQUALS
or INCLUDES
. Use the
EQUALS
operator to find channels whose memberships equal the specified values. Use the
INCLUDES
operator to find channels whose memberships include the specified values.
operator
- The operator used to compare field values, currently EQUALS
or INCLUDES
. Use the
EQUALS
operator to find channels whose memberships equal the specified values. Use the
INCLUDES
operator to find channels whose memberships include the specified values.SearchFieldOperator
public String toString()
toString
in class Object
Object.toString()
public SearchField clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.