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

      The title of the legal hold.

      Returns:
      The title of the 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:

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

    • description

      public final String description()

      The description of the legal hold.

      Returns:
      The description of the legal hold.

    • cancelDescription

      public final String cancelDescription()

      The reason for removing the legal hold.

      Returns:
      The reason for removing the 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 framework ARN for the specified legal hold. The format of the ARN depends on the resource type.

      Returns:
      The framework ARN for the specified legal hold. The format of the ARN depends on the resource type.

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

    • retainRecordUntil

      public final Instant retainRecordUntil()

      The date and time until which the legal hold record is retained.

      Returns:
      The date and time until which the legal hold record is retained.

    • recoveryPointSelection

      public final RecoveryPointSelection recoveryPointSelection()

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

      Returns:
      The 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.