Class RecoveryPointByResource

java.lang.Object
software.amazon.awssdk.services.backup.model.RecoveryPointByResource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RecoveryPointByResource.Builder,RecoveryPointByResource>
@Generated("software.amazon.awssdk:codegen") public final class RecoveryPointByResource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RecoveryPointByResource.Builder,RecoveryPointByResource>

Contains detailed information about a saved recovery point.

See Also:

  • Method Details

    • recoveryPointArn

      public final String recoveryPointArn()

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      Returns:
      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • creationDate

      public final Instant creationDate()

      The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Returns:
      The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • status

      public final RecoveryPointStatus status()

      A status code specifying the state of the recovery point.

      If the service returns an enum value that is not available in the current SDK version, status will return RecoveryPointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      A status code specifying the state of the recovery point.
      See Also:

    • statusAsString

      public final String statusAsString()

      A status code specifying the state of the recovery point.

      If the service returns an enum value that is not available in the current SDK version, status will return RecoveryPointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      A status code specifying the state of the recovery point.
      See Also:

    • statusMessage

      public final String statusMessage()

      A message explaining the current status of the recovery point.

      Returns:
      A message explaining the current status of the recovery point.

    • encryptionKeyArn

      public final String encryptionKeyArn()

      The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      Returns:
      The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    • backupSizeBytes

      public final Long backupSizeBytes()

      The size, in bytes, of a backup.

      Returns:
      The size, in bytes, of a backup.

    • backupVaultName

      public final String backupVaultName()

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

      Returns:
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

    • isParent

      public final Boolean isParent()

      This is a boolean value indicating this is a parent (composite) recovery point.

      Returns:
      This is a boolean value indicating this is a parent (composite) recovery point.

    • parentRecoveryPointArn

      public final String parentRecoveryPointArn()

      The Amazon Resource Name (ARN) of the parent (composite) recovery point.

      Returns:
      The Amazon Resource Name (ARN) of the parent (composite) recovery point.

    • resourceName

      public final String resourceName()

      The non-unique name of the resource that belongs to the specified backup.

      Returns:
      The non-unique name of the resource that belongs to the specified backup.

    • vaultType

      public final VaultType vaultType()

      The type of vault in which the described recovery point is stored.

      If the service returns an enum value that is not available in the current SDK version, vaultType will return VaultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vaultTypeAsString().

      Returns:
      The type of vault in which the described recovery point is stored.
      See Also:

    • vaultTypeAsString

      public final String vaultTypeAsString()

      The type of vault in which the described recovery point is stored.

      If the service returns an enum value that is not available in the current SDK version, vaultType will return VaultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vaultTypeAsString().

      Returns:
      The type of vault in which the described recovery point is stored.
      See Also:

    • indexStatus

      public final IndexStatus indexStatus()

      This is the current status for the backup index associated with the specified recovery point.

      Statuses are: PENDING | ACTIVE | FAILED | DELETING

      A recovery point with an index that has the status of ACTIVE can be included in a search.

      If the service returns an enum value that is not available in the current SDK version, indexStatus will return IndexStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexStatusAsString().

      Returns:
      This is the current status for the backup index associated with the specified recovery point.

      Statuses are: PENDING | ACTIVE | FAILED | DELETING

      A recovery point with an index that has the status of ACTIVE can be included in a search.

      See Also:

    • indexStatusAsString

      public final String indexStatusAsString()

      This is the current status for the backup index associated with the specified recovery point.

      Statuses are: PENDING | ACTIVE | FAILED | DELETING

      A recovery point with an index that has the status of ACTIVE can be included in a search.

      If the service returns an enum value that is not available in the current SDK version, indexStatus will return IndexStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexStatusAsString().

      Returns:
      This is the current status for the backup index associated with the specified recovery point.

      Statuses are: PENDING | ACTIVE | FAILED | DELETING

      A recovery point with an index that has the status of ACTIVE can be included in a search.

      See Also:

    • indexStatusMessage

      public final String indexStatusMessage()

      A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.

      Returns:
      A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.

    • toBuilder

      public RecoveryPointByResource.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<RecoveryPointByResource.Builder,RecoveryPointByResource>
      Returns:
      a builder for type T

    • builder

      public static RecoveryPointByResource.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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