Class ColumnInfo

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

Information about the columns in a query execution result.

See Also:

  • Method Details

    • catalogName

      public final String catalogName()

      The catalog to which the query results belong.

      Returns:
      The catalog to which the query results belong.

    • schemaName

      public final String schemaName()

      The schema name (database name) to which the query results belong.

      Returns:
      The schema name (database name) to which the query results belong.

    • tableName

      public final String tableName()

      The table name for the query results.

      Returns:
      The table name for the query results.

    • name

      public final String name()

      The name of the column.

      Returns:
      The name of the column.

    • label

      public final String label()

      A column label.

      Returns:
      A column label.

    • type

      public final String type()

      The data type of the column.

      Returns:
      The data type of the column.

    • precision

      public final Integer precision()

      For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.

      Returns:
      For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.

    • scale

      public final Integer scale()

      For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.

      Returns:
      For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.

    • nullable

      public final ColumnNullable nullable()

      Unsupported constraint. This value always shows as UNKNOWN.

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

      Returns:
      Unsupported constraint. This value always shows as UNKNOWN.
      See Also:

    • nullableAsString

      public final String nullableAsString()

      Unsupported constraint. This value always shows as UNKNOWN.

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

      Returns:
      Unsupported constraint. This value always shows as UNKNOWN.
      See Also:

    • caseSensitive

      public final Boolean caseSensitive()

      Indicates whether values in the column are case-sensitive.

      Returns:
      Indicates whether values in the column are case-sensitive.

    • toBuilder

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

    • builder

      public static ColumnInfo.Builder builder()

    • serializableBuilderClass

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