software.amazon.awssdk.services.backup.model

Interface GetLegalHoldResponse.Builder

All Superinterfaces:

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

Enclosing class:

GetLegalHoldResponse

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

Method Summary

Modifier and Type	Method and Description
GetLegalHoldResponse.Builder	cancelDescription(String cancelDescription) String describing the reason for removing the legal hold.
GetLegalHoldResponse.Builder	cancellationDate(Instant cancellationDate) Time in number when legal hold was cancelled.
GetLegalHoldResponse.Builder	creationDate(Instant creationDate) Time in number format when legal hold was created.
GetLegalHoldResponse.Builder	description(String description) This is the returned string description of the legal hold.
GetLegalHoldResponse.Builder	legalHoldArn(String legalHoldArn) This is the returned framework ARN for the specified legal hold.
GetLegalHoldResponse.Builder	legalHoldId(String legalHoldId) This is the returned ID associated with a specified legal hold.
default GetLegalHoldResponse.Builder	recoveryPointSelection(Consumer<RecoveryPointSelection.Builder> recoveryPointSelection) This specifies criteria to assign a set of resources, such as resource types or backup vaults.
GetLegalHoldResponse.Builder	recoveryPointSelection(RecoveryPointSelection recoveryPointSelection) This specifies criteria to assign a set of resources, such as resource types or backup vaults.
GetLegalHoldResponse.Builder	retainRecordUntil(Instant retainRecordUntil) This is the date and time until which the legal hold record will be retained.
GetLegalHoldResponse.Builder	status(LegalHoldStatus status) This is the status of the legal hold.
GetLegalHoldResponse.Builder	status(String status) This is the status of the legal hold.
GetLegalHoldResponse.Builder	title(String title) This is the string title of the legal hold.

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

title

GetLegalHoldResponse.Builder title(String title)

This is the string title of the legal hold.

Parameters:

title - This is the string title of the legal hold.

Returns:

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

status

GetLegalHoldResponse.Builder status(String status)

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

Parameters:

status - This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

Returns:

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

See Also:

LegalHoldStatus, LegalHoldStatus

status

GetLegalHoldResponse.Builder status(LegalHoldStatus status)

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

Parameters:

status - This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

Returns:

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

See Also:

LegalHoldStatus, LegalHoldStatus

description

GetLegalHoldResponse.Builder description(String description)

This is the returned string description of the legal hold.

Parameters:

description - This is the returned string description of the legal hold.

Returns:

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

cancelDescription

GetLegalHoldResponse.Builder cancelDescription(String cancelDescription)

String describing the reason for removing the legal hold.

Parameters:

cancelDescription - String describing the reason for removing the legal hold.

Returns:

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

legalHoldId

GetLegalHoldResponse.Builder legalHoldId(String legalHoldId)

This is the returned ID associated with a specified legal hold.

Parameters:

legalHoldId - This is the returned ID associated with a specified legal hold.

Returns:

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

legalHoldArn

GetLegalHoldResponse.Builder legalHoldArn(String legalHoldArn)

This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

Parameters:

legalHoldArn - This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) 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.

creationDate

GetLegalHoldResponse.Builder creationDate(Instant creationDate)

Time in number format when legal hold was created.

Parameters:

creationDate - Time in number format when legal hold was created.

Returns:

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

cancellationDate

GetLegalHoldResponse.Builder cancellationDate(Instant cancellationDate)

Time in number when legal hold was cancelled.

Parameters:

cancellationDate - Time in number when legal hold was cancelled.

Returns:

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

retainRecordUntil

GetLegalHoldResponse.Builder retainRecordUntil(Instant retainRecordUntil)

This is the date and time until which the legal hold record will be retained.

Parameters:

retainRecordUntil - This is the date and time until which the legal hold record will be retained.

Returns:

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

recoveryPointSelection

GetLegalHoldResponse.Builder recoveryPointSelection(RecoveryPointSelection recoveryPointSelection)

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

Parameters:

recoveryPointSelection - This specifies criteria to assign a set of resources, such as resource types or backup vaults.

Returns:

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

recoveryPointSelection

default GetLegalHoldResponse.Builder recoveryPointSelection(Consumer<RecoveryPointSelection.Builder> recoveryPointSelection)

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

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

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

Parameters:

recoveryPointSelection - a consumer that will call methods on RecoveryPointSelection.Builder

Returns:

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

See Also:

recoveryPointSelection(RecoveryPointSelection)