Struct aws_sdk_fsx::model::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. To learn more about a file system's ExportPath
, see .
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
sourceimpl 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. To learn more about a file system's ExportPath
, see .
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.
sourceimpl CompletionReport
impl CompletionReport
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CompletionReport
Trait Implementations
sourceimpl Clone for CompletionReport
impl Clone for CompletionReport
sourcefn clone(&self) -> CompletionReport
fn clone(&self) -> CompletionReport
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CompletionReport
impl Debug for CompletionReport
sourceimpl PartialEq<CompletionReport> for CompletionReport
impl PartialEq<CompletionReport> for CompletionReport
sourcefn eq(&self, other: &CompletionReport) -> bool
fn eq(&self, other: &CompletionReport) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CompletionReport) -> bool
fn ne(&self, other: &CompletionReport) -> bool
This method tests for !=
.
impl StructuralPartialEq for CompletionReport
Auto Trait Implementations
impl RefUnwindSafe for CompletionReport
impl Send for CompletionReport
impl Sync for CompletionReport
impl Unpin for CompletionReport
impl UnwindSafe for CompletionReport
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more