@Generated(value="software.amazon.awssdk:codegen") public final class PoolInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PoolInfo.Builder,PoolInfo>
Describes a custom tape pool.
Modifier and Type | Class and Description |
---|---|
static interface |
PoolInfo.Builder |
Modifier and Type | Method and Description |
---|---|
static PoolInfo.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
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 AWS Region.
public final String poolName()
The name of the custom tape pool. PoolName
can use all ASCII characters, except '/' and '\'.
PoolName
can use all ASCII characters, except '/' and '\'.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()
.
TapeStorageClass
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()
.
TapeStorageClass
public final RetentionLockType retentionLockType()
Tape retention lock type, which can be configured in two modes. When configured in governance mode, AWS 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 AWS 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()
.
RetentionLockType
public final String retentionLockTypeAsString()
Tape retention lock type, which can be configured in two modes. When configured in governance mode, AWS 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 AWS 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()
.
RetentionLockType
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).
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()
.
ACTIVE
or DELETED
.PoolStatus
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()
.
ACTIVE
or DELETED
.PoolStatus
public PoolInfo.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PoolInfo.Builder,PoolInfo>
public static PoolInfo.Builder builder()
public static Class<? extends PoolInfo.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.