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>

  • Method Details

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

    • 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 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()
      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<GetLegalHoldResponse.Builder,GetLegalHoldResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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