ColumnMetadata (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rdsdata.model.ColumnMetadata

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Column Metadata

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ColumnMetadata()

Constructors
Constructor and Description
`ColumnMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ColumnMetadata`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getArrayBaseColumnType()` Homogenous array base SQL type from java.sql.Types.
`Boolean`	`getIsAutoIncrement()` Whether the designated column is automatically numbered
`Boolean`	`getIsCaseSensitive()` Whether values in the designated column's case matters
`Boolean`	`getIsCurrency()` Whether values in the designated column is a cash value
`Boolean`	`getIsSigned()` Whether values in the designated column are signed numbers
`String`	`getLabel()` Usually specified by the SQL AS.
`String`	`getName()` Name of the column.
`Integer`	`getNullable()` Indicates the nullability of values in the designated column.
`Integer`	`getPrecision()` Get the designated column's specified column size.For numeric data, this is the maximum precision.
`Integer`	`getScale()` Designated column's number of digits to right of the decimal point.
`String`	`getSchemaName()` Designated column's table's schema
`String`	`getTableName()` Designated column's table name
`Integer`	`getType()` SQL type from java.sql.Types.
`String`	`getTypeName()` Database-specific type name.
`int`	`hashCode()`
`Boolean`	`isAutoIncrement()` Whether the designated column is automatically numbered
`Boolean`	`isCaseSensitive()` Whether values in the designated column's case matters
`Boolean`	`isCurrency()` Whether values in the designated column is a cash value
`Boolean`	`isSigned()` Whether values in the designated column are signed numbers
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArrayBaseColumnType(Integer arrayBaseColumnType)` Homogenous array base SQL type from java.sql.Types.
`void`	`setIsAutoIncrement(Boolean isAutoIncrement)` Whether the designated column is automatically numbered
`void`	`setIsCaseSensitive(Boolean isCaseSensitive)` Whether values in the designated column's case matters
`void`	`setIsCurrency(Boolean isCurrency)` Whether values in the designated column is a cash value
`void`	`setIsSigned(Boolean isSigned)` Whether values in the designated column are signed numbers
`void`	`setLabel(String label)` Usually specified by the SQL AS.
`void`	`setName(String name)` Name of the column.
`void`	`setNullable(Integer nullable)` Indicates the nullability of values in the designated column.
`void`	`setPrecision(Integer precision)` Get the designated column's specified column size.For numeric data, this is the maximum precision.
`void`	`setScale(Integer scale)` Designated column's number of digits to right of the decimal point.
`void`	`setSchemaName(String schemaName)` Designated column's table's schema
`void`	`setTableName(String tableName)` Designated column's table name
`void`	`setType(Integer type)` SQL type from java.sql.Types.
`void`	`setTypeName(String typeName)` Database-specific type name.
`String`	`toString()` Returns a string representation of this object.
`ColumnMetadata`	`withArrayBaseColumnType(Integer arrayBaseColumnType)` Homogenous array base SQL type from java.sql.Types.
`ColumnMetadata`	`withIsAutoIncrement(Boolean isAutoIncrement)` Whether the designated column is automatically numbered
`ColumnMetadata`	`withIsCaseSensitive(Boolean isCaseSensitive)` Whether values in the designated column's case matters
`ColumnMetadata`	`withIsCurrency(Boolean isCurrency)` Whether values in the designated column is a cash value
`ColumnMetadata`	`withIsSigned(Boolean isSigned)` Whether values in the designated column are signed numbers
`ColumnMetadata`	`withLabel(String label)` Usually specified by the SQL AS.
`ColumnMetadata`	`withName(String name)` Name of the column.
`ColumnMetadata`	`withNullable(Integer nullable)` Indicates the nullability of values in the designated column.
`ColumnMetadata`	`withPrecision(Integer precision)` Get the designated column's specified column size.For numeric data, this is the maximum precision.
`ColumnMetadata`	`withScale(Integer scale)` Designated column's number of digits to right of the decimal point.
`ColumnMetadata`	`withSchemaName(String schemaName)` Designated column's table's schema
`ColumnMetadata`	`withTableName(String tableName)` Designated column's table name
`ColumnMetadata`	`withType(Integer type)` SQL type from java.sql.Types.
`ColumnMetadata`	`withTypeName(String typeName)` Database-specific type name.

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

- Constructor Detail
  - ColumnMetadata
```
public ColumnMetadata()
```
- Method Detail
  - setArrayBaseColumnType
```
public void setArrayBaseColumnType(Integer arrayBaseColumnType)
```
    Homogenous array base SQL type from java.sql.Types.
    
    Parameters:
    
    arrayBaseColumnType - Homogenous array base SQL type from java.sql.Types.
  - getArrayBaseColumnType
```
public Integer getArrayBaseColumnType()
```
    Homogenous array base SQL type from java.sql.Types.
    
    Returns:
    
    Homogenous array base SQL type from java.sql.Types.
  - withArrayBaseColumnType
```
public ColumnMetadata withArrayBaseColumnType(Integer arrayBaseColumnType)
```
    Homogenous array base SQL type from java.sql.Types.
    
    Parameters:
    
    arrayBaseColumnType - Homogenous array base SQL type from java.sql.Types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsAutoIncrement
```
public void setIsAutoIncrement(Boolean isAutoIncrement)
```
    Whether the designated column is automatically numbered
    
    Parameters:
    
    isAutoIncrement - Whether the designated column is automatically numbered
  - getIsAutoIncrement
```
public Boolean getIsAutoIncrement()
```
    Whether the designated column is automatically numbered
    
    Returns:
    
    Whether the designated column is automatically numbered
  - withIsAutoIncrement
```
public ColumnMetadata withIsAutoIncrement(Boolean isAutoIncrement)
```
    Whether the designated column is automatically numbered
    
    Parameters:
    
    isAutoIncrement - Whether the designated column is automatically numbered
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAutoIncrement
```
public Boolean isAutoIncrement()
```
    Whether the designated column is automatically numbered
    
    Returns:
    
    Whether the designated column is automatically numbered
  - setIsCaseSensitive
```
public void setIsCaseSensitive(Boolean isCaseSensitive)
```
    Whether values in the designated column's case matters
    
    Parameters:
    
    isCaseSensitive - Whether values in the designated column's case matters
  - getIsCaseSensitive
```
public Boolean getIsCaseSensitive()
```
    Whether values in the designated column's case matters
    
    Returns:
    
    Whether values in the designated column's case matters
  - withIsCaseSensitive
```
public ColumnMetadata withIsCaseSensitive(Boolean isCaseSensitive)
```
    Whether values in the designated column's case matters
    
    Parameters:
    
    isCaseSensitive - Whether values in the designated column's case matters
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCaseSensitive
```
public Boolean isCaseSensitive()
```
    Whether values in the designated column's case matters
    
    Returns:
    
    Whether values in the designated column's case matters
  - setIsCurrency
```
public void setIsCurrency(Boolean isCurrency)
```
    Whether values in the designated column is a cash value
    
    Parameters:
    
    isCurrency - Whether values in the designated column is a cash value
  - getIsCurrency
```
public Boolean getIsCurrency()
```
    Whether values in the designated column is a cash value
    
    Returns:
    
    Whether values in the designated column is a cash value
  - withIsCurrency
```
public ColumnMetadata withIsCurrency(Boolean isCurrency)
```
    Whether values in the designated column is a cash value
    
    Parameters:
    
    isCurrency - Whether values in the designated column is a cash value
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCurrency
```
public Boolean isCurrency()
```
    Whether values in the designated column is a cash value
    
    Returns:
    
    Whether values in the designated column is a cash value
  - setIsSigned
```
public void setIsSigned(Boolean isSigned)
```
    Whether values in the designated column are signed numbers
    
    Parameters:
    
    isSigned - Whether values in the designated column are signed numbers
  - getIsSigned
```
public Boolean getIsSigned()
```
    Whether values in the designated column are signed numbers
    
    Returns:
    
    Whether values in the designated column are signed numbers
  - withIsSigned
```
public ColumnMetadata withIsSigned(Boolean isSigned)
```
    Whether values in the designated column are signed numbers
    
    Parameters:
    
    isSigned - Whether values in the designated column are signed numbers
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSigned
```
public Boolean isSigned()
```
    Whether values in the designated column are signed numbers
    
    Returns:
    
    Whether values in the designated column are signed numbers
  - setLabel
```
public void setLabel(String label)
```
    Usually specified by the SQL AS. If not specified, return column name.
    
    Parameters:
    
    label - Usually specified by the SQL AS. If not specified, return column name.
  - getLabel
```
public String getLabel()
```
    Usually specified by the SQL AS. If not specified, return column name.
    
    Returns:
    
    Usually specified by the SQL AS. If not specified, return column name.
  - withLabel
```
public ColumnMetadata withLabel(String label)
```
    Usually specified by the SQL AS. If not specified, return column name.
    
    Parameters:
    
    label - Usually specified by the SQL AS. If not specified, return column name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    Name of the column.
    
    Parameters:
    
    name - Name of the column.
  - getName
```
public String getName()
```
    Name of the column.
    
    Returns:
    
    Name of the column.
  - withName
```
public ColumnMetadata withName(String name)
```
    Name of the column.
    
    Parameters:
    
    name - Name of the column.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNullable
```
public void setNullable(Integer nullable)
```
    Indicates the nullability of values in the designated column. One of columnNoNulls (0), columnNullable (1), columnNullableUnknown (2)
    
    Parameters:
    
    nullable - Indicates the nullability of values in the designated column. One of columnNoNulls (0), columnNullable (1), columnNullableUnknown (2)
  - getNullable
```
public Integer getNullable()
```
    Indicates the nullability of values in the designated column. One of columnNoNulls (0), columnNullable (1), columnNullableUnknown (2)
    
    Returns:
    
    Indicates the nullability of values in the designated column. One of columnNoNulls (0), columnNullable (1), columnNullableUnknown (2)
  - withNullable
```
public ColumnMetadata withNullable(Integer nullable)
```
    Indicates the nullability of values in the designated column. One of columnNoNulls (0), columnNullable (1), columnNullableUnknown (2)
    
    Parameters:
    
    nullable - Indicates the nullability of values in the designated column. One of columnNoNulls (0), columnNullable (1), columnNullableUnknown (2)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrecision
```
public void setPrecision(Integer precision)
```
    Get the designated column's specified column size.For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.
    
    Parameters:
    
    precision - Get the designated column's specified column size.For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.
  - getPrecision
```
public Integer getPrecision()
```
    Get the designated column's specified column size.For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.
    
    Returns:
    
    Get the designated column's specified column size.For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.
  - withPrecision
```
public ColumnMetadata withPrecision(Integer precision)
```
    Get the designated column's specified column size.For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.
    
    Parameters:
    
    precision - Get the designated column's specified column size.For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScale
```
public void setScale(Integer scale)
```
    Designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.
    
    Parameters:
    
    scale - Designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.
  - getScale
```
public Integer getScale()
```
    Designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.
    
    Returns:
    
    Designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.
  - withScale
```
public ColumnMetadata withScale(Integer scale)
```
    Designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.
    
    Parameters:
    
    scale - Designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchemaName
```
public void setSchemaName(String schemaName)
```
    Designated column's table's schema
    
    Parameters:
    
    schemaName - Designated column's table's schema
  - getSchemaName
```
public String getSchemaName()
```
    Designated column's table's schema
    
    Returns:
    
    Designated column's table's schema
  - withSchemaName
```
public ColumnMetadata withSchemaName(String schemaName)
```
    Designated column's table's schema
    
    Parameters:
    
    schemaName - Designated column's table's schema
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTableName
```
public void setTableName(String tableName)
```
    Designated column's table name
    
    Parameters:
    
    tableName - Designated column's table name
  - getTableName
```
public String getTableName()
```
    Designated column's table name
    
    Returns:
    
    Designated column's table name
  - withTableName
```
public ColumnMetadata withTableName(String tableName)
```
    Designated column's table name
    
    Parameters:
    
    tableName - Designated column's table name
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(Integer type)
```
    SQL type from java.sql.Types.
    
    Parameters:
    
    type - SQL type from java.sql.Types.
  - getType
```
public Integer getType()
```
    SQL type from java.sql.Types.
    
    Returns:
    
    SQL type from java.sql.Types.
  - withType
```
public ColumnMetadata withType(Integer type)
```
    SQL type from java.sql.Types.
    
    Parameters:
    
    type - SQL type from java.sql.Types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTypeName
```
public void setTypeName(String typeName)
```
    Database-specific type name.
    
    Parameters:
    
    typeName - Database-specific type name.
  - getTypeName
```
public String getTypeName()
```
    Database-specific type name.
    
    Returns:
    
    Database-specific type name.
  - withTypeName
```
public ColumnMetadata withTypeName(String typeName)
```
    Database-specific type name.
    
    Parameters:
    
    typeName - Database-specific type name.
    
    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 ColumnMetadata 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.

Did this page help you?

Class ColumnMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ColumnMetadata

Method Detail

setArrayBaseColumnType

getArrayBaseColumnType

withArrayBaseColumnType

setIsAutoIncrement

getIsAutoIncrement

withIsAutoIncrement

isAutoIncrement

setIsCaseSensitive

getIsCaseSensitive

withIsCaseSensitive

isCaseSensitive

setIsCurrency

getIsCurrency

withIsCurrency

isCurrency

setIsSigned

getIsSigned

withIsSigned

isSigned

setLabel

getLabel

withLabel

setName

getName

withName

setNullable

getNullable

withNullable

setPrecision

getPrecision

withPrecision

setScale

getScale

withScale

setSchemaName

getSchemaName

withSchemaName

setTableName

getTableName

withTableName

setType

getType

withType

setTypeName

getTypeName

withTypeName

toString

equals

hashCode

clone

marshall