software.amazon.awssdk.services.storagegateway.model

Class AutomaticTapeCreationRule

java.lang.Object

software.amazon.awssdk.services.storagegateway.model.AutomaticTapeCreationRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutomaticTapeCreationRule.Builder,AutomaticTapeCreationRule>

@Generated(value="software.amazon.awssdk:codegen")
public final class AutomaticTapeCreationRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AutomaticTapeCreationRule.Builder,AutomaticTapeCreationRule>

An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AutomaticTapeCreationRule.Builder

Method Summary

Modifier and Type	Method and Description
static AutomaticTapeCreationRule.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()
Integer	minimumNumTapes() The minimum number of available virtual tapes that the gateway maintains at all times.
String	poolId() The ID of the pool that you want to add your tape to for archiving.
List<SdkField<?>>	sdkFields()
static Class<? extends AutomaticTapeCreationRule.Builder>	serializableBuilderClass()
String	tapeBarcodePrefix() A prefix that you append to the barcode of the virtual tape that you are creating.
Long	tapeSizeInBytes() The size, in bytes, of the virtual tape capacity.
AutomaticTapeCreationRule.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.
Boolean	worm() Set to true to indicate that tapes are to be archived as write-once-read-many (WORM).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

tapeBarcodePrefix

public final String tapeBarcodePrefix()

A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.

The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.

Returns:

A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.

The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.

poolId

public final String poolId()

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the 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.

Valid Values: GLACIER | DEEP_ARCHIVE

Returns:

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the 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.

Valid Values: GLACIER | DEEP_ARCHIVE

tapeSizeInBytes

public final Long tapeSizeInBytes()

The size, in bytes, of the virtual tape capacity.

Returns:

The size, in bytes, of the virtual tape capacity.

minimumNumTapes

public final Integer minimumNumTapes()

The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway. For more information about automatic tape creation, see Creating Tapes Automatically.

Returns:

The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway. For more information about automatic tape creation, see Creating Tapes Automatically.

worm

public final Boolean worm()

Set to true to indicate that tapes are to be archived as write-once-read-many (WORM). Set to false when WORM is not enabled for tapes.

Returns:

Set to true to indicate that tapes are to be archived as write-once-read-many (WORM). Set to false when WORM is not enabled for tapes.

toBuilder

public AutomaticTapeCreationRule.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<AutomaticTapeCreationRule.Builder,AutomaticTapeCreationRule>

Returns:

a builder for type T

builder

public static AutomaticTapeCreationRule.Builder builder()

serializableBuilderClass

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