Package software.amazon.awssdk.services.datasync.model

Class TaskReportConfig

java.lang.Object

software.amazon.awssdk.services.datasync.model.TaskReportConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TaskReportConfig.Builder,TaskReportConfig>

@Generated("software.amazon.awssdk:codegen")
public final class TaskReportConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TaskReportConfig.Builder,TaskReportConfig>

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

For more information, see Task reports.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TaskReportConfig.Builder

Method Summary

Modifier and Type	Method	Description
static TaskReportConfig.Builder	builder()
ReportDestination	destination()	Specifies the Amazon S3 bucket where DataSync uploads your task report.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ObjectVersionIds	objectVersionIds()	Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
String	objectVersionIdsAsString()	Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
ReportOutputType	outputType()	Specifies the type of task report that you want:
String	outputTypeAsString()	Specifies the type of task report that you want:
ReportOverrides	overrides()	Customizes the reporting level for aspects of your task report.
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.
String	reportLevelAsString()	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.
List<SdkField<?>>	sdkFields()
static Class<? extends TaskReportConfig.Builder>	serializableBuilderClass()
TaskReportConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

destination

public final ReportDestination destination()

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

Returns:

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

outputType

public final 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.

If the service returns an enum value that is not available in the current SDK version, outputType will return ReportOutputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputTypeAsString().

Returns:

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.

See Also:

ReportOutputType

outputTypeAsString

public final String outputTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, outputType will return ReportOutputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputTypeAsString().

Returns:

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.

See Also:

ReportOutputType

reportLevel

public final 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.

If the service returns an enum value that is not available in the current SDK version, reportLevel will return ReportLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reportLevelAsString().

Returns:

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.

See Also:

ReportLevel

reportLevelAsString

public final String reportLevelAsString()

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.

If the service returns an enum value that is not available in the current SDK version, reportLevel will return ReportLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reportLevelAsString().

Returns:

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.

See Also:

ReportLevel

objectVersionIds

public final 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.

If the service returns an enum value that is not available in the current SDK version, objectVersionIds will return ObjectVersionIds.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectVersionIdsAsString().

Returns:

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.

See Also:

ObjectVersionIds

objectVersionIdsAsString

public final String objectVersionIdsAsString()

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.

If the service returns an enum value that is not available in the current SDK version, objectVersionIds will return ObjectVersionIds.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectVersionIdsAsString().

Returns:

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.

See Also:

ObjectVersionIds

overrides

public final 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.

Returns:

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.

toBuilder

public TaskReportConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TaskReportConfig.Builder,TaskReportConfig>

builder

public static TaskReportConfig.Builder builder()

serializableBuilderClass

public static Class<? extends TaskReportConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo