Class FieldDefinition

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

Defines a field in an entity schema for REST connector data sources, specifying the field name and data type.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the field in the entity schema.

      Returns:
      The name of the field in the entity schema.

    • fieldDataType

      public final FieldDataType fieldDataType()

      The data type of the field.

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

      Returns:
      The data type of the field.
      See Also:

    • fieldDataTypeAsString

      public final String fieldDataTypeAsString()

      The data type of the field.

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

      Returns:
      The data type of the field.
      See Also:

    • responseDateFormat

      public final String responseDateFormat()

      The format pattern for parsing date values from API responses. Required when the API uses a non-ISO-8601 format. Accepts Java DateTimeFormatter patterns (for example, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS for Unix epoch seconds, or EPOCH_MILLIS for Unix epoch milliseconds.

      Returns:
      The format pattern for parsing date values from API responses. Required when the API uses a non-ISO-8601 format. Accepts Java DateTimeFormatter patterns (for example, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS for Unix epoch seconds, or EPOCH_MILLIS for Unix epoch milliseconds.

    • isPartitionable

      public final Boolean isPartitionable()

      Indicates whether this field can be used for partitioning queries to the data source.

      Returns:
      Indicates whether this field can be used for partitioning queries to the data source.

    • isNullable

      public final Boolean isNullable()

      Indicates whether this field can contain null values.

      Returns:
      Indicates whether this field can contain null values.

    • isQueryable

      public final Boolean isQueryable()

      Indicates whether this field can be used in filter predicates when querying data.

      Returns:
      Indicates whether this field can be used in filter predicates when querying data.

    • isOrderable

      public final Boolean isOrderable()

      Indicates whether this field can be used for ordering results.

      Returns:
      Indicates whether this field can be used for ordering results.

    • filterOverrides

      public final FilterOverrides filterOverrides()

      Per-field overrides for filter behavior, allowing customization of how filters are applied to this specific field.

      Returns:
      Per-field overrides for filter behavior, allowing customization of how filters are applied to this specific field.

    • toBuilder

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

    • builder

      public static FieldDefinition.Builder builder()

    • serializableBuilderClass

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