Struct 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 dbPath. A changeType can have 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/"}\]

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 dbPath. A changeType can have 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/"}\]

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 duplicate 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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateKxChangesetInput