StorageDescriptor (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.glue.model.StorageDescriptor

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StorageDescriptor
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the physical storage of table data.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StorageDescriptor()

Constructors
Constructor and Description
`StorageDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StorageDescriptor`	`addParametersEntry(String key, String value)` Add a single Parameters entry
`StorageDescriptor`	`clearParametersEntries()` Removes all the entries added into Parameters.
`StorageDescriptor`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAdditionalLocations()` A list of locations that point to the path where a Delta table is located.
`List<String>`	`getBucketColumns()` A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
`List<Column>`	`getColumns()` A list of the `Columns` in the table.
`Boolean`	`getCompressed()` `True` if the data in the table is compressed, or `False` if not.
`String`	`getInputFormat()` The input format: `SequenceFileInputFormat` (binary), or `TextInputFormat`, or a custom format.
`String`	`getLocation()` The physical location of the table.
`Integer`	`getNumberOfBuckets()` Must be specified if the table contains any dimension columns.
`String`	`getOutputFormat()` The output format: `SequenceFileOutputFormat` (binary), or `IgnoreKeyTextOutputFormat`, or a custom format.
`Map<String,String>`	`getParameters()` The user-supplied properties in key-value form.
`SchemaReference`	`getSchemaReference()` An object that references a schema stored in the Glue Schema Registry.
`SerDeInfo`	`getSerdeInfo()` The serialization/deserialization (SerDe) information.
`SkewedInfo`	`getSkewedInfo()` The information about values that appear frequently in a column (skewed values).
`List<Order>`	`getSortColumns()` A list specifying the sort order of each bucket in the table.
`Boolean`	`getStoredAsSubDirectories()` `True` if the table data is stored in subdirectories, or `False` if not.
`int`	`hashCode()`
`Boolean`	`isCompressed()` `True` if the data in the table is compressed, or `False` if not.
`Boolean`	`isStoredAsSubDirectories()` `True` if the table data is stored in subdirectories, or `False` if not.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalLocations(Collection<String> additionalLocations)` A list of locations that point to the path where a Delta table is located.
`void`	`setBucketColumns(Collection<String> bucketColumns)` A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
`void`	`setColumns(Collection<Column> columns)` A list of the `Columns` in the table.
`void`	`setCompressed(Boolean compressed)` `True` if the data in the table is compressed, or `False` if not.
`void`	`setInputFormat(String inputFormat)` The input format: `SequenceFileInputFormat` (binary), or `TextInputFormat`, or a custom format.
`void`	`setLocation(String location)` The physical location of the table.
`void`	`setNumberOfBuckets(Integer numberOfBuckets)` Must be specified if the table contains any dimension columns.
`void`	`setOutputFormat(String outputFormat)` The output format: `SequenceFileOutputFormat` (binary), or `IgnoreKeyTextOutputFormat`, or a custom format.
`void`	`setParameters(Map<String,String> parameters)` The user-supplied properties in key-value form.
`void`	`setSchemaReference(SchemaReference schemaReference)` An object that references a schema stored in the Glue Schema Registry.
`void`	`setSerdeInfo(SerDeInfo serdeInfo)` The serialization/deserialization (SerDe) information.
`void`	`setSkewedInfo(SkewedInfo skewedInfo)` The information about values that appear frequently in a column (skewed values).
`void`	`setSortColumns(Collection<Order> sortColumns)` A list specifying the sort order of each bucket in the table.
`void`	`setStoredAsSubDirectories(Boolean storedAsSubDirectories)` `True` if the table data is stored in subdirectories, or `False` if not.
`String`	`toString()` Returns a string representation of this object.
`StorageDescriptor`	`withAdditionalLocations(Collection<String> additionalLocations)` A list of locations that point to the path where a Delta table is located.
`StorageDescriptor`	`withAdditionalLocations(String... additionalLocations)` A list of locations that point to the path where a Delta table is located.
`StorageDescriptor`	`withBucketColumns(Collection<String> bucketColumns)` A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
`StorageDescriptor`	`withBucketColumns(String... bucketColumns)` A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
`StorageDescriptor`	`withColumns(Collection<Column> columns)` A list of the `Columns` in the table.
`StorageDescriptor`	`withColumns(Column... columns)` A list of the `Columns` in the table.
`StorageDescriptor`	`withCompressed(Boolean compressed)` `True` if the data in the table is compressed, or `False` if not.
`StorageDescriptor`	`withInputFormat(String inputFormat)` The input format: `SequenceFileInputFormat` (binary), or `TextInputFormat`, or a custom format.
`StorageDescriptor`	`withLocation(String location)` The physical location of the table.
`StorageDescriptor`	`withNumberOfBuckets(Integer numberOfBuckets)` Must be specified if the table contains any dimension columns.
`StorageDescriptor`	`withOutputFormat(String outputFormat)` The output format: `SequenceFileOutputFormat` (binary), or `IgnoreKeyTextOutputFormat`, or a custom format.
`StorageDescriptor`	`withParameters(Map<String,String> parameters)` The user-supplied properties in key-value form.
`StorageDescriptor`	`withSchemaReference(SchemaReference schemaReference)` An object that references a schema stored in the Glue Schema Registry.
`StorageDescriptor`	`withSerdeInfo(SerDeInfo serdeInfo)` The serialization/deserialization (SerDe) information.
`StorageDescriptor`	`withSkewedInfo(SkewedInfo skewedInfo)` The information about values that appear frequently in a column (skewed values).
`StorageDescriptor`	`withSortColumns(Collection<Order> sortColumns)` A list specifying the sort order of each bucket in the table.
`StorageDescriptor`	`withSortColumns(Order... sortColumns)` A list specifying the sort order of each bucket in the table.
`StorageDescriptor`	`withStoredAsSubDirectories(Boolean storedAsSubDirectories)` `True` if the table data is stored in subdirectories, or `False` if not.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StorageDescriptor
```
public StorageDescriptor()
```
- Method Detail
  - getColumns
```
public List<Column> getColumns()
```
    A list of the Columns in the table.
    
    Returns:
    
    A list of the Columns in the table.
  - setColumns
```
public void setColumns(Collection<Column> columns)
```
    A list of the Columns in the table.
    
    Parameters:
    
    columns - A list of the Columns in the table.
  - withColumns
```
public StorageDescriptor withColumns(Column... columns)
```
    A list of the Columns in the table.
    
    NOTE: This method appends the values to the existing list (if any). Use setColumns(java.util.Collection) or withColumns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    columns - A list of the Columns in the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withColumns
```
public StorageDescriptor withColumns(Collection<Column> columns)
```
    A list of the Columns in the table.
    
    Parameters:
    
    columns - A list of the Columns in the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(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.
    
    Parameters:
    
    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.
  - getLocation
```
public String getLocation()
```
    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.
  - withLocation
```
public StorageDescriptor withLocation(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalLocations
```
public List<String> getAdditionalLocations()
```
    A list of locations that point to the path where a Delta table is located.
    
    Returns:
    
    A list of locations that point to the path where a Delta table is located.
  - setAdditionalLocations
```
public void setAdditionalLocations(Collection<String> additionalLocations)
```
    A list of locations that point to the path where a Delta table is located.
    
    Parameters:
    
    additionalLocations - A list of locations that point to the path where a Delta table is located.
  - withAdditionalLocations
```
public StorageDescriptor withAdditionalLocations(String... additionalLocations)
```
    A list of locations that point to the path where a Delta table is located.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalLocations(java.util.Collection) or withAdditionalLocations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    additionalLocations - A list of locations that point to the path where a Delta table is located.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalLocations
```
public StorageDescriptor withAdditionalLocations(Collection<String> additionalLocations)
```
    A list of locations that point to the path where a Delta table is located.
    
    Parameters:
    
    additionalLocations - A list of locations that point to the path where a Delta table is located.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputFormat
```
public void setInputFormat(String inputFormat)
```
    The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
    
    Parameters:
    
    inputFormat - The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
  - getInputFormat
```
public String getInputFormat()
```
    The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
    
    Returns:
    
    The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
  - withInputFormat
```
public StorageDescriptor withInputFormat(String inputFormat)
```
    The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
    
    Parameters:
    
    inputFormat - The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputFormat
```
public void setOutputFormat(String outputFormat)
```
    The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
    
    Parameters:
    
    outputFormat - The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
  - getOutputFormat
```
public String getOutputFormat()
```
    The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
    
    Returns:
    
    The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
  - withOutputFormat
```
public StorageDescriptor withOutputFormat(String outputFormat)
```
    The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
    
    Parameters:
    
    outputFormat - The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompressed
```
public void setCompressed(Boolean compressed)
```
    True if the data in the table is compressed, or False if not.
    
    Parameters:
    
    compressed - True if the data in the table is compressed, or False if not.
  - getCompressed
```
public Boolean getCompressed()
```
    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.
  - withCompressed
```
public StorageDescriptor withCompressed(Boolean compressed)
```
    True if the data in the table is compressed, or False if not.
    
    Parameters:
    
    compressed - True if the data in the table is compressed, or False if not.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCompressed
```
public Boolean isCompressed()
```
    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.
  - setNumberOfBuckets
```
public void setNumberOfBuckets(Integer numberOfBuckets)
```
    Must be specified if the table contains any dimension columns.
    
    Parameters:
    
    numberOfBuckets - Must be specified if the table contains any dimension columns.
  - getNumberOfBuckets
```
public Integer getNumberOfBuckets()
```
    Must be specified if the table contains any dimension columns.
    
    Returns:
    
    Must be specified if the table contains any dimension columns.
  - withNumberOfBuckets
```
public StorageDescriptor withNumberOfBuckets(Integer numberOfBuckets)
```
    Must be specified if the table contains any dimension columns.
    
    Parameters:
    
    numberOfBuckets - Must be specified if the table contains any dimension columns.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSerdeInfo
```
public void setSerdeInfo(SerDeInfo serdeInfo)
```
    The serialization/deserialization (SerDe) information.
    
    Parameters:
    
    serdeInfo - The serialization/deserialization (SerDe) information.
  - getSerdeInfo
```
public SerDeInfo getSerdeInfo()
```
    The serialization/deserialization (SerDe) information.
    
    Returns:
    
    The serialization/deserialization (SerDe) information.
  - withSerdeInfo
```
public StorageDescriptor withSerdeInfo(SerDeInfo serdeInfo)
```
    The serialization/deserialization (SerDe) information.
    
    Parameters:
    
    serdeInfo - The serialization/deserialization (SerDe) information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBucketColumns
```
public List<String> getBucketColumns()
```
    A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
    
    Returns:
    
    A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
  - setBucketColumns
```
public void setBucketColumns(Collection<String> bucketColumns)
```
    A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
    
    Parameters:
    
    bucketColumns - A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
  - withBucketColumns
```
public StorageDescriptor withBucketColumns(String... bucketColumns)
```
    A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
    
    NOTE: This method appends the values to the existing list (if any). Use setBucketColumns(java.util.Collection) or withBucketColumns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    bucketColumns - A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBucketColumns
```
public StorageDescriptor withBucketColumns(Collection<String> bucketColumns)
```
    A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
    
    Parameters:
    
    bucketColumns - A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSortColumns
```
public List<Order> getSortColumns()
```
    A list specifying the sort order of each bucket in the table.
    
    Returns:
    
    A list specifying the sort order of each bucket in the table.
  - setSortColumns
```
public void setSortColumns(Collection<Order> sortColumns)
```
    A list specifying the sort order of each bucket in the table.
    
    Parameters:
    
    sortColumns - A list specifying the sort order of each bucket in the table.
  - withSortColumns
```
public StorageDescriptor withSortColumns(Order... sortColumns)
```
    A list specifying the sort order of each bucket in the table.
    
    NOTE: This method appends the values to the existing list (if any). Use setSortColumns(java.util.Collection) or withSortColumns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sortColumns - A list specifying the sort order of each bucket in the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSortColumns
```
public StorageDescriptor withSortColumns(Collection<Order> sortColumns)
```
    A list specifying the sort order of each bucket in the table.
    
    Parameters:
    
    sortColumns - A list specifying the sort order of each bucket in the table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,String> getParameters()
```
    The user-supplied properties in key-value form.
    
    Returns:
    
    The user-supplied properties in key-value form.
  - setParameters
```
public void setParameters(Map<String,String> parameters)
```
    The user-supplied properties in key-value form.
    
    Parameters:
    
    parameters - The user-supplied properties in key-value form.
  - withParameters
```
public StorageDescriptor withParameters(Map<String,String> parameters)
```
    The user-supplied properties in key-value form.
    
    Parameters:
    
    parameters - The user-supplied properties in key-value form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public StorageDescriptor addParametersEntry(String key,
                                            String value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearParametersEntries
```
public StorageDescriptor clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSkewedInfo
```
public void setSkewedInfo(SkewedInfo skewedInfo)
```
    The information about values that appear frequently in a column (skewed values).
    
    Parameters:
    
    skewedInfo - The information about values that appear frequently in a column (skewed values).
  - getSkewedInfo
```
public SkewedInfo getSkewedInfo()
```
    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).
  - withSkewedInfo
```
public StorageDescriptor withSkewedInfo(SkewedInfo skewedInfo)
```
    The information about values that appear frequently in a column (skewed values).
    
    Parameters:
    
    skewedInfo - The information about values that appear frequently in a column (skewed values).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoredAsSubDirectories
```
public void setStoredAsSubDirectories(Boolean storedAsSubDirectories)
```
    True if the table data is stored in subdirectories, or False if not.
    
    Parameters:
    
    storedAsSubDirectories - True if the table data is stored in subdirectories, or False if not.
  - getStoredAsSubDirectories
```
public Boolean getStoredAsSubDirectories()
```
    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.
  - withStoredAsSubDirectories
```
public StorageDescriptor withStoredAsSubDirectories(Boolean storedAsSubDirectories)
```
    True if the table data is stored in subdirectories, or False if not.
    
    Parameters:
    
    storedAsSubDirectories - True if the table data is stored in subdirectories, or False if not.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isStoredAsSubDirectories
```
public Boolean isStoredAsSubDirectories()
```
    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.
  - setSchemaReference
```
public void setSchemaReference(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.
    
    Parameters:
    
    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.
  - getSchemaReference
```
public SchemaReference getSchemaReference()
```
    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.
  - withSchemaReference
```
public StorageDescriptor withSchemaReference(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StorageDescriptor clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class StorageDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StorageDescriptor

Method Detail

getColumns

setColumns

withColumns

withColumns

setLocation

getLocation

withLocation

getAdditionalLocations

setAdditionalLocations

withAdditionalLocations

withAdditionalLocations

setInputFormat

getInputFormat

withInputFormat

setOutputFormat

getOutputFormat

withOutputFormat

setCompressed

getCompressed

withCompressed

isCompressed

setNumberOfBuckets

getNumberOfBuckets

withNumberOfBuckets

setSerdeInfo

getSerdeInfo

withSerdeInfo

getBucketColumns

setBucketColumns

withBucketColumns

withBucketColumns

getSortColumns

setSortColumns

withSortColumns

withSortColumns

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setSkewedInfo

getSkewedInfo

withSkewedInfo

setStoredAsSubDirectories

getStoredAsSubDirectories

withStoredAsSubDirectories

isStoredAsSubDirectories

setSchemaReference

getSchemaReference

withSchemaReference

toString

equals

hashCode

clone

marshall