aws_sdk_finspace/operation/create_kx_changeset/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_kx_changeset::_create_kx_changeset_output::CreateKxChangesetOutputBuilder;

pub use crate::operation::create_kx_changeset::_create_kx_changeset_input::CreateKxChangesetInputBuilder;

impl crate::operation::create_kx_changeset::builders::CreateKxChangesetInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::create_kx_changeset::CreateKxChangesetOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_kx_changeset::CreateKxChangesetError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.create_kx_changeset();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `CreateKxChangeset`.
///
/// <p>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.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateKxChangesetFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::create_kx_changeset::builders::CreateKxChangesetInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::create_kx_changeset::CreateKxChangesetOutput,
        crate::operation::create_kx_changeset::CreateKxChangesetError,
    > for CreateKxChangesetFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::create_kx_changeset::CreateKxChangesetOutput,
            crate::operation::create_kx_changeset::CreateKxChangesetError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl CreateKxChangesetFluentBuilder {
    /// Creates a new `CreateKxChangesetFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the CreateKxChangeset as a reference.
    pub fn as_input(&self) -> &crate::operation::create_kx_changeset::builders::CreateKxChangesetInputBuilder {
        &self.inner
    }
    /// 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](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::create_kx_changeset::CreateKxChangesetOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_kx_changeset::CreateKxChangesetError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::create_kx_changeset::CreateKxChangeset::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::create_kx_changeset::CreateKxChangeset::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::create_kx_changeset::CreateKxChangesetOutput,
        crate::operation::create_kx_changeset::CreateKxChangesetError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>A unique identifier of the kdb environment.</p>
    pub fn environment_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.environment_id(input.into());
        self
    }
    /// <p>A unique identifier of the kdb environment.</p>
    pub fn set_environment_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_environment_id(input);
        self
    }
    /// <p>A unique identifier of the kdb environment.</p>
    pub fn get_environment_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_environment_id()
    }
    /// <p>The name of the kdb database.</p>
    pub fn database_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.database_name(input.into());
        self
    }
    /// <p>The name of the kdb database.</p>
    pub fn set_database_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_database_name(input);
        self
    }
    /// <p>The name of the kdb database.</p>
    pub fn get_database_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_database_name()
    }
    ///
    /// Appends an item to `changeRequests`.
    ///
    /// To override the contents of this collection use [`set_change_requests`](Self::set_change_requests).
    ///
    /// <p>A list of change request objects that are run in order. A change request object consists of <code>changeType</code> , <code>s3Path</code>, and <code>dbPath</code>. A changeType can have the following values:</p>
    /// <ul>
    /// <li>
    /// <p>PUT – Adds or updates files in a database.</p></li>
    /// <li>
    /// <p>DELETE – Deletes files in a database.</p></li>
    /// </ul>
    /// <p>All the change requests require a mandatory <code>dbPath</code> attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The <code>s3Path</code> attribute defines the s3 source file path and is required for a PUT change type. The <code>s3path</code> must end with a trailing / if it is a directory and must end without a trailing / if it is a file.</p>
    /// <p>Here are few examples of how you can use the change request object:</p>
    /// <ol>
    /// <li>
    /// <p>This request adds a single sym file at database root location.</p>
    /// <p><code>{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}</code></p></li>
    /// <li>
    /// <p>This request adds files in the given <code>s3Path</code> under the 2020.01.02 partition of the database.</p>
    /// <p><code>{ "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}</code></p></li>
    /// <li>
    /// <p>This request adds files in the given <code>s3Path</code> under the <i>taq</i> table partition of the database.</p>
    /// <p><code>\[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}\]</code></p></li>
    /// <li>
    /// <p>This request deletes the 2020.01.02 partition of the database.</p>
    /// <p><code>\[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} \]</code></p></li>
    /// <li>
    /// <p>The <i>DELETE</i> request allows you to delete the existing files under the 2020.01.02 partition of the database, and the <i>PUT</i> request adds a new taq table under it.</p>
    /// <p><code>\[ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}\]</code></p></li>
    /// </ol>
    pub fn change_requests(mut self, input: crate::types::ChangeRequest) -> Self {
        self.inner = self.inner.change_requests(input);
        self
    }
    /// <p>A list of change request objects that are run in order. A change request object consists of <code>changeType</code> , <code>s3Path</code>, and <code>dbPath</code>. A changeType can have the following values:</p>
    /// <ul>
    /// <li>
    /// <p>PUT – Adds or updates files in a database.</p></li>
    /// <li>
    /// <p>DELETE – Deletes files in a database.</p></li>
    /// </ul>
    /// <p>All the change requests require a mandatory <code>dbPath</code> attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The <code>s3Path</code> attribute defines the s3 source file path and is required for a PUT change type. The <code>s3path</code> must end with a trailing / if it is a directory and must end without a trailing / if it is a file.</p>
    /// <p>Here are few examples of how you can use the change request object:</p>
    /// <ol>
    /// <li>
    /// <p>This request adds a single sym file at database root location.</p>
    /// <p><code>{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}</code></p></li>
    /// <li>
    /// <p>This request adds files in the given <code>s3Path</code> under the 2020.01.02 partition of the database.</p>
    /// <p><code>{ "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}</code></p></li>
    /// <li>
    /// <p>This request adds files in the given <code>s3Path</code> under the <i>taq</i> table partition of the database.</p>
    /// <p><code>\[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}\]</code></p></li>
    /// <li>
    /// <p>This request deletes the 2020.01.02 partition of the database.</p>
    /// <p><code>\[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} \]</code></p></li>
    /// <li>
    /// <p>The <i>DELETE</i> request allows you to delete the existing files under the 2020.01.02 partition of the database, and the <i>PUT</i> request adds a new taq table under it.</p>
    /// <p><code>\[ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}\]</code></p></li>
    /// </ol>
    pub fn set_change_requests(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ChangeRequest>>) -> Self {
        self.inner = self.inner.set_change_requests(input);
        self
    }
    /// <p>A list of change request objects that are run in order. A change request object consists of <code>changeType</code> , <code>s3Path</code>, and <code>dbPath</code>. A changeType can have the following values:</p>
    /// <ul>
    /// <li>
    /// <p>PUT – Adds or updates files in a database.</p></li>
    /// <li>
    /// <p>DELETE – Deletes files in a database.</p></li>
    /// </ul>
    /// <p>All the change requests require a mandatory <code>dbPath</code> attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The <code>s3Path</code> attribute defines the s3 source file path and is required for a PUT change type. The <code>s3path</code> must end with a trailing / if it is a directory and must end without a trailing / if it is a file.</p>
    /// <p>Here are few examples of how you can use the change request object:</p>
    /// <ol>
    /// <li>
    /// <p>This request adds a single sym file at database root location.</p>
    /// <p><code>{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}</code></p></li>
    /// <li>
    /// <p>This request adds files in the given <code>s3Path</code> under the 2020.01.02 partition of the database.</p>
    /// <p><code>{ "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}</code></p></li>
    /// <li>
    /// <p>This request adds files in the given <code>s3Path</code> under the <i>taq</i> table partition of the database.</p>
    /// <p><code>\[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}\]</code></p></li>
    /// <li>
    /// <p>This request deletes the 2020.01.02 partition of the database.</p>
    /// <p><code>\[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} \]</code></p></li>
    /// <li>
    /// <p>The <i>DELETE</i> request allows you to delete the existing files under the 2020.01.02 partition of the database, and the <i>PUT</i> request adds a new taq table under it.</p>
    /// <p><code>\[ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}\]</code></p></li>
    /// </ol>
    pub fn get_change_requests(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ChangeRequest>> {
        self.inner.get_change_requests()
    }
    /// <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.client_token(input.into());
        self
    }
    /// <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_client_token(input);
        self
    }
    /// <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_client_token()
    }
}