pub struct CreateKxChangesetFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateKxChangeset
.
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.
Implementations§
Source§impl CreateKxChangesetFluentBuilder
impl CreateKxChangesetFluentBuilder
Sourcepub fn as_input(&self) -> &CreateKxChangesetInputBuilder
pub fn as_input(&self) -> &CreateKxChangesetInputBuilder
Access the CreateKxChangeset as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateKxChangesetOutput, SdkError<CreateKxChangesetError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateKxChangesetOutput, SdkError<CreateKxChangesetError, HttpResponse>>
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, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateKxChangesetOutput, CreateKxChangesetError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateKxChangesetOutput, CreateKxChangesetError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn environment_id(self, input: impl Into<String>) -> Self
pub fn environment_id(self, input: impl Into<String>) -> Self
A unique identifier of the kdb environment.
Sourcepub fn set_environment_id(self, input: Option<String>) -> Self
pub fn set_environment_id(self, input: Option<String>) -> Self
A unique identifier of the kdb environment.
Sourcepub fn get_environment_id(&self) -> &Option<String>
pub fn get_environment_id(&self) -> &Option<String>
A unique identifier of the kdb environment.
Sourcepub fn database_name(self, input: impl Into<String>) -> Self
pub fn database_name(self, input: impl Into<String>) -> Self
The name of the kdb database.
Sourcepub fn set_database_name(self, input: Option<String>) -> Self
pub fn set_database_name(self, input: Option<String>) -> Self
The name of the kdb database.
Sourcepub fn get_database_name(&self) -> &Option<String>
pub fn get_database_name(&self) -> &Option<String>
The name of the kdb database.
Sourcepub fn change_requests(self, input: ChangeRequest) -> Self
pub fn change_requests(self, input: ChangeRequest) -> Self
Appends an item to changeRequests
.
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 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:
-
This request adds a single sym file at database root location.
{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}
-
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/"}
-
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/"}\]
-
This request deletes the 2020.01.02 partition of the database.
\[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} \]
-
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/"}\]
Sourcepub fn set_change_requests(self, input: Option<Vec<ChangeRequest>>) -> Self
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 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:
-
This request adds a single sym file at database root location.
{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}
-
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/"}
-
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/"}\]
-
This request deletes the 2020.01.02 partition of the database.
\[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} \]
-
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/"}\]
Sourcepub fn get_change_requests(&self) -> &Option<Vec<ChangeRequest>>
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 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:
-
This request adds a single sym file at database root location.
{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}
-
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/"}
-
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/"}\]
-
This request deletes the 2020.01.02 partition of the database.
\[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} \]
-
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/"}\]
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A token that ensures idempotency. This token expires in 10 minutes.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A token that ensures idempotency. This token expires in 10 minutes.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A token that ensures idempotency. This token expires in 10 minutes.
Trait Implementations§
Source§impl Clone for CreateKxChangesetFluentBuilder
impl Clone for CreateKxChangesetFluentBuilder
Source§fn clone(&self) -> CreateKxChangesetFluentBuilder
fn clone(&self) -> CreateKxChangesetFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateKxChangesetFluentBuilder
impl !RefUnwindSafe for CreateKxChangesetFluentBuilder
impl Send for CreateKxChangesetFluentBuilder
impl Sync for CreateKxChangesetFluentBuilder
impl Unpin for CreateKxChangesetFluentBuilder
impl !UnwindSafe for CreateKxChangesetFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);