AutomaticTapeCreationRule (AWS Java SDK for AWS Storage Gateway 1.12.285 API)

java.lang.Object
- com.amazonaws.services.storagegateway.model.AutomaticTapeCreationRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AutomaticTapeCreationRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AutomaticTapeCreationRule()

Constructors
Constructor and Description
`AutomaticTapeCreationRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AutomaticTapeCreationRule`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getMinimumNumTapes()` The minimum number of available virtual tapes that the gateway maintains at all times.
`String`	`getPoolId()` The ID of the pool that you want to add your tape to for archiving.
`String`	`getTapeBarcodePrefix()` A prefix that you append to the barcode of the virtual tape that you are creating.
`Long`	`getTapeSizeInBytes()` The size, in bytes, of the virtual tape capacity.
`Boolean`	`getWorm()` Set to `true` to indicate that tapes are to be archived as write-once-read-many (WORM).
`int`	`hashCode()`
`Boolean`	`isWorm()` Set to `true` to indicate that tapes are to be archived as write-once-read-many (WORM).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setMinimumNumTapes(Integer minimumNumTapes)` The minimum number of available virtual tapes that the gateway maintains at all times.
`void`	`setPoolId(String poolId)` The ID of the pool that you want to add your tape to for archiving.
`void`	`setTapeBarcodePrefix(String tapeBarcodePrefix)` A prefix that you append to the barcode of the virtual tape that you are creating.
`void`	`setTapeSizeInBytes(Long tapeSizeInBytes)` The size, in bytes, of the virtual tape capacity.
`void`	`setWorm(Boolean worm)` Set to `true` to indicate that tapes are to be archived as write-once-read-many (WORM).
`String`	`toString()` Returns a string representation of this object.
`AutomaticTapeCreationRule`	`withMinimumNumTapes(Integer minimumNumTapes)` The minimum number of available virtual tapes that the gateway maintains at all times.
`AutomaticTapeCreationRule`	`withPoolId(String poolId)` The ID of the pool that you want to add your tape to for archiving.
`AutomaticTapeCreationRule`	`withTapeBarcodePrefix(String tapeBarcodePrefix)` A prefix that you append to the barcode of the virtual tape that you are creating.
`AutomaticTapeCreationRule`	`withTapeSizeInBytes(Long tapeSizeInBytes)` The size, in bytes, of the virtual tape capacity.
`AutomaticTapeCreationRule`	`withWorm(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
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AutomaticTapeCreationRule
```
public AutomaticTapeCreationRule()
```
- Method Detail
  - setTapeBarcodePrefix
```
public void setTapeBarcodePrefix(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.
    
    Parameters:
    
    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.
  - getTapeBarcodePrefix
```
public String getTapeBarcodePrefix()
```
    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.
  - withTapeBarcodePrefix
```
public AutomaticTapeCreationRule withTapeBarcodePrefix(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPoolId
```
public void setPoolId(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.
    
    Parameters:
    
    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.
  - getPoolId
```
public String getPoolId()
```
    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.
    
    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.
  - withPoolId
```
public AutomaticTapeCreationRule withPoolId(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTapeSizeInBytes
```
public void setTapeSizeInBytes(Long tapeSizeInBytes)
```
    The size, in bytes, of the virtual tape capacity.
    
    Parameters:
    
    tapeSizeInBytes - The size, in bytes, of the virtual tape capacity.
  - getTapeSizeInBytes
```
public Long getTapeSizeInBytes()
```
    The size, in bytes, of the virtual tape capacity.
    
    Returns:
    
    The size, in bytes, of the virtual tape capacity.
  - withTapeSizeInBytes
```
public AutomaticTapeCreationRule withTapeSizeInBytes(Long tapeSizeInBytes)
```
    The size, in bytes, of the virtual tape capacity.
    
    Parameters:
    
    tapeSizeInBytes - The size, in bytes, of the virtual tape capacity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinimumNumTapes
```
public void setMinimumNumTapes(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.
    
    Parameters:
    
    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.
  - getMinimumNumTapes
```
public Integer getMinimumNumTapes()
```
    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.
  - withMinimumNumTapes
```
public AutomaticTapeCreationRule withMinimumNumTapes(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorm
```
public void setWorm(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.
    
    Parameters:
    
    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.
  - getWorm
```
public Boolean getWorm()
```
    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.
  - withWorm
```
public AutomaticTapeCreationRule withWorm(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isWorm
```
public Boolean isWorm()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AutomaticTapeCreationRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class AutomaticTapeCreationRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AutomaticTapeCreationRule

Method Detail

setTapeBarcodePrefix

getTapeBarcodePrefix

withTapeBarcodePrefix

setPoolId

getPoolId

withPoolId

setTapeSizeInBytes

getTapeSizeInBytes

withTapeSizeInBytes

setMinimumNumTapes

getMinimumNumTapes

withMinimumNumTapes

setWorm

getWorm

withWorm

isWorm

toString

equals

hashCode

clone

marshall