#[non_exhaustive]pub struct CopyStepDetailsBuilder { /* private fields */ }
Expand description
A builder for CopyStepDetails
.
Implementations§
Source§impl CopyStepDetailsBuilder
impl CopyStepDetailsBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the step, used as an identifier.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the step, used as an identifier.
Sourcepub fn destination_file_location(self, input: InputFileLocation) -> Self
pub fn destination_file_location(self, input: InputFileLocation) -> Self
Specifies the location for the file being copied. Use ${Transfer:UserName}
or ${Transfer:UploadDate}
in this field to parametrize the destination prefix by username or uploaded date.
-
Set the value of
DestinationFileLocation
to${Transfer:UserName}
to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file. -
Set the value of
DestinationFileLocation
to${Transfer:UploadDate}
to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.The system resolves
UploadDate
to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
Sourcepub fn set_destination_file_location(
self,
input: Option<InputFileLocation>,
) -> Self
pub fn set_destination_file_location( self, input: Option<InputFileLocation>, ) -> Self
Specifies the location for the file being copied. Use ${Transfer:UserName}
or ${Transfer:UploadDate}
in this field to parametrize the destination prefix by username or uploaded date.
-
Set the value of
DestinationFileLocation
to${Transfer:UserName}
to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file. -
Set the value of
DestinationFileLocation
to${Transfer:UploadDate}
to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.The system resolves
UploadDate
to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
Sourcepub fn get_destination_file_location(&self) -> &Option<InputFileLocation>
pub fn get_destination_file_location(&self) -> &Option<InputFileLocation>
Specifies the location for the file being copied. Use ${Transfer:UserName}
or ${Transfer:UploadDate}
in this field to parametrize the destination prefix by username or uploaded date.
-
Set the value of
DestinationFileLocation
to${Transfer:UserName}
to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file. -
Set the value of
DestinationFileLocation
to${Transfer:UploadDate}
to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.The system resolves
UploadDate
to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
Sourcepub fn overwrite_existing(self, input: OverwriteExisting) -> Self
pub fn overwrite_existing(self, input: OverwriteExisting) -> Self
A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE
.
If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
-
If
OverwriteExisting
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, nothing happens, and the workflow processing stops.
Sourcepub fn set_overwrite_existing(self, input: Option<OverwriteExisting>) -> Self
pub fn set_overwrite_existing(self, input: Option<OverwriteExisting>) -> Self
A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE
.
If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
-
If
OverwriteExisting
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, nothing happens, and the workflow processing stops.
Sourcepub fn get_overwrite_existing(&self) -> &Option<OverwriteExisting>
pub fn get_overwrite_existing(&self) -> &Option<OverwriteExisting>
A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE
.
If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
-
If
OverwriteExisting
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, nothing happens, and the workflow processing stops.
Sourcepub fn source_file_location(self, input: impl Into<String>) -> Self
pub fn source_file_location(self, input: impl Into<String>) -> Self
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
-
To use the previous file as the input, enter
${previous.file}
. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. -
To use the originally uploaded file location as input for this step, enter
${original.file}
.
Sourcepub fn set_source_file_location(self, input: Option<String>) -> Self
pub fn set_source_file_location(self, input: Option<String>) -> Self
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
-
To use the previous file as the input, enter
${previous.file}
. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. -
To use the originally uploaded file location as input for this step, enter
${original.file}
.
Sourcepub fn get_source_file_location(&self) -> &Option<String>
pub fn get_source_file_location(&self) -> &Option<String>
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
-
To use the previous file as the input, enter
${previous.file}
. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. -
To use the originally uploaded file location as input for this step, enter
${original.file}
.
Sourcepub fn build(self) -> CopyStepDetails
pub fn build(self) -> CopyStepDetails
Consumes the builder and constructs a CopyStepDetails
.
Trait Implementations§
Source§impl Clone for CopyStepDetailsBuilder
impl Clone for CopyStepDetailsBuilder
Source§fn clone(&self) -> CopyStepDetailsBuilder
fn clone(&self) -> CopyStepDetailsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CopyStepDetailsBuilder
impl Debug for CopyStepDetailsBuilder
Source§impl Default for CopyStepDetailsBuilder
impl Default for CopyStepDetailsBuilder
Source§fn default() -> CopyStepDetailsBuilder
fn default() -> CopyStepDetailsBuilder
Source§impl PartialEq for CopyStepDetailsBuilder
impl PartialEq for CopyStepDetailsBuilder
impl StructuralPartialEq for CopyStepDetailsBuilder
Auto Trait Implementations§
impl Freeze for CopyStepDetailsBuilder
impl RefUnwindSafe for CopyStepDetailsBuilder
impl Send for CopyStepDetailsBuilder
impl Sync for CopyStepDetailsBuilder
impl Unpin for CopyStepDetailsBuilder
impl UnwindSafe for CopyStepDetailsBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);