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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<TaskReportConfig.Builder,TaskReportConfig>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.