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

Class CreateLegalHoldResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLegalHoldResponse.Builder,CreateLegalHoldResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateLegalHoldResponse.Builder

Method Summary

Modifier and Type	Method	Description
static CreateLegalHoldResponse.Builder	builder()
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 ARN (Amazon Resource Number) of the created legal hold.
String	legalHoldId()	Legal hold ID returned for the specified legal hold on a recovery point.
RecoveryPointSelection	recoveryPointSelection()	This specifies criteria to assign a set of resources, such as resource types or backup vaults.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLegalHoldResponse.Builder>	serializableBuilderClass()
LegalHoldStatus	status()	This displays the status of the legal hold returned after creating the legal hold.
String	statusAsString()	This displays the status of the legal hold returned after creating the legal hold.
String	title()	This is the string title of the legal hold returned after creating the legal hold.
CreateLegalHoldResponse.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 returned after creating the legal hold.

Returns:

This is the string title of the legal hold returned after creating the legal hold.

status

public final LegalHoldStatus status()

This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

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 displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

See Also:

LegalHoldStatus

statusAsString

public final String statusAsString()

This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

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 displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

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.

legalHoldId

public final String legalHoldId()

Legal hold ID returned for the specified legal hold on a recovery point.

Returns:

Legal hold ID returned for the specified legal hold on a recovery point.

legalHoldArn

public final String legalHoldArn()

This is the ARN (Amazon Resource Number) of the created legal hold.

Returns:

This is the ARN (Amazon Resource Number) of the created legal hold.

creationDate

public final Instant creationDate()

Time in number format when legal hold was created.

Returns:

Time in number format when legal hold was created.

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 CreateLegalHoldResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLegalHoldResponse.Builder,CreateLegalHoldResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static CreateLegalHoldResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CreateLegalHoldResponse.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