com.amazonaws.services.kinesisfirehose.model

Class SchemaConfiguration

java.lang.Object

com.amazonaws.services.kinesisfirehose.model.SchemaConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SchemaConfiguration()

Method Summary

Modifier and Type	Method and Description
SchemaConfiguration	clone()
boolean	equals(Object obj)
String	getCatalogId() The ID of the Amazon Web Services Glue Data Catalog.
String	getDatabaseName() Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.
String	getRegion() If you don't specify an Amazon Web Services Region, the default is the current Region.
String	getRoleARN() The role that Firehose can use to access Amazon Web Services Glue.
String	getTableName() Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.
String	getVersionId() Specifies the table version for the output data schema.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCatalogId(String catalogId) The ID of the Amazon Web Services Glue Data Catalog.
void	setDatabaseName(String databaseName) Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.
void	setRegion(String region) If you don't specify an Amazon Web Services Region, the default is the current Region.
void	setRoleARN(String roleARN) The role that Firehose can use to access Amazon Web Services Glue.
void	setTableName(String tableName) Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.
void	setVersionId(String versionId) Specifies the table version for the output data schema.
String	toString() Returns a string representation of this object.
SchemaConfiguration	withCatalogId(String catalogId) The ID of the Amazon Web Services Glue Data Catalog.
SchemaConfiguration	withDatabaseName(String databaseName) Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.
SchemaConfiguration	withRegion(String region) If you don't specify an Amazon Web Services Region, the default is the current Region.
SchemaConfiguration	withRoleARN(String roleARN) The role that Firehose can use to access Amazon Web Services Glue.
SchemaConfiguration	withTableName(String tableName) Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.
SchemaConfiguration	withVersionId(String versionId) Specifies the table version for the output data schema.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SchemaConfiguration

public SchemaConfiguration()

Method Detail

setRoleARN

public void setRoleARN(String roleARN)

The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Parameters:

roleARN - The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

getRoleARN

public String getRoleARN()

The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Returns:

The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

withRoleARN

public SchemaConfiguration withRoleARN(String roleARN)

The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Parameters:

roleARN - The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCatalogId

public void setCatalogId(String catalogId)

The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.

Parameters:

catalogId - The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.

getCatalogId

public String getCatalogId()

The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.

Returns:

The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.

withCatalogId

public SchemaConfiguration withCatalogId(String catalogId)

The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.

Parameters:

catalogId - The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDatabaseName

public void setDatabaseName(String databaseName)

Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Parameters:

databaseName - Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

getDatabaseName

public String getDatabaseName()

Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Returns:

Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

withDatabaseName

public SchemaConfiguration withDatabaseName(String databaseName)

Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Parameters:

databaseName - Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTableName

public void setTableName(String tableName)

Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Parameters:

tableName - Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

getTableName

public String getTableName()

Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Returns:

Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

withTableName

public SchemaConfiguration withTableName(String tableName)

Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Parameters:

tableName - Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRegion

public void setRegion(String region)

If you don't specify an Amazon Web Services Region, the default is the current Region.

Parameters:

region - If you don't specify an Amazon Web Services Region, the default is the current Region.

getRegion

public String getRegion()

If you don't specify an Amazon Web Services Region, the default is the current Region.

Returns:

If you don't specify an Amazon Web Services Region, the default is the current Region.

withRegion

public SchemaConfiguration withRegion(String region)

If you don't specify an Amazon Web Services Region, the default is the current Region.

Parameters:

region - If you don't specify an Amazon Web Services Region, the default is the current Region.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVersionId

public void setVersionId(String versionId)

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Parameters:

versionId - Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

getVersionId

public String getVersionId()

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Returns:

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

withVersionId

public SchemaConfiguration withVersionId(String versionId)

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Parameters:

versionId - Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

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 SchemaConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo