Class ViewSearchCriteria

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

Defines the search criteria for filtering views.

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<ViewSearchCriteria> orConditions()

      A list of conditions to be met, where at least one condition must be satisfied.

      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 to be met, where at least one condition must be satisfied.

    • 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<ViewSearchCriteria> andConditions()

      A list of conditions that must all be satisfied.

      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 that must all be satisfied.

    • stringCondition

      public final StringCondition stringCondition()
      Returns the value of the StringCondition property for this object.
      Returns:
      The value of the StringCondition property for this object.

    • viewTypeCondition

      public final ViewType viewTypeCondition()

      A condition that filters views by their type.

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

      Returns:
      A condition that filters views by their type.
      See Also:

    • viewTypeConditionAsString

      public final String viewTypeConditionAsString()

      A condition that filters views by their type.

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

      Returns:
      A condition that filters views by their type.
      See Also:

    • viewStatusCondition

      public final ViewStatus viewStatusCondition()

      A condition that filters views by their status.

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

      Returns:
      A condition that filters views by their status.
      See Also:

    • viewStatusConditionAsString

      public final String viewStatusConditionAsString()

      A condition that filters views by their status.

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

      Returns:
      A condition that filters views by their status.
      See Also:

    • toBuilder

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

    • builder

      public static ViewSearchCriteria.Builder builder()

    • serializableBuilderClass

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