Class PoolInfo

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

Describes a custom tape pool.

See Also:

  • Method Details

    • poolARN

      public final String poolARN()

      The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and Amazon Web Services Region.

      Returns:
      The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and Amazon Web Services Region.

    • poolName

      public final String poolName()

      The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

      Returns:
      The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

    • storageClass

      public final TapeStorageClass storageClass()

      The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

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

      Returns:
      The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
      See Also:

    • storageClassAsString

      public final String storageClassAsString()

      The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

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

      Returns:
      The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
      See Also:

    • retentionLockType

      public final RetentionLockType retentionLockType()

      Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.

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

      Returns:
      Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
      See Also:

    • retentionLockTypeAsString

      public final String retentionLockTypeAsString()

      Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.

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

      Returns:
      Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
      See Also:

    • retentionLockTimeInDays

      public final Integer retentionLockTimeInDays()

      Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

      Returns:
      Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

    • poolStatus

      public final PoolStatus poolStatus()

      Status of the custom tape pool. Pool can be ACTIVE or DELETED.

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

      Returns:
      Status of the custom tape pool. Pool can be ACTIVE or DELETED.
      See Also:

    • poolStatusAsString

      public final String poolStatusAsString()

      Status of the custom tape pool. Pool can be ACTIVE or DELETED.

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

      Returns:
      Status of the custom tape pool. Pool can be ACTIVE or DELETED.
      See Also:

    • toBuilder

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

    • builder

      public static PoolInfo.Builder builder()

    • serializableBuilderClass

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