Struct aws_sdk_fsx::types::CompletionReport
source · #[non_exhaustive]pub struct CompletionReport {
pub enabled: Option<bool>,
pub path: Option<String>,
pub format: Option<ReportFormat>,
pub scope: Option<ReportScope>,
}
Expand description
Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope
parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path
parameter. You can specify whether or not a report gets generated for a task using the Enabled
parameter.
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.enabled: Option<bool>
Set Enabled
to True
to generate a CompletionReport
when the task completes. If set to true
, then you need to provide a report Scope
, Path
, and Format
. Set Enabled
to False
if you do not want a CompletionReport
generated when the task completes.
path: Option<String>
Required if Enabled
is set to true
. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The Path
you provide must be located within the file system’s ExportPath. An example Path
value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.
format: Option<ReportFormat>
Required if Enabled
is set to true
. Specifies the format of the CompletionReport
. REPORT_CSV_20191124
is the only format currently supported. When Format
is set to REPORT_CSV_20191124
, the CompletionReport
is provided in CSV format, and is delivered to {path}/task-{id}/failures.csv
.
scope: Option<ReportScope>
Required if Enabled
is set to true
. Specifies the scope of the CompletionReport
; FAILED_FILES_ONLY
is the only scope currently supported. When Scope
is set to FAILED_FILES_ONLY
, the CompletionReport
only contains information about files that the data repository task failed to process.
Implementations§
source§impl CompletionReport
impl CompletionReport
sourcepub fn enabled(&self) -> Option<bool>
pub fn enabled(&self) -> Option<bool>
Set Enabled
to True
to generate a CompletionReport
when the task completes. If set to true
, then you need to provide a report Scope
, Path
, and Format
. Set Enabled
to False
if you do not want a CompletionReport
generated when the task completes.
sourcepub fn path(&self) -> Option<&str>
pub fn path(&self) -> Option<&str>
Required if Enabled
is set to true
. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The Path
you provide must be located within the file system’s ExportPath. An example Path
value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.
sourcepub fn format(&self) -> Option<&ReportFormat>
pub fn format(&self) -> Option<&ReportFormat>
Required if Enabled
is set to true
. Specifies the format of the CompletionReport
. REPORT_CSV_20191124
is the only format currently supported. When Format
is set to REPORT_CSV_20191124
, the CompletionReport
is provided in CSV format, and is delivered to {path}/task-{id}/failures.csv
.
sourcepub fn scope(&self) -> Option<&ReportScope>
pub fn scope(&self) -> Option<&ReportScope>
Required if Enabled
is set to true
. Specifies the scope of the CompletionReport
; FAILED_FILES_ONLY
is the only scope currently supported. When Scope
is set to FAILED_FILES_ONLY
, the CompletionReport
only contains information about files that the data repository task failed to process.
source§impl CompletionReport
impl CompletionReport
sourcepub fn builder() -> CompletionReportBuilder
pub fn builder() -> CompletionReportBuilder
Creates a new builder-style object to manufacture CompletionReport
.
Trait Implementations§
source§impl Clone for CompletionReport
impl Clone for CompletionReport
source§fn clone(&self) -> CompletionReport
fn clone(&self) -> CompletionReport
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CompletionReport
impl Debug for CompletionReport
source§impl PartialEq for CompletionReport
impl PartialEq for CompletionReport
source§fn eq(&self, other: &CompletionReport) -> bool
fn eq(&self, other: &CompletionReport) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CompletionReport
Auto Trait Implementations§
impl Freeze for CompletionReport
impl RefUnwindSafe for CompletionReport
impl Send for CompletionReport
impl Sync for CompletionReport
impl Unpin for CompletionReport
impl UnwindSafe for CompletionReport
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> 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 more