Class DescribeBackupAccessPointResponse

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.DescribeBackupAccessPointResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeBackupAccessPointResponse.Builder,DescribeBackupAccessPointResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeBackupAccessPointResponse extends BackupResponse implements ToCopyableBuilder<DescribeBackupAccessPointResponse.Builder,DescribeBackupAccessPointResponse>

  • Method Details

    • accessPointArn

      public final String accessPointArn()

      The Amazon Resource Name (ARN) that uniquely identifies the backup access point.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the backup access point.

    • hasAccessPointMetadata

      public final boolean hasAccessPointMetadata()
      For responses, this returns true if the service returned a value for the AccessPointMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • accessPointMetadata

      public final Map<String,String> accessPointMetadata()

      Metadata for the backup access point. After the backup access point reaches the AVAILABLE status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccessPointMetadata() method.

      Returns:
      Metadata for the backup access point. After the backup access point reaches the AVAILABLE status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time.

    • backupVaultArn

      public final String backupVaultArn()

      The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.

      Returns:
      The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.

    • backupVaultName

      public final String backupVaultName()

      The name of the backup vault that contains the recovery point.

      Returns:
      The name of the backup vault that contains the recovery point.

    • creationTime

      public final Instant creationTime()

      The date and time that the backup access point was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime 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 the backup access point was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • name

      public final String name()

      The name of the backup access point.

      Returns:
      The name of the backup access point.

    • recoveryPointArn

      public final String recoveryPointArn()

      The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.

      Returns:
      The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.

      Returns:
      The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.

    • resourceType

      public final String resourceType()

      The type of Amazon Web Services resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.

      Returns:
      The type of Amazon Web Services resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.

    • status

      public final AccessPointStatus status()

      The current status of the backup access point.

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

      Returns:
      The current status of the backup access point.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the backup access point.

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

      Returns:
      The current status of the backup access point.
      See Also:

    • statusMessage

      public final String statusMessage()

      A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.

      Returns:
      A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.

    • toBuilder

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

    • builder

      public static DescribeBackupAccessPointResponse.Builder builder()

    • serializableBuilderClass

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