Class SearchField

java.lang.Object
software.amazon.awssdk.services.chimesdkmessaging.model.SearchField
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SearchField.Builder,SearchField>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public SearchField.Builder 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 interface ToCopyableBuilder<SearchField.Builder,SearchField>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.