commonMain.aws.sdk.kotlin.services.glue.model.CreateSchemaRequest.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of glue-jvm Show documentation
Show all versions of glue-jvm Show documentation
The AWS SDK for Kotlin client for Glue
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.glue.model
import aws.smithy.kotlin.runtime.SdkDsl
public class CreateSchemaRequest private constructor(builder: Builder) {
/**
* 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.
*/
public val compatibility: aws.sdk.kotlin.services.glue.model.Compatibility? = builder.compatibility
/**
* The data format of the schema definition. Currently `AVRO`, `JSON` and `PROTOBUF` are supported.
*/
public val dataFormat: aws.sdk.kotlin.services.glue.model.DataFormat? = builder.dataFormat
/**
* An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
*/
public val description: kotlin.String? = builder.description
/**
* 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`.
*/
public val registryId: aws.sdk.kotlin.services.glue.model.RegistryId? = builder.registryId
/**
* The schema definition using the `DataFormat` setting for `SchemaName`.
*/
public val schemaDefinition: kotlin.String? = builder.schemaDefinition
/**
* 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.
*/
public val schemaName: kotlin.String? = builder.schemaName
/**
* 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.
*/
public val tags: Map? = builder.tags
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.glue.model.CreateSchemaRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("CreateSchemaRequest(")
append("compatibility=$compatibility,")
append("dataFormat=$dataFormat,")
append("description=$description,")
append("registryId=$registryId,")
append("schemaDefinition=$schemaDefinition,")
append("schemaName=$schemaName,")
append("tags=$tags")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = compatibility?.hashCode() ?: 0
result = 31 * result + (dataFormat?.hashCode() ?: 0)
result = 31 * result + (description?.hashCode() ?: 0)
result = 31 * result + (registryId?.hashCode() ?: 0)
result = 31 * result + (schemaDefinition?.hashCode() ?: 0)
result = 31 * result + (schemaName?.hashCode() ?: 0)
result = 31 * result + (tags?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as CreateSchemaRequest
if (compatibility != other.compatibility) return false
if (dataFormat != other.dataFormat) return false
if (description != other.description) return false
if (registryId != other.registryId) return false
if (schemaDefinition != other.schemaDefinition) return false
if (schemaName != other.schemaName) return false
if (tags != other.tags) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.glue.model.CreateSchemaRequest = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* 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.
*/
public var compatibility: aws.sdk.kotlin.services.glue.model.Compatibility? = null
/**
* The data format of the schema definition. Currently `AVRO`, `JSON` and `PROTOBUF` are supported.
*/
public var dataFormat: aws.sdk.kotlin.services.glue.model.DataFormat? = null
/**
* An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
*/
public var description: kotlin.String? = null
/**
* 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`.
*/
public var registryId: aws.sdk.kotlin.services.glue.model.RegistryId? = null
/**
* The schema definition using the `DataFormat` setting for `SchemaName`.
*/
public var schemaDefinition: kotlin.String? = null
/**
* 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.
*/
public var schemaName: kotlin.String? = null
/**
* 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.
*/
public var tags: Map? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.glue.model.CreateSchemaRequest) : this() {
this.compatibility = x.compatibility
this.dataFormat = x.dataFormat
this.description = x.description
this.registryId = x.registryId
this.schemaDefinition = x.schemaDefinition
this.schemaName = x.schemaName
this.tags = x.tags
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.glue.model.CreateSchemaRequest = CreateSchemaRequest(this)
/**
* construct an [aws.sdk.kotlin.services.glue.model.RegistryId] inside the given [block]
*/
public fun registryId(block: aws.sdk.kotlin.services.glue.model.RegistryId.Builder.() -> kotlin.Unit) {
this.registryId = aws.sdk.kotlin.services.glue.model.RegistryId.invoke(block)
}
internal fun correctErrors(): Builder {
return this
}
}
}