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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PoolInfo.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PoolInfo.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`poolARN()`	The Amazon Resource Name (ARN) of the custom tape pool.
`String`	`poolName()`	The name of the custom tape pool.
`PoolStatus`	`poolStatus()`	Status of the custom tape pool.
`String`	`poolStatusAsString()`	Status of the custom tape pool.
`Integer`	`retentionLockTimeInDays()`	Tape retention lock time is set in days.
`RetentionLockType`	`retentionLockType()`	Tape retention lock type, which can be configured in two modes.
`String`	`retentionLockTypeAsString()`	Tape retention lock type, which can be configured in two modes.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PoolInfo.Builder>`	`serializableBuilderClass()`
`TapeStorageClass`	`storageClass()`	The storage class that is associated with the custom pool.
`String`	`storageClassAsString()`	The storage class that is associated with the custom pool.
`PoolInfo.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    TapeStorageClass
  - 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:
    
    TapeStorageClass
  - 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:
    
    RetentionLockType
  - 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:
    
    RetentionLockType
  - 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:
    
    PoolStatus
  - 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:
    
    PoolStatus
  - toBuilder
```
public PoolInfo.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PoolInfo.Builder,PoolInfo>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class PoolInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

poolARN

poolName

storageClass

storageClassAsString

retentionLockType

retentionLockTypeAsString

retentionLockTimeInDays

poolStatus

poolStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields