public static interface CreateSchemaRequest.Builder extends GlueRequest.Builder, SdkPojo, CopyableBuilder<CreateSchemaRequest.Builder,CreateSchemaRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateSchemaRequest.Builder |
compatibility(Compatibility compatibility)
The compatibility mode of the schema.
|
CreateSchemaRequest.Builder |
compatibility(String compatibility)
The compatibility mode of the schema.
|
CreateSchemaRequest.Builder |
dataFormat(DataFormat dataFormat)
The data format of the schema definition.
|
CreateSchemaRequest.Builder |
dataFormat(String dataFormat)
The data format of the schema definition.
|
CreateSchemaRequest.Builder |
description(String description)
An optional description of the schema.
|
CreateSchemaRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateSchemaRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default CreateSchemaRequest.Builder |
registryId(Consumer<RegistryId.Builder> registryId)
This is a wrapper shape to contain the registry identity fields.
|
CreateSchemaRequest.Builder |
registryId(RegistryId registryId)
This is a wrapper shape to contain the registry identity fields.
|
CreateSchemaRequest.Builder |
schemaDefinition(String schemaDefinition)
The schema definition using the
DataFormat setting for 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.
|
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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateSchemaRequest.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.
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.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.
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).
registryId - a consumer that will call methods on RegistryId.BuilderregistryId(RegistryId)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.
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.CreateSchemaRequest.Builder dataFormat(String dataFormat)
The data format of the schema definition. Currently AVRO, JSON and
PROTOBUF are supported.
dataFormat - The data format of the schema definition. Currently AVRO, JSON and
PROTOBUF are supported.DataFormat,
DataFormatCreateSchemaRequest.Builder dataFormat(DataFormat dataFormat)
The data format of the schema definition. Currently AVRO, JSON and
PROTOBUF are supported.
dataFormat - The data format of the schema definition. Currently AVRO, JSON and
PROTOBUF are supported.DataFormat,
DataFormatCreateSchemaRequest.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.
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.
Compatibility,
CompatibilityCreateSchemaRequest.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.
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.
Compatibility,
CompatibilityCreateSchemaRequest.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.
description - An optional description of the schema. If description is not provided, there will not be any automatic
default value for this.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.
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.CreateSchemaRequest.Builder schemaDefinition(String schemaDefinition)
The schema definition using the DataFormat setting for SchemaName.
schemaDefinition - The schema definition using the DataFormat setting for SchemaName.CreateSchemaRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateSchemaRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.