software.amazon.awssdk.services.backup.model

Interface GetBackupPlanResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BackupResponse.Builder, Buildable, CopyableBuilder<GetBackupPlanResponse.Builder,GetBackupPlanResponse>, SdkBuilder<GetBackupPlanResponse.Builder,GetBackupPlanResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetBackupPlanResponse

public static interface GetBackupPlanResponse.Builder
extends BackupResponse.Builder, SdkPojo, CopyableBuilder<GetBackupPlanResponse.Builder,GetBackupPlanResponse>

Method Summary

Modifier and Type	Method and Description
GetBackupPlanResponse.Builder	advancedBackupSettings(AdvancedBackupSetting... advancedBackupSettings) Contains a list of BackupOptions for each resource type.
GetBackupPlanResponse.Builder	advancedBackupSettings(Collection<AdvancedBackupSetting> advancedBackupSettings) Contains a list of BackupOptions for each resource type.
GetBackupPlanResponse.Builder	advancedBackupSettings(Consumer<AdvancedBackupSetting.Builder>... advancedBackupSettings) Contains a list of BackupOptions for each resource type.
GetBackupPlanResponse.Builder	backupPlan(BackupPlan backupPlan) Specifies the body of a backup plan.
default GetBackupPlanResponse.Builder	backupPlan(Consumer<BackupPlan.Builder> backupPlan) Specifies the body of a backup plan.
GetBackupPlanResponse.Builder	backupPlanArn(String backupPlanArn) An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
GetBackupPlanResponse.Builder	backupPlanId(String backupPlanId) Uniquely identifies a backup plan.
GetBackupPlanResponse.Builder	creationDate(Instant creationDate) The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC).
GetBackupPlanResponse.Builder	creatorRequestId(String creatorRequestId) A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
GetBackupPlanResponse.Builder	deletionDate(Instant deletionDate) The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC).
GetBackupPlanResponse.Builder	lastExecutionDate(Instant lastExecutionDate) The last time a job to back up resources was run with this backup plan.
GetBackupPlanResponse.Builder	versionId(String versionId) Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.

Methods inherited from interface software.amazon.awssdk.services.backup.model.BackupResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

backupPlan

GetBackupPlanResponse.Builder backupPlan(BackupPlan backupPlan)

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Parameters:

backupPlan - Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Returns:

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

backupPlan

default GetBackupPlanResponse.Builder backupPlan(Consumer<BackupPlan.Builder> backupPlan)

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

This is a convenience that creates an instance of the BackupPlan.Builder avoiding the need to create one manually via BackupPlan.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to backupPlan(BackupPlan).

Parameters:

backupPlan - a consumer that will call methods on BackupPlan.Builder

Returns:

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

See Also:

backupPlan(BackupPlan)

backupPlanId

GetBackupPlanResponse.Builder backupPlanId(String backupPlanId)

Uniquely identifies a backup plan.

Parameters:

backupPlanId - Uniquely identifies a backup plan.

Returns:

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

backupPlanArn

GetBackupPlanResponse.Builder backupPlanArn(String backupPlanArn)

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

Parameters:

backupPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

Returns:

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

versionId

GetBackupPlanResponse.Builder versionId(String versionId)

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Parameters:

versionId - Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Returns:

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

creatorRequestId

GetBackupPlanResponse.Builder creatorRequestId(String creatorRequestId)

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

Parameters:

creatorRequestId - A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

Returns:

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

creationDate

GetBackupPlanResponse.Builder creationDate(Instant creationDate)

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

Parameters:

creationDate - The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate 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.

deletionDate

GetBackupPlanResponse.Builder deletionDate(Instant deletionDate)

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

Parameters:

deletionDate - The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate 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.

lastExecutionDate

GetBackupPlanResponse.Builder lastExecutionDate(Instant lastExecutionDate)

The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Parameters:

lastExecutionDate - The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate 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.

advancedBackupSettings

GetBackupPlanResponse.Builder advancedBackupSettings(Collection<AdvancedBackupSetting> advancedBackupSettings)

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

Parameters:

advancedBackupSettings - Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

Returns:

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

advancedBackupSettings

GetBackupPlanResponse.Builder advancedBackupSettings(AdvancedBackupSetting... advancedBackupSettings)

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

Parameters:

advancedBackupSettings - Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

Returns:

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

advancedBackupSettings

GetBackupPlanResponse.Builder advancedBackupSettings(Consumer<AdvancedBackupSetting.Builder>... advancedBackupSettings)

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #advancedBackupSettings(List).

Parameters:

advancedBackupSettings - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#advancedBackupSettings(List)