software.amazon.awssdk.services.datasync.model

Interface TaskReportConfig.Builder

All Superinterfaces:

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

Enclosing class:

TaskReportConfig

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

Method Summary

Modifier and Type	Method and Description
default TaskReportConfig.Builder	destination(Consumer<ReportDestination.Builder> destination) Specifies the Amazon S3 bucket where DataSync uploads your task report.
TaskReportConfig.Builder	destination(ReportDestination destination) Specifies the Amazon S3 bucket where DataSync uploads your task report.
TaskReportConfig.Builder	objectVersionIds(ObjectVersionIds objectVersionIds) Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
TaskReportConfig.Builder	objectVersionIds(String objectVersionIds) Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
TaskReportConfig.Builder	outputType(ReportOutputType outputType) Specifies the type of task report that you want:
TaskReportConfig.Builder	outputType(String outputType) Specifies the type of task report that you want:
default TaskReportConfig.Builder	overrides(Consumer<ReportOverrides.Builder> overrides) Customizes the reporting level for aspects of your task report.
TaskReportConfig.Builder	overrides(ReportOverrides overrides) Customizes the reporting level for aspects of your task report.
TaskReportConfig.Builder	reportLevel(ReportLevel reportLevel) Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
TaskReportConfig.Builder	reportLevel(String reportLevel) Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

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

destination

TaskReportConfig.Builder destination(ReportDestination destination)

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

Parameters:

destination - Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

Returns:

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

destination

default TaskReportConfig.Builder destination(Consumer<ReportDestination.Builder> destination)

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

This is a convenience method that creates an instance of the ReportDestination.Builder avoiding the need to create one manually via ReportDestination.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destination(ReportDestination).

Parameters:

destination - a consumer that will call methods on ReportDestination.Builder

Returns:

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

See Also:

destination(ReportDestination)

outputType

TaskReportConfig.Builder outputType(String outputType)

Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Parameters:

outputType - Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Returns:

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

See Also:

ReportOutputType, ReportOutputType

outputType

TaskReportConfig.Builder outputType(ReportOutputType outputType)

Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Parameters:

outputType - Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Returns:

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

See Also:

ReportOutputType, ReportOutputType

reportLevel

TaskReportConfig.Builder reportLevel(String reportLevel)

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Parameters:

reportLevel - Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Returns:

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

See Also:

ReportLevel, ReportLevel

reportLevel

TaskReportConfig.Builder reportLevel(ReportLevel reportLevel)

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Parameters:

reportLevel - Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Returns:

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

See Also:

ReportLevel, ReportLevel

objectVersionIds

TaskReportConfig.Builder objectVersionIds(String objectVersionIds)

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Parameters:

objectVersionIds - Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Returns:

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

See Also:

ObjectVersionIds, ObjectVersionIds

objectVersionIds

TaskReportConfig.Builder objectVersionIds(ObjectVersionIds objectVersionIds)

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Parameters:

objectVersionIds - Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Returns:

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

See Also:

ObjectVersionIds, ObjectVersionIds

overrides

TaskReportConfig.Builder overrides(ReportOverrides overrides)

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

Parameters:

overrides - Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

Returns:

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

overrides

default TaskReportConfig.Builder overrides(Consumer<ReportOverrides.Builder> overrides)

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

This is a convenience method that creates an instance of the ReportOverrides.Builder avoiding the need to create one manually via ReportOverrides.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrides(ReportOverrides).

Parameters:

overrides - a consumer that will call methods on ReportOverrides.Builder

Returns:

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

See Also:

overrides(ReportOverrides)