Class Field

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

The Field object has information about the different properties associated with a field in the connector.

See Also:

  • Method Details

    • fieldName

      public final String fieldName()

      A unique identifier for the field.

      Returns:
      A unique identifier for the field.

    • label

      public final String label()

      A readable label used for the field.

      Returns:
      A readable label used for the field.

    • description

      public final String description()

      A description of the field.

      Returns:
      A description of the field.

    • fieldType

      public final FieldDataType fieldType()

      The type of data in the field.

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

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

    • fieldTypeAsString

      public final String fieldTypeAsString()

      The type of data in the field.

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

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

    • isPrimaryKey

      public final Boolean isPrimaryKey()

      Indicates whether this field can used as a primary key for the given entity.

      Returns:
      Indicates whether this field can used as a primary key for the given entity.

    • isNullable

      public final Boolean isNullable()

      Indicates whether this field can be nullable or not.

      Returns:
      Indicates whether this field can be nullable or not.

    • isRetrievable

      public final Boolean isRetrievable()

      Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.

      Returns:
      Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.

    • isFilterable

      public final Boolean isFilterable()

      Indicates whether this field can used in a filter clause (WHERE clause) of a SQL statement when querying data.

      Returns:
      Indicates whether this field can used in a filter clause (WHERE clause) of a SQL statement when querying data.

    • isPartitionable

      public final Boolean isPartitionable()

      Indicates whether a given field can be used in partitioning the query made to SaaS.

      Returns:
      Indicates whether a given field can be used in partitioning the query made to SaaS.

    • isCreateable

      public final Boolean isCreateable()

      Indicates whether this field can be created as part of a destination write.

      Returns:
      Indicates whether this field can be created as part of a destination write.

    • isUpdateable

      public final Boolean isUpdateable()

      Indicates whether this field can be updated as part of a destination write.

      Returns:
      Indicates whether this field can be updated as part of a destination write.

    • isUpsertable

      public final Boolean isUpsertable()

      Indicates whether this field can be upserted as part of a destination write.

      Returns:
      Indicates whether this field can be upserted as part of a destination write.

    • isDefaultOnCreate

      public final Boolean isDefaultOnCreate()

      Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.

      Returns:
      Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.

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

      A list of supported values for the 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 hasSupportedValues() method.

      Returns:
      A list of supported values for the field.

    • supportedFilterOperators

      public final List<FieldFilterOperator> supportedFilterOperators()

      Indicates the support filter operators for this 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 hasSupportedFilterOperators() method.

      Returns:
      Indicates the support filter operators for this field.

    • hasSupportedFilterOperators

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

    • supportedFilterOperatorsAsStrings

      public final List<String> supportedFilterOperatorsAsStrings()

      Indicates the support filter operators for this 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 hasSupportedFilterOperators() method.

      Returns:
      Indicates the support filter operators for this field.

    • parentField

      public final String parentField()

      A parent field name for a nested field.

      Returns:
      A parent field name for a nested field.

    • nativeDataType

      public final String nativeDataType()

      The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.

      Returns:
      The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.

    • hasCustomProperties

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

    • customProperties

      public final Map<String,String> customProperties()

      Optional map of keys which may be returned.

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

      Returns:
      Optional map of keys which may be returned.

    • toBuilder

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

    • builder

      public static Field.Builder builder()

    • serializableBuilderClass

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