software.amazon.awssdk.services.firehose.model

Class SchemaConfiguration

java.lang.Object

software.amazon.awssdk.services.firehose.model.SchemaConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SchemaConfiguration.Builder,SchemaConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class SchemaConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SchemaConfiguration.Builder,SchemaConfiguration>

Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SchemaConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static SchemaConfiguration.Builder	builder()
String	catalogId() The ID of the AWS Glue Data Catalog.
String	databaseName() Specifies the name of the AWS Glue database that contains the schema for the output data.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	region() If you don't specify an AWS Region, the default is the current Region.
String	roleARN() The role that Kinesis Data Firehose can use to access AWS Glue.
List<SdkField<?>>	sdkFields()
static Class<? extends SchemaConfiguration.Builder>	serializableBuilderClass()
String	tableName() Specifies the AWS Glue table that contains the column information that constitutes your data schema.
SchemaConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	versionId() Specifies the table version for the output data schema.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

roleARN

public String roleARN()

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

Returns:

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

catalogId

public String catalogId()

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

Returns:

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

databaseName

public String databaseName()

Specifies the name of the AWS Glue database that contains the schema for the output data.

Returns:

Specifies the name of the AWS Glue database that contains the schema for the output data.

tableName

public String tableName()

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

Returns:

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

region

public String region()

If you don't specify an AWS Region, the default is the current Region.

Returns:

If you don't specify an AWS Region, the default is the current Region.

versionId

public 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, Kinesis Data 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, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

toBuilder

public SchemaConfiguration.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<SchemaConfiguration.Builder,SchemaConfiguration>

Returns:

a builder for type T

builder

public static SchemaConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends SchemaConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.