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:

  • Method Details

    • title

      public final String title()

      This is the title of a legal hold.

      Returns:
      This is the title of a 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:

    • 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:

    • description

      public final String description()

      This is the description of a legal hold.

      Returns:
      This is the description of a legal hold.

    • legalHoldId

      public final String legalHoldId()

      ID of specific legal hold on one or more recovery points.

      Returns:
      ID of specific legal hold on one or more recovery points.

    • legalHoldArn

      public final String legalHoldArn()

      This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      Returns:
      This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • creationDate

      public final Instant creationDate()

      This is the time in number format when legal hold was created.

      Returns:
      This is the time in number format when legal hold was created.

    • cancellationDate

      public final Instant cancellationDate()

      This is the time in number format when legal hold was cancelled.

      Returns:
      This is the time in number format when legal hold was cancelled.

    • toBuilder

      public LegalHold.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LegalHold.Builder,LegalHold>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.