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

Interface ReportJob.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ReportJob.Builder,ReportJob>, SdkBuilder<ReportJob.Builder,ReportJob>, SdkPojo
Enclosing class:
ReportJob
public static interface ReportJob.Builder extends SdkPojo, CopyableBuilder<ReportJob.Builder,ReportJob>

  • Method Details

    • reportJobId

      ReportJob.Builder reportJobId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • reportPlanArn

      ReportJob.Builder reportPlanArn(String reportPlanArn)

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

      Parameters:
      reportPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportTemplate

      ReportJob.Builder reportTemplate(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      ReportJob.Builder creationTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • completionTime

      ReportJob.Builder completionTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ReportJob.Builder status(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • statusMessage

      ReportJob.Builder statusMessage(String statusMessage)

      A message explaining the status of the report job.

      Parameters:
      statusMessage - A message explaining the status of the report job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportDestination

      ReportJob.Builder reportDestination(ReportDestination reportDestination)

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

      Parameters:
      reportDestination - The S3 bucket name and S3 keys for the destination where the report job publishes the report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportDestination

      default ReportJob.Builder reportDestination(Consumer<ReportDestination.Builder> reportDestination)

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

      This is a convenience method that creates an instance of the ReportDestination.Builder avoiding the need to create one manually via ReportDestination.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to reportDestination(ReportDestination).

      Parameters:
      reportDestination - a consumer that will call methods on ReportDestination.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: