Class StorageDescriptor
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StorageDescriptor.Builder,
StorageDescriptor>
Describes the physical storage of table data.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA list of locations that point to the path where a Delta table is located.A list of reducer grouping columns, clustering columns, and bucketing columns in the table.static StorageDescriptor.Builder
builder()
columns()
A list of theColumns
in the table.final Boolean
True
if the data in the table is compressed, orFalse
if not.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdditionalLocations property.final boolean
For responses, this returns true if the service returned a value for the BucketColumns property.final boolean
For responses, this returns true if the service returned a value for the Columns property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Parameters property.final boolean
For responses, this returns true if the service returned a value for the SortColumns property.final String
The input format:SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.final String
location()
The physical location of the table.final Integer
Must be specified if the table contains any dimension columns.final String
The output format:SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.The user-supplied properties in key-value form.final SchemaReference
An object that references a schema stored in the Glue Schema Registry.final SerDeInfo
The serialization/deserialization (SerDe) information.static Class
<? extends StorageDescriptor.Builder> final SkewedInfo
The information about values that appear frequently in a column (skewed values).A list specifying the sort order of each bucket in the table.final Boolean
True
if the table data is stored in subdirectories, orFalse
if not.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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
The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.- Returns:
- The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.
-
outputFormat
The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.- Returns:
- The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.
-
compressed
True
if the data in the table is compressed, orFalse
if not.- Returns:
True
if the data in the table is compressed, orFalse
if not.
-
numberOfBuckets
Must be specified if the table contains any dimension columns.
- Returns:
- Must be specified if the table contains any dimension columns.
-
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
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
True
if the table data is stored in subdirectories, orFalse
if not.- Returns:
True
if the table data is stored in subdirectories, orFalse
if not.
-
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
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 interfaceToCopyableBuilder<StorageDescriptor.Builder,
StorageDescriptor> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-