Package software.amazon.awssdk.services.glue.model

Interface CreateSchemaRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateSchemaRequest.Builder,CreateSchemaRequest>, GlueRequest.Builder, SdkBuilder<CreateSchemaRequest.Builder,CreateSchemaRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateSchemaRequest
public static interface CreateSchemaRequest.Builder extends GlueRequest.Builder, SdkPojo, CopyableBuilder<CreateSchemaRequest.Builder,CreateSchemaRequest>

  • Method Details

    • registryId

      CreateSchemaRequest.Builder registryId(RegistryId registryId)

      This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.

      Parameters:
      registryId - This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registryId

      default CreateSchemaRequest.Builder registryId(Consumer<RegistryId.Builder> registryId)

      This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.

      This is a convenience method that creates an instance of the RegistryId.Builder avoiding the need to create one manually via RegistryId.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to registryId(RegistryId).

      Parameters:
      registryId - a consumer that will call methods on RegistryId.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schemaName

      CreateSchemaRequest.Builder schemaName(String schemaName)

      Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.

      Parameters:
      schemaName - Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataFormat

      CreateSchemaRequest.Builder dataFormat(String dataFormat)

      The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

      Parameters:
      dataFormat - The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataFormat

      CreateSchemaRequest.Builder dataFormat(DataFormat dataFormat)

      The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

      Parameters:
      dataFormat - The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • compatibility

      CreateSchemaRequest.Builder compatibility(String compatibility)

      The compatibility mode of the schema. The possible values are:

      • NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.

      • DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.

      • BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.

      • BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.

      • FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.

      • FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.

      • FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.

      • FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.

      Parameters:
      compatibility - The compatibility mode of the schema. The possible values are:

      • NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.

      • DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.

      • BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.

      • BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.

      • FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.

      • FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.

      • FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.

      • FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.

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

    • compatibility

      CreateSchemaRequest.Builder compatibility(Compatibility compatibility)

      The compatibility mode of the schema. The possible values are:

      • NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.

      • DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.

      • BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.

      • BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.

      • FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.

      • FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.

      • FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.

      • FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.

      Parameters:
      compatibility - The compatibility mode of the schema. The possible values are:

      • NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.

      • DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.

      • BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.

      • BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.

      • FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.

      • FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.

      • FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.

      • FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.

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

    • description

      CreateSchemaRequest.Builder description(String description)

      An optional description of the schema. If description is not provided, there will not be any automatic default value for this.

      Parameters:
      description - An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateSchemaRequest.Builder tags(Map<String,String> tags)

      Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.

      Parameters:
      tags - Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schemaDefinition

      CreateSchemaRequest.Builder schemaDefinition(String schemaDefinition)

      The schema definition using the DataFormat setting for SchemaName.

      Parameters:
      schemaDefinition - The schema definition using the DataFormat setting for SchemaName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateSchemaRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateSchemaRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.