Class FieldTypeDetails

java.lang.Object
software.amazon.awssdk.services.appflow.model.FieldTypeDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FieldTypeDetails.Builder,FieldTypeDetails>

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

Contains details regarding the supported field type and the operators that can be applied for filtering.

See Also:
  • Method Details

    • fieldType

      public final String fieldType()

      The type of field, such as string, integer, date, and so on.

      Returns:
      The type of field, such as string, integer, date, and so on.
    • filterOperators

      public final List<Operator> filterOperators()

      The list of operators supported by a field.

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

      Returns:
      The list of operators supported by a field.
    • hasFilterOperators

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

      public final List<String> filterOperatorsAsStrings()

      The list of operators supported by a field.

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

      Returns:
      The list of operators supported by a field.
    • hasSupportedValues

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

      public final List<String> supportedValues()

      The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".

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

      Returns:
      The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".
    • valueRegexPattern

      public final String valueRegexPattern()

      The regular expression pattern for the field name.

      Returns:
      The regular expression pattern for the field name.
    • supportedDateFormat

      public final String supportedDateFormat()

      The date format that the field supports.

      Returns:
      The date format that the field supports.
    • fieldValueRange

      public final Range fieldValueRange()

      The range of values this field can hold.

      Returns:
      The range of values this field can hold.
    • fieldLengthRange

      public final Range fieldLengthRange()

      This is the allowable length range for this field's value.

      Returns:
      This is the allowable length range for this field's value.
    • toBuilder

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

      public static FieldTypeDetails.Builder builder()
    • serializableBuilderClass

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