pub struct CreateChangesetFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateChangeset
.
Creates a new Changeset in a FinSpace Dataset.
Implementations§
Source§impl CreateChangesetFluentBuilder
impl CreateChangesetFluentBuilder
Sourcepub fn as_input(&self) -> &CreateChangesetInputBuilder
pub fn as_input(&self) -> &CreateChangesetInputBuilder
Access the CreateChangeset as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateChangesetOutput, SdkError<CreateChangesetError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateChangesetOutput, SdkError<CreateChangesetError, 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<CreateChangesetOutput, CreateChangesetError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateChangesetOutput, CreateChangesetError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
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.
Sourcepub fn dataset_id(self, input: impl Into<String>) -> Self
pub fn dataset_id(self, input: impl Into<String>) -> Self
The unique identifier for the FinSpace Dataset where the Changeset will be created.
Sourcepub fn set_dataset_id(self, input: Option<String>) -> Self
pub fn set_dataset_id(self, input: Option<String>) -> Self
The unique identifier for the FinSpace Dataset where the Changeset will be created.
Sourcepub fn get_dataset_id(&self) -> &Option<String>
pub fn get_dataset_id(&self) -> &Option<String>
The unique identifier for the FinSpace Dataset where the Changeset will be created.
Sourcepub fn change_type(self, input: ChangeType) -> Self
pub fn change_type(self, input: ChangeType) -> Self
The option to indicate how a Changeset will be applied to a Dataset.
-
REPLACE
– Changeset will be considered as a replacement to all prior loaded Changesets. -
APPEND
– Changeset will be considered as an addition to the end of all prior loaded Changesets. -
MODIFY
– Changeset is considered as a replacement to a specific prior ingested Changeset.
Sourcepub fn set_change_type(self, input: Option<ChangeType>) -> Self
pub fn set_change_type(self, input: Option<ChangeType>) -> Self
The option to indicate how a Changeset will be applied to a Dataset.
-
REPLACE
– Changeset will be considered as a replacement to all prior loaded Changesets. -
APPEND
– Changeset will be considered as an addition to the end of all prior loaded Changesets. -
MODIFY
– Changeset is considered as a replacement to a specific prior ingested Changeset.
Sourcepub fn get_change_type(&self) -> &Option<ChangeType>
pub fn get_change_type(&self) -> &Option<ChangeType>
The option to indicate how a Changeset will be applied to a Dataset.
-
REPLACE
– Changeset will be considered as a replacement to all prior loaded Changesets. -
APPEND
– Changeset will be considered as an addition to the end of all prior loaded Changesets. -
MODIFY
– Changeset is considered as a replacement to a specific prior ingested Changeset.
Sourcepub fn source_params(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn source_params(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to sourceParams
.
To override the contents of this collection use set_source_params
.
Options that define the location of the data being ingested (s3SourcePath
) and the source of the changeset (sourceType
).
Both s3SourcePath
and sourceType
are required attributes.
Here is an example of how you could specify the sourceParams
:
"sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }
The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.
Sourcepub fn set_source_params(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_source_params(self, input: Option<HashMap<String, String>>) -> Self
Options that define the location of the data being ingested (s3SourcePath
) and the source of the changeset (sourceType
).
Both s3SourcePath
and sourceType
are required attributes.
Here is an example of how you could specify the sourceParams
:
"sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }
The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.
Sourcepub fn get_source_params(&self) -> &Option<HashMap<String, String>>
pub fn get_source_params(&self) -> &Option<HashMap<String, String>>
Options that define the location of the data being ingested (s3SourcePath
) and the source of the changeset (sourceType
).
Both s3SourcePath
and sourceType
are required attributes.
Here is an example of how you could specify the sourceParams
:
"sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }
The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.
Sourcepub fn format_params(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn format_params(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to formatParams
.
To override the contents of this collection use set_format_params
.
Options that define the structure of the source file(s) including the format type (formatType
), header row (withHeader
), data separation character (separator
) and the type of compression (compression
).
formatType
is a required attribute and can have the following values:
-
PARQUET
– Parquet source file format. -
CSV
– CSV source file format. -
JSON
– JSON source file format. -
XML
– XML source file format.
Here is an example of how you could specify the formatParams
:
"formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }
Note that if you only provide formatType
as CSV
, the rest of the attributes will automatically default to CSV values as following:
{ "withHeader": "true", "separator": "," }
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
Sourcepub fn set_format_params(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_format_params(self, input: Option<HashMap<String, String>>) -> Self
Options that define the structure of the source file(s) including the format type (formatType
), header row (withHeader
), data separation character (separator
) and the type of compression (compression
).
formatType
is a required attribute and can have the following values:
-
PARQUET
– Parquet source file format. -
CSV
– CSV source file format. -
JSON
– JSON source file format. -
XML
– XML source file format.
Here is an example of how you could specify the formatParams
:
"formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }
Note that if you only provide formatType
as CSV
, the rest of the attributes will automatically default to CSV values as following:
{ "withHeader": "true", "separator": "," }
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
Sourcepub fn get_format_params(&self) -> &Option<HashMap<String, String>>
pub fn get_format_params(&self) -> &Option<HashMap<String, String>>
Options that define the structure of the source file(s) including the format type (formatType
), header row (withHeader
), data separation character (separator
) and the type of compression (compression
).
formatType
is a required attribute and can have the following values:
-
PARQUET
– Parquet source file format. -
CSV
– CSV source file format. -
JSON
– JSON source file format. -
XML
– XML source file format.
Here is an example of how you could specify the formatParams
:
"formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }
Note that if you only provide formatType
as CSV
, the rest of the attributes will automatically default to CSV values as following:
{ "withHeader": "true", "separator": "," }
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
Trait Implementations§
Source§impl Clone for CreateChangesetFluentBuilder
impl Clone for CreateChangesetFluentBuilder
Source§fn clone(&self) -> CreateChangesetFluentBuilder
fn clone(&self) -> CreateChangesetFluentBuilder
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 CreateChangesetFluentBuilder
impl !RefUnwindSafe for CreateChangesetFluentBuilder
impl Send for CreateChangesetFluentBuilder
impl Sync for CreateChangesetFluentBuilder
impl Unpin for CreateChangesetFluentBuilder
impl !UnwindSafe for CreateChangesetFluentBuilder
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);