AWS SDK for C++  1.8.126
AWS SDK for C++
Public Member Functions | List of all members
Aws::Glue::Model::CreateSchemaRequest Class Reference

#include <CreateSchemaRequest.h>

+ Inheritance diagram for Aws::Glue::Model::CreateSchemaRequest:

Public Member Functions

 CreateSchemaRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const RegistryIdGetRegistryId () const
 
bool RegistryIdHasBeenSet () const
 
void SetRegistryId (const RegistryId &value)
 
void SetRegistryId (RegistryId &&value)
 
CreateSchemaRequestWithRegistryId (const RegistryId &value)
 
CreateSchemaRequestWithRegistryId (RegistryId &&value)
 
const Aws::StringGetSchemaName () const
 
bool SchemaNameHasBeenSet () const
 
void SetSchemaName (const Aws::String &value)
 
void SetSchemaName (Aws::String &&value)
 
void SetSchemaName (const char *value)
 
CreateSchemaRequestWithSchemaName (const Aws::String &value)
 
CreateSchemaRequestWithSchemaName (Aws::String &&value)
 
CreateSchemaRequestWithSchemaName (const char *value)
 
const DataFormatGetDataFormat () const
 
bool DataFormatHasBeenSet () const
 
void SetDataFormat (const DataFormat &value)
 
void SetDataFormat (DataFormat &&value)
 
CreateSchemaRequestWithDataFormat (const DataFormat &value)
 
CreateSchemaRequestWithDataFormat (DataFormat &&value)
 
const CompatibilityGetCompatibility () const
 
bool CompatibilityHasBeenSet () const
 
void SetCompatibility (const Compatibility &value)
 
void SetCompatibility (Compatibility &&value)
 
CreateSchemaRequestWithCompatibility (const Compatibility &value)
 
CreateSchemaRequestWithCompatibility (Compatibility &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateSchemaRequestWithDescription (const Aws::String &value)
 
CreateSchemaRequestWithDescription (Aws::String &&value)
 
CreateSchemaRequestWithDescription (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateSchemaRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateSchemaRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateSchemaRequestAddTags (const Aws::String &key, const Aws::String &value)
 
CreateSchemaRequestAddTags (Aws::String &&key, const Aws::String &value)
 
CreateSchemaRequestAddTags (const Aws::String &key, Aws::String &&value)
 
CreateSchemaRequestAddTags (Aws::String &&key, Aws::String &&value)
 
CreateSchemaRequestAddTags (const char *key, Aws::String &&value)
 
CreateSchemaRequestAddTags (Aws::String &&key, const char *value)
 
CreateSchemaRequestAddTags (const char *key, const char *value)
 
const Aws::StringGetSchemaDefinition () const
 
bool SchemaDefinitionHasBeenSet () const
 
void SetSchemaDefinition (const Aws::String &value)
 
void SetSchemaDefinition (Aws::String &&value)
 
void SetSchemaDefinition (const char *value)
 
CreateSchemaRequestWithSchemaDefinition (const Aws::String &value)
 
CreateSchemaRequestWithSchemaDefinition (Aws::String &&value)
 
CreateSchemaRequestWithSchemaDefinition (const char *value)
 
- Public Member Functions inherited from Aws::Glue::GlueRequest
virtual ~GlueRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file CreateSchemaRequest.h.

Constructor & Destructor Documentation

◆ CreateSchemaRequest()

Aws::Glue::Model::CreateSchemaRequest::CreateSchemaRequest ( )

Member Function Documentation

◆ AddTags() [1/7]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 502 of file CreateSchemaRequest.h.

◆ AddTags() [2/7]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

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

Definition at line 490 of file CreateSchemaRequest.h.

◆ AddTags() [3/7]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

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

Definition at line 514 of file CreateSchemaRequest.h.

◆ AddTags() [4/7]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

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

Definition at line 496 of file CreateSchemaRequest.h.

◆ AddTags() [5/7]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

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

Definition at line 484 of file CreateSchemaRequest.h.

◆ AddTags() [6/7]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

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

Definition at line 508 of file CreateSchemaRequest.h.

◆ AddTags() [7/7]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::AddTags ( const char *  key,
const char *  value 
)
inline

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

Definition at line 520 of file CreateSchemaRequest.h.

◆ CompatibilityHasBeenSet()

bool Aws::Glue::Model::CreateSchemaRequest::CompatibilityHasBeenSet ( ) const
inline

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.

Definition at line 252 of file CreateSchemaRequest.h.

◆ DataFormatHasBeenSet()

bool Aws::Glue::Model::CreateSchemaRequest::DataFormatHasBeenSet ( ) const
inline

The data format of the schema definition. Currently only AVRO is supported.

Definition at line 157 of file CreateSchemaRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::Glue::Model::CreateSchemaRequest::DescriptionHasBeenSet ( ) const
inline

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

Definition at line 405 of file CreateSchemaRequest.h.

◆ GetCompatibility()

const Compatibility& Aws::Glue::Model::CreateSchemaRequest::GetCompatibility ( ) const
inline

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.

Definition at line 217 of file CreateSchemaRequest.h.

◆ GetDataFormat()

const DataFormat& Aws::Glue::Model::CreateSchemaRequest::GetDataFormat ( ) const
inline

The data format of the schema definition. Currently only AVRO is supported.

Definition at line 151 of file CreateSchemaRequest.h.

◆ GetDescription()

const Aws::String& Aws::Glue::Model::CreateSchemaRequest::GetDescription ( ) const
inline

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

Definition at line 399 of file CreateSchemaRequest.h.

◆ GetRegistryId()

const RegistryId& Aws::Glue::Model::CreateSchemaRequest::GetRegistryId ( ) const
inline

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.

Definition at line 47 of file CreateSchemaRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Glue::Model::CreateSchemaRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Glue::GlueRequest.

◆ GetSchemaDefinition()

const Aws::String& Aws::Glue::Model::CreateSchemaRequest::GetSchemaDefinition ( ) const
inline

The schema definition using the DataFormat setting for SchemaName.

Definition at line 527 of file CreateSchemaRequest.h.

◆ GetSchemaName()

const Aws::String& Aws::Glue::Model::CreateSchemaRequest::GetSchemaName ( ) const
inline

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.

Definition at line 95 of file CreateSchemaRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Glue::Model::CreateSchemaRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateSchemaRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::Glue::Model::CreateSchemaRequest::GetTags ( ) const
inline

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

Definition at line 448 of file CreateSchemaRequest.h.

◆ RegistryIdHasBeenSet()

bool Aws::Glue::Model::CreateSchemaRequest::RegistryIdHasBeenSet ( ) const
inline

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.

Definition at line 55 of file CreateSchemaRequest.h.

◆ SchemaDefinitionHasBeenSet()

bool Aws::Glue::Model::CreateSchemaRequest::SchemaDefinitionHasBeenSet ( ) const
inline

The schema definition using the DataFormat setting for SchemaName.

Definition at line 533 of file CreateSchemaRequest.h.

◆ SchemaNameHasBeenSet()

bool Aws::Glue::Model::CreateSchemaRequest::SchemaNameHasBeenSet ( ) const
inline

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.

Definition at line 102 of file CreateSchemaRequest.h.

◆ SerializePayload()

Aws::String Aws::Glue::Model::CreateSchemaRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCompatibility() [1/2]

void Aws::Glue::Model::CreateSchemaRequest::SetCompatibility ( Compatibility &&  value)
inline

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.

Definition at line 322 of file CreateSchemaRequest.h.

◆ SetCompatibility() [2/2]

void Aws::Glue::Model::CreateSchemaRequest::SetCompatibility ( const Compatibility value)
inline

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.

Definition at line 287 of file CreateSchemaRequest.h.

◆ SetDataFormat() [1/2]

void Aws::Glue::Model::CreateSchemaRequest::SetDataFormat ( const DataFormat value)
inline

The data format of the schema definition. Currently only AVRO is supported.

Definition at line 163 of file CreateSchemaRequest.h.

◆ SetDataFormat() [2/2]

void Aws::Glue::Model::CreateSchemaRequest::SetDataFormat ( DataFormat &&  value)
inline

The data format of the schema definition. Currently only AVRO is supported.

Definition at line 169 of file CreateSchemaRequest.h.

◆ SetDescription() [1/3]

void Aws::Glue::Model::CreateSchemaRequest::SetDescription ( Aws::String &&  value)
inline

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

Definition at line 417 of file CreateSchemaRequest.h.

◆ SetDescription() [2/3]

void Aws::Glue::Model::CreateSchemaRequest::SetDescription ( const Aws::String value)
inline

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

Definition at line 411 of file CreateSchemaRequest.h.

◆ SetDescription() [3/3]

void Aws::Glue::Model::CreateSchemaRequest::SetDescription ( const char *  value)
inline

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

Definition at line 423 of file CreateSchemaRequest.h.

◆ SetRegistryId() [1/2]

void Aws::Glue::Model::CreateSchemaRequest::SetRegistryId ( const RegistryId value)
inline

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.

Definition at line 63 of file CreateSchemaRequest.h.

◆ SetRegistryId() [2/2]

void Aws::Glue::Model::CreateSchemaRequest::SetRegistryId ( RegistryId &&  value)
inline

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.

Definition at line 71 of file CreateSchemaRequest.h.

◆ SetSchemaDefinition() [1/3]

void Aws::Glue::Model::CreateSchemaRequest::SetSchemaDefinition ( Aws::String &&  value)
inline

The schema definition using the DataFormat setting for SchemaName.

Definition at line 545 of file CreateSchemaRequest.h.

◆ SetSchemaDefinition() [2/3]

void Aws::Glue::Model::CreateSchemaRequest::SetSchemaDefinition ( const Aws::String value)
inline

The schema definition using the DataFormat setting for SchemaName.

Definition at line 539 of file CreateSchemaRequest.h.

◆ SetSchemaDefinition() [3/3]

void Aws::Glue::Model::CreateSchemaRequest::SetSchemaDefinition ( const char *  value)
inline

The schema definition using the DataFormat setting for SchemaName.

Definition at line 551 of file CreateSchemaRequest.h.

◆ SetSchemaName() [1/3]

void Aws::Glue::Model::CreateSchemaRequest::SetSchemaName ( Aws::String &&  value)
inline

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.

Definition at line 116 of file CreateSchemaRequest.h.

◆ SetSchemaName() [2/3]

void Aws::Glue::Model::CreateSchemaRequest::SetSchemaName ( const Aws::String value)
inline

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.

Definition at line 109 of file CreateSchemaRequest.h.

◆ SetSchemaName() [3/3]

void Aws::Glue::Model::CreateSchemaRequest::SetSchemaName ( const char *  value)
inline

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.

Definition at line 123 of file CreateSchemaRequest.h.

◆ SetTags() [1/2]

void Aws::Glue::Model::CreateSchemaRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 466 of file CreateSchemaRequest.h.

◆ SetTags() [2/2]

void Aws::Glue::Model::CreateSchemaRequest::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 460 of file CreateSchemaRequest.h.

◆ TagsHasBeenSet()

bool Aws::Glue::Model::CreateSchemaRequest::TagsHasBeenSet ( ) const
inline

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

Definition at line 454 of file CreateSchemaRequest.h.

◆ WithCompatibility() [1/2]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithCompatibility ( Compatibility &&  value)
inline

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.

Definition at line 392 of file CreateSchemaRequest.h.

◆ WithCompatibility() [2/2]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithCompatibility ( const Compatibility value)
inline

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.

Definition at line 357 of file CreateSchemaRequest.h.

◆ WithDataFormat() [1/2]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithDataFormat ( const DataFormat value)
inline

The data format of the schema definition. Currently only AVRO is supported.

Definition at line 175 of file CreateSchemaRequest.h.

◆ WithDataFormat() [2/2]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithDataFormat ( DataFormat &&  value)
inline

The data format of the schema definition. Currently only AVRO is supported.

Definition at line 181 of file CreateSchemaRequest.h.

◆ WithDescription() [1/3]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithDescription ( Aws::String &&  value)
inline

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

Definition at line 435 of file CreateSchemaRequest.h.

◆ WithDescription() [2/3]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithDescription ( const Aws::String value)
inline

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

Definition at line 429 of file CreateSchemaRequest.h.

◆ WithDescription() [3/3]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithDescription ( const char *  value)
inline

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

Definition at line 441 of file CreateSchemaRequest.h.

◆ WithRegistryId() [1/2]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithRegistryId ( const RegistryId value)
inline

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.

Definition at line 79 of file CreateSchemaRequest.h.

◆ WithRegistryId() [2/2]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithRegistryId ( RegistryId &&  value)
inline

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.

Definition at line 87 of file CreateSchemaRequest.h.

◆ WithSchemaDefinition() [1/3]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithSchemaDefinition ( Aws::String &&  value)
inline

The schema definition using the DataFormat setting for SchemaName.

Definition at line 563 of file CreateSchemaRequest.h.

◆ WithSchemaDefinition() [2/3]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithSchemaDefinition ( const Aws::String value)
inline

The schema definition using the DataFormat setting for SchemaName.

Definition at line 557 of file CreateSchemaRequest.h.

◆ WithSchemaDefinition() [3/3]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithSchemaDefinition ( const char *  value)
inline

The schema definition using the DataFormat setting for SchemaName.

Definition at line 569 of file CreateSchemaRequest.h.

◆ WithSchemaName() [1/3]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithSchemaName ( Aws::String &&  value)
inline

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.

Definition at line 137 of file CreateSchemaRequest.h.

◆ WithSchemaName() [2/3]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithSchemaName ( const Aws::String value)
inline

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.

Definition at line 130 of file CreateSchemaRequest.h.

◆ WithSchemaName() [3/3]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithSchemaName ( const char *  value)
inline

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.

Definition at line 144 of file CreateSchemaRequest.h.

◆ WithTags() [1/2]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 478 of file CreateSchemaRequest.h.

◆ WithTags() [2/2]

CreateSchemaRequest& Aws::Glue::Model::CreateSchemaRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 472 of file CreateSchemaRequest.h.


The documentation for this class was generated from the following file: