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 Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

See Also:

  • Method Details

    • roleARN

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

      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.

    • 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, 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

      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 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.