Class IndexedRecoveryPoint

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

This is a recovery point that has an associated backup index.

Only recovery points with a backup index can be included in a search.

See Also:

  • Method Details

    • recoveryPointArn

      public final String recoveryPointArn()

      An 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 ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45

    • sourceResourceArn

      public final String sourceResourceArn()

      A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.

      Returns:
      A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.

    • iamRoleArn

      public final String iamRoleArn()

      This specifies the IAM role ARN used for this operation.

      For example, arn:aws:iam::123456789012:role/S3Access

      Returns:
      This specifies the IAM role ARN used for this operation.

      For example, arn:aws:iam::123456789012:role/S3Access

    • backupCreationDate

      public final Instant backupCreationDate()

      The date and time that a backup was 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 that a backup was 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.

    • resourceType

      public final String resourceType()

      The resource type of the indexed recovery point.

      • EBS for Amazon Elastic Block Store

      • S3 for Amazon Simple Storage Service (Amazon S3)

      Returns:
      The resource type of the indexed recovery point.

      • EBS for Amazon Elastic Block Store

      • S3 for Amazon Simple Storage Service (Amazon S3)

    • indexCreationDate

      public final Instant indexCreationDate()

      The date and time that a backup index was 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 that a backup index was 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.

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

    • backupVaultArn

      public final String backupVaultArn()

      An ARN that uniquely identifies the backup vault where the recovery point index is stored.

      For example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

      Returns:
      An ARN that uniquely identifies the backup vault where the recovery point index is stored.

      For example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    • toBuilder

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

    • builder

      public static IndexedRecoveryPoint.Builder builder()

    • serializableBuilderClass

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