software.amazon.awssdk.services.fsx.model

Interface CompletionReport.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CompletionReport.Builder,CompletionReport>, SdkBuilder<CompletionReport.Builder,CompletionReport>, SdkPojo

Enclosing class:

CompletionReport

public static interface CompletionReport.Builder
extends SdkPojo, CopyableBuilder<CompletionReport.Builder,CompletionReport>

Method Summary

Modifier and Type	Method and Description
CompletionReport.Builder	enabled(Boolean enabled) Set Enabled to True to generate a CompletionReport when the task completes.
CompletionReport.Builder	format(ReportFormat format) Required if Enabled is set to true.
CompletionReport.Builder	format(String format) Required if Enabled is set to true.
CompletionReport.Builder	path(String path) Required if Enabled is set to true.
CompletionReport.Builder	scope(ReportScope scope) Required if Enabled is set to true.
CompletionReport.Builder	scope(String scope) Required if Enabled is set to true.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

enabled

CompletionReport.Builder enabled(Boolean enabled)

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.

Parameters:

enabled - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

path

CompletionReport.Builder path(String path)

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.

Parameters:

path - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

format

CompletionReport.Builder format(String format)

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.

Parameters:

format - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReportFormat, ReportFormat

format

CompletionReport.Builder format(ReportFormat format)

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.

Parameters:

format - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReportFormat, ReportFormat

scope

CompletionReport.Builder scope(String scope)

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.

Parameters:

scope - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReportScope, ReportScope

scope

CompletionReport.Builder scope(ReportScope scope)

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.

Parameters:

scope - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReportScope, ReportScope