aws_sdk_finspace/client/get_kx_changeset.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetKxChangeset`](crate::operation::get_kx_changeset::builders::GetKxChangesetFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`environment_id(impl Into<String>)`](crate::operation::get_kx_changeset::builders::GetKxChangesetFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::get_kx_changeset::builders::GetKxChangesetFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique identifier for the kdb environment.</p><br>
7 /// - [`database_name(impl Into<String>)`](crate::operation::get_kx_changeset::builders::GetKxChangesetFluentBuilder::database_name) / [`set_database_name(Option<String>)`](crate::operation::get_kx_changeset::builders::GetKxChangesetFluentBuilder::set_database_name):<br>required: **true**<br><p>The name of the kdb database.</p><br>
8 /// - [`changeset_id(impl Into<String>)`](crate::operation::get_kx_changeset::builders::GetKxChangesetFluentBuilder::changeset_id) / [`set_changeset_id(Option<String>)`](crate::operation::get_kx_changeset::builders::GetKxChangesetFluentBuilder::set_changeset_id):<br>required: **true**<br><p>A unique identifier of the changeset for which you want to retrieve data.</p><br>
9 /// - On success, responds with [`GetKxChangesetOutput`](crate::operation::get_kx_changeset::GetKxChangesetOutput) with field(s):
10 /// - [`changeset_id(Option<String>)`](crate::operation::get_kx_changeset::GetKxChangesetOutput::changeset_id): <p>A unique identifier for the changeset.</p>
11 /// - [`database_name(Option<String>)`](crate::operation::get_kx_changeset::GetKxChangesetOutput::database_name): <p>The name of the kdb database.</p>
12 /// - [`environment_id(Option<String>)`](crate::operation::get_kx_changeset::GetKxChangesetOutput::environment_id): <p>A unique identifier for the kdb environment.</p>
13 /// - [`change_requests(Option<Vec::<ChangeRequest>>)`](crate::operation::get_kx_changeset::GetKxChangesetOutput::change_requests): <p>A list of change request objects that are run in order.</p>
14 /// - [`created_timestamp(Option<DateTime>)`](crate::operation::get_kx_changeset::GetKxChangesetOutput::created_timestamp): <p>The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
15 /// - [`active_from_timestamp(Option<DateTime>)`](crate::operation::get_kx_changeset::GetKxChangesetOutput::active_from_timestamp): <p>Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
16 /// - [`last_modified_timestamp(Option<DateTime>)`](crate::operation::get_kx_changeset::GetKxChangesetOutput::last_modified_timestamp): <p>The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
17 /// - [`status(Option<ChangesetStatus>)`](crate::operation::get_kx_changeset::GetKxChangesetOutput::status): <p>Status of the changeset creation process.</p> <ul> <li> <p>Pending – Changeset creation is pending.</p></li> <li> <p>Processing – Changeset creation is running.</p></li> <li> <p>Failed – Changeset creation has failed.</p></li> <li> <p>Complete – Changeset creation has succeeded.</p></li> </ul>
18 /// - [`error_info(Option<ErrorInfo>)`](crate::operation::get_kx_changeset::GetKxChangesetOutput::error_info): <p>Provides details in the event of a failed flow, including the error type and the related error message.</p>
19 /// - On failure, responds with [`SdkError<GetKxChangesetError>`](crate::operation::get_kx_changeset::GetKxChangesetError)
20 pub fn get_kx_changeset(&self) -> crate::operation::get_kx_changeset::builders::GetKxChangesetFluentBuilder {
21 crate::operation::get_kx_changeset::builders::GetKxChangesetFluentBuilder::new(self.handle.clone())
22 }
23}