Interface CompletionReport.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CompletionReport.Builder,
,CompletionReport> SdkBuilder<CompletionReport.Builder,
,CompletionReport> SdkPojo
- Enclosing class:
CompletionReport
-
Method Summary
Modifier and TypeMethodDescriptionSetEnabled
toTrue
to generate aCompletionReport
when the task completes.Required ifEnabled
is set totrue
.format
(ReportFormat format) Required ifEnabled
is set totrue
.Required ifEnabled
is set totrue
.Required ifEnabled
is set totrue
.scope
(ReportScope scope) Required ifEnabled
is set totrue
.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
enabled
Set
Enabled
toTrue
to generate aCompletionReport
when the task completes. If set totrue
, then you need to provide a reportScope
,Path
, andFormat
. SetEnabled
toFalse
if you do not want aCompletionReport
generated when the task completes.- Parameters:
enabled
- SetEnabled
toTrue
to generate aCompletionReport
when the task completes. If set totrue
, then you need to provide a reportScope
,Path
, andFormat
. SetEnabled
toFalse
if you do not want aCompletionReport
generated when the task completes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
path
Required if
Enabled
is set totrue
. 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. ThePath
you provide must be located within the file system’s ExportPath. An examplePath
value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.- Parameters:
path
- Required ifEnabled
is set totrue
. 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. ThePath
you provide must be located within the file system’s ExportPath. An examplePath
value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
format
Required if
Enabled
is set totrue
. Specifies the format of theCompletionReport
.REPORT_CSV_20191124
is the only format currently supported. WhenFormat
is set toREPORT_CSV_20191124
, theCompletionReport
is provided in CSV format, and is delivered to{path}/task-{id}/failures.csv
.- Parameters:
format
- Required ifEnabled
is set totrue
. Specifies the format of theCompletionReport
.REPORT_CSV_20191124
is the only format currently supported. WhenFormat
is set toREPORT_CSV_20191124
, theCompletionReport
is provided in CSV format, and is delivered to{path}/task-{id}/failures.csv
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
format
Required if
Enabled
is set totrue
. Specifies the format of theCompletionReport
.REPORT_CSV_20191124
is the only format currently supported. WhenFormat
is set toREPORT_CSV_20191124
, theCompletionReport
is provided in CSV format, and is delivered to{path}/task-{id}/failures.csv
.- Parameters:
format
- Required ifEnabled
is set totrue
. Specifies the format of theCompletionReport
.REPORT_CSV_20191124
is the only format currently supported. WhenFormat
is set toREPORT_CSV_20191124
, theCompletionReport
is provided in CSV format, and is delivered to{path}/task-{id}/failures.csv
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scope
Required if
Enabled
is set totrue
. Specifies the scope of theCompletionReport
;FAILED_FILES_ONLY
is the only scope currently supported. WhenScope
is set toFAILED_FILES_ONLY
, theCompletionReport
only contains information about files that the data repository task failed to process.- Parameters:
scope
- Required ifEnabled
is set totrue
. Specifies the scope of theCompletionReport
;FAILED_FILES_ONLY
is the only scope currently supported. WhenScope
is set toFAILED_FILES_ONLY
, theCompletionReport
only contains information about files that the data repository task failed to process.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scope
Required if
Enabled
is set totrue
. Specifies the scope of theCompletionReport
;FAILED_FILES_ONLY
is the only scope currently supported. WhenScope
is set toFAILED_FILES_ONLY
, theCompletionReport
only contains information about files that the data repository task failed to process.- Parameters:
scope
- Required ifEnabled
is set totrue
. Specifies the scope of theCompletionReport
;FAILED_FILES_ONLY
is the only scope currently supported. WhenScope
is set toFAILED_FILES_ONLY
, theCompletionReport
only contains information about files that the data repository task failed to process.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-