Interface GetBackupPlanResponse.Builder
- All Superinterfaces:
AwsResponse.Builder,BackupResponse.Builder,Buildable,CopyableBuilder<GetBackupPlanResponse.Builder,,GetBackupPlanResponse> SdkBuilder<GetBackupPlanResponse.Builder,,GetBackupPlanResponse> SdkPojo,SdkResponse.Builder
- Enclosing class:
GetBackupPlanResponse
-
Method Summary
Modifier and TypeMethodDescriptionadvancedBackupSettings(Collection<AdvancedBackupSetting> advancedBackupSettings) Contains a list ofBackupOptionsfor each resource type.advancedBackupSettings(Consumer<AdvancedBackupSetting.Builder>... advancedBackupSettings) Contains a list ofBackupOptionsfor each resource type.advancedBackupSettings(AdvancedBackupSetting... advancedBackupSettings) Contains a list ofBackupOptionsfor each resource type.default GetBackupPlanResponse.BuilderbackupPlan(Consumer<BackupPlan.Builder> backupPlan) Specifies the body of a backup plan.backupPlan(BackupPlan backupPlan) Specifies the body of a backup plan.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.backupPlanId(String backupPlanId) Uniquely identifies a backup plan.creationDate(Instant creationDate) The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC).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.deletionDate(Instant deletionDate) The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC).lastExecutionDate(Instant lastExecutionDate) The last time this backup plan was run.scheduledRunsPreview(Collection<ScheduledPlanExecutionMember> scheduledRunsPreview) List of upcoming scheduled backup runs.scheduledRunsPreview(Consumer<ScheduledPlanExecutionMember.Builder>... scheduledRunsPreview) List of upcoming scheduled backup runs.scheduledRunsPreview(ScheduledPlanExecutionMember... scheduledRunsPreview) List of upcoming scheduled backup runs.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, responseMetadataMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFieldsMethods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
backupPlan
Specifies the body of a backup plan. Includes a
BackupPlanNameand one or more sets ofRules.- Parameters:
backupPlan- Specifies the body of a backup plan. Includes aBackupPlanNameand one or more sets ofRules.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backupPlan
Specifies the body of a backup plan. Includes a
This is a convenience method that creates an instance of theBackupPlanNameand one or more sets ofRules.BackupPlan.Builderavoiding the need to create one manually viaBackupPlan.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tobackupPlan(BackupPlan).- Parameters:
backupPlan- a consumer that will call methods onBackupPlan.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDateis 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 ofCreationDateis 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
The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of
DeletionDateis 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 ofDeletionDateis 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
The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of
LastExecutionDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Parameters:
lastExecutionDate- The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value ofLastExecutionDateis 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
BackupOptionsfor each resource type. The list is populated only if the advanced option is set for the backup plan.- Parameters:
advancedBackupSettings- Contains a list ofBackupOptionsfor 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
BackupOptionsfor each resource type. The list is populated only if the advanced option is set for the backup plan.- Parameters:
advancedBackupSettings- Contains a list ofBackupOptionsfor 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
This is a convenience method that creates an instance of theBackupOptionsfor each resource type. The list is populated only if the advanced option is set for the backup plan.AdvancedBackupSetting.Builderavoiding the need to create one manually viaAdvancedBackupSetting.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toadvancedBackupSettings(List<AdvancedBackupSetting>).- Parameters:
advancedBackupSettings- a consumer that will call methods onAdvancedBackupSetting.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scheduledRunsPreview
GetBackupPlanResponse.Builder scheduledRunsPreview(Collection<ScheduledPlanExecutionMember> scheduledRunsPreview) List of upcoming scheduled backup runs. Only included when
MaxScheduledRunsPreviewparameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.- Parameters:
scheduledRunsPreview- List of upcoming scheduled backup runs. Only included whenMaxScheduledRunsPreviewparameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduledRunsPreview
GetBackupPlanResponse.Builder scheduledRunsPreview(ScheduledPlanExecutionMember... scheduledRunsPreview) List of upcoming scheduled backup runs. Only included when
MaxScheduledRunsPreviewparameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.- Parameters:
scheduledRunsPreview- List of upcoming scheduled backup runs. Only included whenMaxScheduledRunsPreviewparameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduledRunsPreview
GetBackupPlanResponse.Builder scheduledRunsPreview(Consumer<ScheduledPlanExecutionMember.Builder>... scheduledRunsPreview) List of upcoming scheduled backup runs. Only included when
This is a convenience method that creates an instance of theMaxScheduledRunsPreviewparameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.ScheduledPlanExecutionMember.Builderavoiding the need to create one manually viaScheduledPlanExecutionMember.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toscheduledRunsPreview(List<ScheduledPlanExecutionMember>).- Parameters:
scheduledRunsPreview- a consumer that will call methods onScheduledPlanExecutionMember.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-