software.amazon.awssdk.services.chimesdkmessaging.model

Interface SearchField.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SearchField.Builder,SearchField>, SdkBuilder<SearchField.Builder,SearchField>, SdkPojo

Enclosing class:

SearchField

public static interface SearchField.Builder
extends SdkPojo, CopyableBuilder<SearchField.Builder,SearchField>

Method Summary

Modifier and Type	Method and Description
SearchField.Builder	key(SearchFieldKey key) An enum value that indicates the key to search the channel on.
SearchField.Builder	key(String key) An enum value that indicates the key to search the channel on.
SearchField.Builder	operator(SearchFieldOperator operator) The operator used to compare field values, currently EQUALS or INCLUDES.
SearchField.Builder	operator(String operator) The operator used to compare field values, currently EQUALS or INCLUDES.
SearchField.Builder	values(Collection<String> values) The values that you want to search for, a list of strings.
SearchField.Builder	values(String... values) The values that you want to search for, a list of strings.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

key

SearchField.Builder key(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SearchFieldKey, SearchFieldKey

key

SearchField.Builder key(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SearchFieldKey, SearchFieldKey

values

SearchField.Builder values(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

values

SearchField.Builder values(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

operator

SearchField.Builder operator(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SearchFieldOperator, SearchFieldOperator

operator

SearchField.Builder operator(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SearchFieldOperator, SearchFieldOperator