software.amazon.awssdk.services.chimesdkmessaging.model

Class SearchField

java.lang.Object

software.amazon.awssdk.services.chimesdkmessaging.model.SearchField

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SearchField.Builder,SearchField>

@Generated(value="software.amazon.awssdk:codegen")
public final class SearchField
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SearchField.Builder,SearchField>

A Field of the channel that you want to search.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchField.Builder

Method Summary

Modifier and Type	Method and Description
static SearchField.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() For responses, this returns true if the service returned a value for the Values property.
SearchFieldKey	key() An enum value that indicates the key to search the channel on.
String	keyAsString() An enum value that indicates the key to search the channel on.
SearchFieldOperator	operator() The operator used to compare field values, currently EQUALS or INCLUDES.
String	operatorAsString() The operator used to compare field values, currently EQUALS or INCLUDES.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchField.Builder>	serializableBuilderClass()
SearchField.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() The values that you want to search for, a list of strings.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

key

public final 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.

If the service returns an enum value that is not available in the current SDK version, key will return SearchFieldKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

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 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.

See Also:

SearchFieldKey

keyAsString

public final String 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 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.

If the service returns an enum value that is not available in the current SDK version, key will return SearchFieldKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

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 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.

See Also:

SearchFieldKey

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 the isEmpty() 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

public final List<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.

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

public final 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.

If the service returns an enum value that is not available in the current SDK version, operator will return SearchFieldOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

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.

See Also:

SearchFieldOperator

operatorAsString

public final String operatorAsString()

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.

If the service returns an enum value that is not available in the current SDK version, operator will return SearchFieldOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

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.

See Also:

SearchFieldOperator

toBuilder

public SearchField.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchField.Builder,SearchField>

builder

public static SearchField.Builder builder()

serializableBuilderClass

public static Class<? extends SearchField.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo