Class StorageDescriptor

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

Describes the physical storage of table data.

See Also:

  • Method Details

    • hasColumns

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

    • columns

      public final List<Column> columns()

      A list of the Columns in the table.

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

      Returns:
      A list of the Columns in the table.

    • location

      public final String location()

      The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

      Returns:
      The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

    • hasAdditionalLocations

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

    • additionalLocations

      public final List<String> additionalLocations()

      A list of locations that point to the path where a Delta table is located.

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

      Returns:
      A list of locations that point to the path where a Delta table is located.

    • inputFormat

      public final String inputFormat()

      The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

      Returns:
      The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

    • outputFormat

      public final String outputFormat()

      The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

      Returns:
      The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

    • compressed

      public final Boolean compressed()

      True if the data in the table is compressed, or False if not.

      Returns:
      True if the data in the table is compressed, or False if not.

    • numberOfBuckets

      public final Integer numberOfBuckets()

      Must be specified if the table contains any dimension columns.

      Returns:
      Must be specified if the table contains any dimension columns.

    • serdeInfo

      public final SerDeInfo serdeInfo()

      The serialization/deserialization (SerDe) information.

      Returns:
      The serialization/deserialization (SerDe) information.

    • hasBucketColumns

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

    • bucketColumns

      public final List<String> bucketColumns()

      A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

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

      Returns:
      A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

    • hasSortColumns

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

    • sortColumns

      public final List<Order> sortColumns()

      A list specifying the sort order of each bucket in the table.

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

      Returns:
      A list specifying the sort order of each bucket in the table.

    • hasParameters

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

    • parameters

      public final Map<String,String> parameters()

      The user-supplied properties in key-value form.

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

      Returns:
      The user-supplied properties in key-value form.

    • skewedInfo

      public final SkewedInfo skewedInfo()

      The information about values that appear frequently in a column (skewed values).

      Returns:
      The information about values that appear frequently in a column (skewed values).

    • storedAsSubDirectories

      public final Boolean storedAsSubDirectories()

      True if the table data is stored in subdirectories, or False if not.

      Returns:
      True if the table data is stored in subdirectories, or False if not.

    • schemaReference

      public final SchemaReference schemaReference()

      An object that references a schema stored in the Glue Schema Registry.

      When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

      Returns:
      An object that references a schema stored in the Glue Schema Registry.

      When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

    • toBuilder

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

    • builder

      public static StorageDescriptor.Builder builder()

    • serializableBuilderClass

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