Package software.amazon.awssdk.services.backup.model

Class ReportJob

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

Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.

See Also:

  • Method Details

    • reportJobId

      public final String reportJobId()

      The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

      Returns:
      The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

    • reportPlanArn

      public final String reportPlanArn()

      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

      Returns:
      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

    • reportTemplate

      public final String reportTemplate()

      Identifies the report template for the report. Reports are built using a report template. The report templates are:

      RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

      Returns:
      Identifies the report template for the report. Reports are built using a report template. The report templates are:

      RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

    • creationTime

      public final Instant creationTime()

      The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Returns:
      The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • completionTime

      public final Instant completionTime()

      The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Returns:
      The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • status

      public final String status()

      The status of a report job. The statuses are:

      CREATED | RUNNING | COMPLETED | FAILED

      COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

      Returns:
      The status of a report job. The statuses are:

      CREATED | RUNNING | COMPLETED | FAILED

      COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

    • statusMessage

      public final String statusMessage()

      A message explaining the status of the report job.

      Returns:
      A message explaining the status of the report job.

    • reportDestination

      public final ReportDestination reportDestination()

      The S3 bucket name and S3 keys for the destination where the report job publishes the report.

      Returns:
      The S3 bucket name and S3 keys for the destination where the report job publishes the report.

    • toBuilder

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

    • builder

      public static ReportJob.Builder builder()

    • serializableBuilderClass

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