Class TaskReportConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic TaskReportConfig.Builder
builder()
final ReportDestination
Specifies the Amazon S3 bucket where DataSync uploads your task report.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final ObjectVersionIds
Specifies whether your task report includes the new version of each object transferred into an S3 bucket.final String
Specifies whether your task report includes the new version of each object transferred into an S3 bucket.final ReportOutputType
Specifies the type of task report that you want:final String
Specifies the type of task report that you want:final ReportOverrides
Customizes the reporting level for aspects of your task report.final 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.final String
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.static Class
<? extends TaskReportConfig.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnReportOutputType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputTypeAsString()
.- 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:
-
-
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 returnReportOutputType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputTypeAsString()
.- 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:
-
-
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 returnReportLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreportLevelAsString()
.- 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:
-
-
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 returnReportLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreportLevelAsString()
.- 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:
-
-
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 returnObjectVersionIds.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectVersionIdsAsString()
.- 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:
-
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 returnObjectVersionIds.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectVersionIdsAsString()
.- 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:
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TaskReportConfig.Builder,
TaskReportConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-