software.amazon.awssdk.services.backup.model

Interface ReportPlan.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ReportPlan.Builder,ReportPlan>, SdkBuilder<ReportPlan.Builder,ReportPlan>, SdkPojo

Enclosing class:

ReportPlan

public static interface ReportPlan.Builder
extends SdkPojo, CopyableBuilder<ReportPlan.Builder,ReportPlan>

Method Summary

Modifier and Type	Method and Description
ReportPlan.Builder	creationTime(Instant creationTime) The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
ReportPlan.Builder	deploymentStatus(String deploymentStatus) The deployment status of a report plan.
ReportPlan.Builder	lastAttemptedExecutionTime(Instant lastAttemptedExecutionTime) The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC).
ReportPlan.Builder	lastSuccessfulExecutionTime(Instant lastSuccessfulExecutionTime) The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC).
default ReportPlan.Builder	reportDeliveryChannel(Consumer<ReportDeliveryChannel.Builder> reportDeliveryChannel) Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
ReportPlan.Builder	reportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel) Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
ReportPlan.Builder	reportPlanArn(String reportPlanArn) An Amazon Resource Name (ARN) that uniquely identifies a resource.
ReportPlan.Builder	reportPlanDescription(String reportPlanDescription) An optional description of the report plan with a maximum 1,024 characters.
ReportPlan.Builder	reportPlanName(String reportPlanName) The unique name of the report plan.
default ReportPlan.Builder	reportSetting(Consumer<ReportSetting.Builder> reportSetting) Identifies the report template for the report.
ReportPlan.Builder	reportSetting(ReportSetting reportSetting) Identifies the report template for the report.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

reportPlanArn

ReportPlan.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.

reportPlanName

ReportPlan.Builder reportPlanName(String reportPlanName)

The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Parameters:

reportPlanName - The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Returns:

Returns a reference to this object so that method calls can be chained together.

reportPlanDescription

ReportPlan.Builder reportPlanDescription(String reportPlanDescription)

An optional description of the report plan with a maximum 1,024 characters.

Parameters:

reportPlanDescription - An optional description of the report plan with a maximum 1,024 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

reportSetting

ReportPlan.Builder reportSetting(ReportSetting reportSetting)

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

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

Parameters:

reportSetting - 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

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

Returns:

Returns a reference to this object so that method calls can be chained together.

reportSetting

default ReportPlan.Builder reportSetting(Consumer<ReportSetting.Builder> reportSetting)

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

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

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

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

Parameters:

reportSetting - a consumer that will call methods on ReportSetting.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

reportSetting(ReportSetting)

reportDeliveryChannel

ReportPlan.Builder reportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel)

Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

Parameters:

reportDeliveryChannel - Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

Returns:

Returns a reference to this object so that method calls can be chained together.

reportDeliveryChannel

default ReportPlan.Builder reportDeliveryChannel(Consumer<ReportDeliveryChannel.Builder> reportDeliveryChannel)

Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

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

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

Parameters:

reportDeliveryChannel - a consumer that will call methods on ReportDeliveryChannel.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

reportDeliveryChannel(ReportDeliveryChannel)

deploymentStatus

ReportPlan.Builder deploymentStatus(String deploymentStatus)

The deployment status of a report plan. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

Parameters:

deploymentStatus - The deployment status of a report plan. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

Returns:

Returns a reference to this object so that method calls can be chained together.

creationTime

ReportPlan.Builder creationTime(Instant creationTime)

The date and time that a report plan 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 plan 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.

lastAttemptedExecutionTime

ReportPlan.Builder lastAttemptedExecutionTime(Instant lastAttemptedExecutionTime)

The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Parameters:

lastAttemptedExecutionTime - The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime 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.

lastSuccessfulExecutionTime

ReportPlan.Builder lastSuccessfulExecutionTime(Instant lastSuccessfulExecutionTime)

The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Parameters:

lastSuccessfulExecutionTime - The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime 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.