Class SchemaConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SchemaConfiguration.Builder,
SchemaConfiguration>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SchemaConfiguration.Builder
builder()
final String
The ID of the Amazon Web Services Glue Data Catalog.final String
Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
region()
If you don't specify an Amazon Web Services Region, the default is the current Region.final String
roleARN()
The role that Firehose can use to access Amazon Web Services Glue.static Class
<? extends SchemaConfiguration.Builder> final String
Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
Specifies the table version for the output data schema.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theCreateDeliveryStream
API, then theRoleARN
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 theCreateDeliveryStream
API, then theRoleARN
property is required and its value must be specified.
-
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
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 theCreateDeliveryStream
API, then theDatabaseName
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 theCreateDeliveryStream
API, then theDatabaseName
property is required and its value must be specified.
-
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 theCreateDeliveryStream
API, then theTableName
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 theCreateDeliveryStream
API, then theTableName
property is required and its value must be specified.
-
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
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.
-
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 interfaceToCopyableBuilder<SchemaConfiguration.Builder,
SchemaConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-