#[non_exhaustive]pub struct DatasetExportJob {
pub job_name: Option<String>,
pub dataset_export_job_arn: Option<String>,
pub dataset_arn: Option<String>,
pub ingestion_mode: Option<IngestionMode>,
pub role_arn: Option<String>,
pub status: Option<String>,
pub job_output: Option<DatasetExportJobOutput>,
pub creation_date_time: Option<DateTime>,
pub last_updated_date_time: Option<DateTime>,
pub failure_reason: Option<String>,
}
Expand description
Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.
A dataset export job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.job_name: Option<String>
The name of the export job.
dataset_export_job_arn: Option<String>
The Amazon Resource Name (ARN) of the dataset export job.
dataset_arn: Option<String>
The Amazon Resource Name (ARN) of the dataset to export.
ingestion_mode: Option<IngestionMode>
The data to export, based on how you imported the data. You can choose to export BULK
data that you imported using a dataset import job, PUT
data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL
for both types. The default value is PUT
.
role_arn: Option<String>
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
status: Option<String>
The status of the dataset export job.
A dataset export job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
job_output: Option<DatasetExportJobOutput>
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
creation_date_time: Option<DateTime>
The creation date and time (in Unix time) of the dataset export job.
last_updated_date_time: Option<DateTime>
The date and time (in Unix time) the status of the dataset export job was last updated.
failure_reason: Option<String>
If a dataset export job fails, provides the reason why.
Implementations§
Source§impl DatasetExportJob
impl DatasetExportJob
Sourcepub fn dataset_export_job_arn(&self) -> Option<&str>
pub fn dataset_export_job_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the dataset export job.
Sourcepub fn dataset_arn(&self) -> Option<&str>
pub fn dataset_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the dataset to export.
Sourcepub fn ingestion_mode(&self) -> Option<&IngestionMode>
pub fn ingestion_mode(&self) -> Option<&IngestionMode>
The data to export, based on how you imported the data. You can choose to export BULK
data that you imported using a dataset import job, PUT
data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL
for both types. The default value is PUT
.
Sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
Sourcepub fn status(&self) -> Option<&str>
pub fn status(&self) -> Option<&str>
The status of the dataset export job.
A dataset export job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
Sourcepub fn job_output(&self) -> Option<&DatasetExportJobOutput>
pub fn job_output(&self) -> Option<&DatasetExportJobOutput>
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
Sourcepub fn creation_date_time(&self) -> Option<&DateTime>
pub fn creation_date_time(&self) -> Option<&DateTime>
The creation date and time (in Unix time) of the dataset export job.
Sourcepub fn last_updated_date_time(&self) -> Option<&DateTime>
pub fn last_updated_date_time(&self) -> Option<&DateTime>
The date and time (in Unix time) the status of the dataset export job was last updated.
Sourcepub fn failure_reason(&self) -> Option<&str>
pub fn failure_reason(&self) -> Option<&str>
If a dataset export job fails, provides the reason why.
Source§impl DatasetExportJob
impl DatasetExportJob
Sourcepub fn builder() -> DatasetExportJobBuilder
pub fn builder() -> DatasetExportJobBuilder
Creates a new builder-style object to manufacture DatasetExportJob
.
Trait Implementations§
Source§impl Clone for DatasetExportJob
impl Clone for DatasetExportJob
Source§fn clone(&self) -> DatasetExportJob
fn clone(&self) -> DatasetExportJob
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DatasetExportJob
impl Debug for DatasetExportJob
Source§impl PartialEq for DatasetExportJob
impl PartialEq for DatasetExportJob
impl StructuralPartialEq for DatasetExportJob
Auto Trait Implementations§
impl Freeze for DatasetExportJob
impl RefUnwindSafe for DatasetExportJob
impl Send for DatasetExportJob
impl Sync for DatasetExportJob
impl Unpin for DatasetExportJob
impl UnwindSafe for DatasetExportJob
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);