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

Class LegalHold

java.lang.Object

software.amazon.awssdk.services.backup.model.LegalHold

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LegalHold.Builder,LegalHold>

@Generated("software.amazon.awssdk:codegen")
public final class LegalHold
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LegalHold.Builder,LegalHold>

A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LegalHold.Builder

Method Summary

Modifier and Type	Method	Description
static LegalHold.Builder	builder()
Instant	cancellationDate()	The time when the legal hold was cancelled.
Instant	creationDate()	The time when the legal hold was created.
String	description()	The description of a legal hold.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	legalHoldArn()	The Amazon Resource Name (ARN) of the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String	legalHoldId()	The ID of the legal hold.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends LegalHold.Builder>	serializableBuilderClass()
LegalHoldStatus	status()	The status of the legal hold.
String	statusAsString()	The status of the legal hold.
String	title()	The title of a legal hold.
LegalHold.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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()

The title of a legal hold.

Returns:

The title of a legal hold.

status

public final LegalHoldStatus status()

The status of the legal hold.

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:

The status of the legal hold.

See Also:

LegalHoldStatus

statusAsString

public final String statusAsString()

The status of the legal hold.

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:

The status of the legal hold.

See Also:

LegalHoldStatus

description

public final String description()

The description of a legal hold.

Returns:

The description of a legal hold.

legalHoldId

public final String legalHoldId()

The ID of the legal hold.

Returns:

The ID of the legal hold.

legalHoldArn

public final String legalHoldArn()

The Amazon Resource Name (ARN) of the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Returns:

The Amazon Resource Name (ARN) of the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

creationDate

public final Instant creationDate()

The time when the legal hold was created.

Returns:

The time when the legal hold was created.

cancellationDate

public final Instant cancellationDate()

The time when the legal hold was cancelled.

Returns:

The time when the legal hold was cancelled.

toBuilder

public LegalHold.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LegalHold.Builder,LegalHold>

builder

public static LegalHold.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo