Package 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("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. This parameter is required if Enabled is set to true.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SchemaConfiguration.Builder

Method Summary

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

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

roleARN

public final String roleARN()

The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data 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 Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data 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.

catalogId

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

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.

databaseName

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

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.

tableName

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

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.

region

public final String region()

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.

versionId

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<SchemaConfiguration.Builder,SchemaConfiguration>

builder

public static SchemaConfiguration.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo