Struct aws_sdk_finspace::operation::create_kx_changeset::builders::CreateKxChangesetFluentBuilder

pub struct CreateKxChangesetFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateKxChangeset.

Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.

Implementations

impl CreateKxChangesetFluentBuilder

pub fn as_input(&self) -> &CreateKxChangesetInputBuilder

Access the CreateKxChangeset as a reference.

pub async fn send( self ) -> Result<CreateKxChangesetOutput, SdkError<CreateKxChangesetError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateKxChangesetOutput, CreateKxChangesetError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn environment_id(self, input: impl Into<String>) -> Self

A unique identifier of the kdb environment.

pub fn set_environment_id(self, input: Option<String>) -> Self

A unique identifier of the kdb environment.

pub fn get_environment_id(&self) -> &Option<String>

A unique identifier of the kdb environment.

pub fn database_name(self, input: impl Into<String>) -> Self

The name of the kdb database.

pub fn set_database_name(self, input: Option<String>) -> Self

The name of the kdb database.

pub fn get_database_name(&self) -> &Option<String>

The name of the kdb database.

pub fn change_requests(self, input: ChangeRequest) -> Self

Appends an item to changeRequests.

To override the contents of this collection use set_change_requests.

A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

pub fn set_change_requests(self, input: Option<Vec<ChangeRequest>>) -> Self

A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

pub fn get_change_requests(&self) -> &Option<Vec<ChangeRequest>>

A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

• PUT – Adds or updates files in a database.

• DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

pub fn client_token(self, input: impl Into<String>) -> Self

A token that ensures idempotency. This token expires in 10 minutes.

pub fn set_client_token(self, input: Option<String>) -> Self

A token that ensures idempotency. This token expires in 10 minutes.

pub fn get_client_token(&self) -> &Option<String>

A token that ensures idempotency. This token expires in 10 minutes.

Trait Implementations

impl Clone for CreateKxChangesetFluentBuilder

fn clone(&self) -> CreateKxChangesetFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateKxChangesetFluentBuilder

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

Formats the value using the given formatter.