Struct aws_sdk_finspace::operation::create_kx_changeset::CreateKxChangesetInput

#[non_exhaustive]
pub struct CreateKxChangesetInput {
    pub environment_id: Option<String>,
    pub database_name: Option<String>,
    pub change_requests: Option<Vec<ChangeRequest>>,
    pub client_token: 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.

environment_id: Option<String>

A unique identifier of the kdb environment.

database_name: Option<String>

The name of the kdb database.

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

client_token: Option<String>

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

Implementations

impl CreateKxChangesetInput

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

A unique identifier of the kdb environment.

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

The name of the kdb database.

pub fn change_requests(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .change_requests.is_none().

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

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

impl CreateKxChangesetInput

pub fn builder() -> CreateKxChangesetInputBuilder

Creates a new builder-style object to manufacture CreateKxChangesetInput.

Trait Implementations

impl Clone for CreateKxChangesetInput

fn clone(&self) -> CreateKxChangesetInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateKxChangesetInput

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

Formats the value using the given formatter.

impl PartialEq for CreateKxChangesetInput

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