Class JobReport

java.lang.Object
software.amazon.awssdk.services.s3control.model.JobReport
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<JobReport.Builder,JobReport>
@Generated("software.amazon.awssdk:codegen") public final class JobReport extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JobReport.Builder,JobReport>

Contains the configuration parameters for a job-completion report.

See Also:

  • Method Details

    • bucket

      public final String bucket()

      The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

      Directory buckets - Directory buckets aren't supported as a location for Batch Operations to store job completion reports.

      Returns:
      The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

      Directory buckets - Directory buckets aren't supported as a location for Batch Operations to store job completion reports.

    • format

      public final JobReportFormat format()

      The format of the specified job-completion report.

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

      Returns:
      The format of the specified job-completion report.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the specified job-completion report.

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

      Returns:
      The format of the specified job-completion report.
      See Also:

    • enabled

      public final Boolean enabled()

      Indicates whether the specified job will generate a job-completion report.

      Returns:
      Indicates whether the specified job will generate a job-completion report.

    • prefix

      public final String prefix()

      An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

      Returns:
      An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

    • reportScope

      public final JobReportScope reportScope()

      Indicates whether the job-completion report will include details of all tasks or only failed tasks.

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

      Returns:
      Indicates whether the job-completion report will include details of all tasks or only failed tasks.
      See Also:

    • reportScopeAsString

      public final String reportScopeAsString()

      Indicates whether the job-completion report will include details of all tasks or only failed tasks.

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

      Returns:
      Indicates whether the job-completion report will include details of all tasks or only failed tasks.
      See Also:

    • toBuilder

      public JobReport.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<JobReport.Builder,JobReport>
      Returns:
      a builder for type T

    • builder

      public static JobReport.Builder builder()

    • serializableBuilderClass

      public static Class<? extends JobReport.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.