Class SearchField
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SearchField.Builder,
SearchField>
A Field
of the channel that you want to search.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SearchField.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Values property.final SearchFieldKey
key()
Anenum
value that indicates the key to search the channel on.final String
Anenum
value that indicates the key to search the channel on.final SearchFieldOperator
operator()
The operator used to compare field values, currentlyEQUALS
orINCLUDES
.final String
The operator used to compare field values, currentlyEQUALS
orINCLUDES
.static Class
<? extends SearchField.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.values()
The values that you want to search for, a list of strings.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theEQUALS
operator to get channels whose memberships are equal to the specified values, and with theINCLUDES
operator to get channels whose memberships include the specified values.If the service returns an enum value that is not available in the current SDK version,
key
will returnSearchFieldKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyAsString()
.- Returns:
- 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 theEQUALS
operator to get channels whose memberships are equal to the specified values, and with theINCLUDES
operator to get channels whose memberships include the specified values. - See Also:
-
keyAsString
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 theEQUALS
operator to get channels whose memberships are equal to the specified values, and with theINCLUDES
operator to get channels whose memberships include the specified values.If the service returns an enum value that is not available in the current SDK version,
key
will returnSearchFieldKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyAsString()
.- Returns:
- 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 theEQUALS
operator to get channels whose memberships are equal to the specified values, and with theINCLUDES
operator to get channels whose memberships include the specified values. - See Also:
-
hasValues
public final boolean hasValues()For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasValues()
method.- Returns:
- 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.
-
operator
The operator used to compare field values, currently
EQUALS
orINCLUDES
. Use theEQUALS
operator to find channels whose memberships equal the specified values. Use theINCLUDES
operator to find channels whose memberships include the specified values.If the service returns an enum value that is not available in the current SDK version,
operator
will returnSearchFieldOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatorAsString()
.- Returns:
- The operator used to compare field values, currently
EQUALS
orINCLUDES
. Use theEQUALS
operator to find channels whose memberships equal the specified values. Use theINCLUDES
operator to find channels whose memberships include the specified values. - See Also:
-
operatorAsString
The operator used to compare field values, currently
EQUALS
orINCLUDES
. Use theEQUALS
operator to find channels whose memberships equal the specified values. Use theINCLUDES
operator to find channels whose memberships include the specified values.If the service returns an enum value that is not available in the current SDK version,
operator
will returnSearchFieldOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatorAsString()
.- Returns:
- The operator used to compare field values, currently
EQUALS
orINCLUDES
. Use theEQUALS
operator to find channels whose memberships equal the specified values. Use theINCLUDES
operator to find channels whose memberships include the specified values. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SearchField.Builder,
SearchField> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-