Struct aws_sdk_glue::operation::create_schema::CreateSchemaInput

#[non_exhaustive]
pub struct CreateSchemaInput {
    pub registry_id: Option<RegistryId>,
    pub schema_name: Option<String>,
    pub data_format: Option<DataFormat>,
    pub compatibility: Option<Compatibility>,
    pub description: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub schema_definition: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

registry_id: Option<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: :registry/default-registry:random-5-letter-id .

schema_name: Option<String>

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.

data_format: Option<DataFormat>

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

compatibility: Option<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.

description: Option<String>

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

tags: Option<HashMap<String, String>>

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.

schema_definition: Option<String>

The schema definition using the DataFormat setting for SchemaName.

Implementations

impl CreateSchemaInput

pub fn registry_id(&self) -> Option<&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: :registry/default-registry:random-5-letter-id .

pub fn schema_name(&self) -> Option<&str>

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.

pub fn data_format(&self) -> Option<&DataFormat>

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

pub fn compatibility(&self) -> Option<&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.

pub fn description(&self) -> Option<&str>

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

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.

pub fn schema_definition(&self) -> Option<&str>

The schema definition using the DataFormat setting for SchemaName.

impl CreateSchemaInput

pub fn builder() -> CreateSchemaInputBuilder

Creates a new builder-style object to manufacture CreateSchemaInput.

Trait Implementations

impl Clone for CreateSchemaInput

fn clone(&self) -> CreateSchemaInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateSchemaInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateSchemaInput

fn eq(&self, other: &CreateSchemaInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateSchemaInput