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

Class GetLegalHoldResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.backup.model.BackupResponse

software.amazon.awssdk.services.backup.model.GetLegalHoldResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetLegalHoldResponse.Builder,GetLegalHoldResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetLegalHoldResponse
extends BackupResponse
implements ToCopyableBuilder<GetLegalHoldResponse.Builder,GetLegalHoldResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetLegalHoldResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetLegalHoldResponse.Builder	builder()
String	cancelDescription()	String describing the reason for removing the legal hold.
Instant	cancellationDate()	Time in number when legal hold was cancelled.
Instant	creationDate()	Time in number format when legal hold was created.
String	description()	This is the returned string description of the legal hold.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	legalHoldArn()	This is the returned framework ARN for the specified legal hold.
String	legalHoldId()	This is the returned ID associated with a specified legal hold.
RecoveryPointSelection	recoveryPointSelection()	This specifies criteria to assign a set of resources, such as resource types or backup vaults.
Instant	retainRecordUntil()	This is the date and time until which the legal hold record will be retained.
List<SdkField<?>>	sdkFields()
static Class<? extends GetLegalHoldResponse.Builder>	serializableBuilderClass()
LegalHoldStatus	status()	This is the status of the legal hold.
String	statusAsString()	This is the status of the legal hold.
String	title()	This is the string title of the legal hold.
GetLegalHoldResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.backup.model.BackupResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

title

public final String title()

This is the string title of the legal hold.

Returns:

This is the string title of the legal hold.

status

public final LegalHoldStatus status()

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

If the service returns an enum value that is not available in the current SDK version, status will return LegalHoldStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

LegalHoldStatus

statusAsString

public final String statusAsString()

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

If the service returns an enum value that is not available in the current SDK version, status will return LegalHoldStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

LegalHoldStatus

description

public final String description()

This is the returned string description of the legal hold.

Returns:

This is the returned string description of the legal hold.

cancelDescription

public final String cancelDescription()

String describing the reason for removing the legal hold.

Returns:

String describing the reason for removing the legal hold.

legalHoldId

public final String legalHoldId()

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

Returns:

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

legalHoldArn

public final 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.

Returns:

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.

creationDate

public final Instant creationDate()

Time in number format when legal hold was created.

Returns:

Time in number format when legal hold was created.

cancellationDate

public final Instant cancellationDate()

Time in number when legal hold was cancelled.

Returns:

Time in number when legal hold was cancelled.

retainRecordUntil

public final Instant retainRecordUntil()

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

Returns:

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

recoveryPointSelection

public final RecoveryPointSelection recoveryPointSelection()

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

Returns:

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

toBuilder

public GetLegalHoldResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetLegalHoldResponse.Builder,GetLegalHoldResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetLegalHoldResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetLegalHoldResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo