Class QueueSearchCriteria

java.lang.Object
software.amazon.awssdk.services.connect.model.QueueSearchCriteria
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<QueueSearchCriteria.Builder,QueueSearchCriteria>
@Generated("software.amazon.awssdk:codegen") public final class QueueSearchCriteria extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QueueSearchCriteria.Builder,QueueSearchCriteria>

The search criteria to be used to return queues.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

See Also:

  • Method Details

    • hasOrConditions

      public final boolean hasOrConditions()
      For responses, this returns true if the service returned a value for the OrConditions 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.

    • orConditions

      public final List<QueueSearchCriteria> orConditions()

      A list of conditions which would be applied together with an OR condition.

      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 hasOrConditions() method.

      Returns:
      A list of conditions which would be applied together with an OR condition.

    • hasAndConditions

      public final boolean hasAndConditions()
      For responses, this returns true if the service returned a value for the AndConditions 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.

    • andConditions

      public final List<QueueSearchCriteria> andConditions()

      A list of conditions which would be applied together with an AND condition.

      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 hasAndConditions() method.

      Returns:
      A list of conditions which would be applied together with an AND condition.

    • stringCondition

      public final StringCondition stringCondition()

      A leaf node condition which can be used to specify a string condition.

      The currently supported values for FieldName are name, description, and resourceID.

      Returns:
      A leaf node condition which can be used to specify a string condition.

      The currently supported values for FieldName are name, description , and resourceID.

    • queueTypeCondition

      public final SearchableQueueType queueTypeCondition()

      The type of queue.

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

      Returns:
      The type of queue.
      See Also:

    • queueTypeConditionAsString

      public final String queueTypeConditionAsString()

      The type of queue.

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

      Returns:
      The type of queue.
      See Also:

    • toBuilder

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

    • builder

      public static QueueSearchCriteria.Builder builder()

    • serializableBuilderClass

      public static Class<? extends QueueSearchCriteria.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.