Struct aws_sdk_finspace::operation::create_kx_changeset::builders::CreateKxChangesetInputBuilder

#[non_exhaustive]
pub struct CreateKxChangesetInputBuilder { /* private fields */ }

A builder for CreateKxChangesetInput.

Implementations

impl CreateKxChangesetInputBuilder

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

A unique identifier of the kdb environment.

This field is required.

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.

This field is required.

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 change_requests.

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 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. All database paths must start with a leading / and end with a trailing /. The s3Path attribute defines the s3 source file path and is required for a PUT change type. The s3path must end with a trailing / if it is a directory and must end without a trailing / if it is a file.

Here are few examples of how you can use the change request object:

1. This request adds a single sym file at database root location.

   { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}

2. This request adds files in the given s3Path under the 2020.01.02 partition of the database.

   { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}

3. This request adds files in the given s3Path under the taq table partition of the database.

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

4. This request deletes the 2020.01.02 partition of the database.

   [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]

5. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it.

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

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 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. All database paths must start with a leading / and end with a trailing /. The s3Path attribute defines the s3 source file path and is required for a PUT change type. The s3path must end with a trailing / if it is a directory and must end without a trailing / if it is a file.

Here are few examples of how you can use the change request object:

1. This request adds a single sym file at database root location.

   { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}

2. This request adds files in the given s3Path under the 2020.01.02 partition of the database.

   { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}

3. This request adds files in the given s3Path under the taq table partition of the database.

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

4. This request deletes the 2020.01.02 partition of the database.

   [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]

5. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it.

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

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 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. All database paths must start with a leading / and end with a trailing /. The s3Path attribute defines the s3 source file path and is required for a PUT change type. The s3path must end with a trailing / if it is a directory and must end without a trailing / if it is a file.

Here are few examples of how you can use the change request object:

1. This request adds a single sym file at database root location.

   { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}

2. This request adds files in the given s3Path under the 2020.01.02 partition of the database.

   { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}

3. This request adds files in the given s3Path under the taq table partition of the database.

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

4. This request deletes the 2020.01.02 partition of the database.

   [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]

5. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it.

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

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

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

This field is required.

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.

pub fn build(self) -> Result<CreateKxChangesetInput, BuildError>

Consumes the builder and constructs a CreateKxChangesetInput.

impl CreateKxChangesetInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateKxChangesetOutput, SdkError<CreateKxChangesetError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateKxChangesetInputBuilder

fn clone(&self) -> CreateKxChangesetInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateKxChangesetInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateKxChangesetInputBuilder

fn default() -> CreateKxChangesetInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateKxChangesetInputBuilder

fn eq(&self, other: &CreateKxChangesetInputBuilder) -> 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 CreateKxChangesetInputBuilder