CreateTapesRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.storagegateway.model.CreateTapesRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateTapesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

CreateTapesInput

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateTapesRequest()

Constructors
Constructor and Description
`CreateTapesRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateTapesRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getClientToken()` A unique identifier that you use to retry a request.
`String`	`getGatewayARN()` The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with.
`Boolean`	`getKMSEncrypted()` True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`String`	`getKMSKey()` The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
`Integer`	`getNumTapesToCreate()` The number of virtual tapes that you want to create.
`String`	`getPoolId()` The ID of the pool that you want to add your tape to for archiving.
`List<Tag>`	`getTags()` A list of up to 50 tags that can be assigned to a virtual tape.
`String`	`getTapeBarcodePrefix()` A prefix that you append to the barcode of the virtual tape you are creating.
`Long`	`getTapeSizeInBytes()` The size, in bytes, of the virtual tapes that you want to create.
`int`	`hashCode()`
`Boolean`	`isKMSEncrypted()` True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`void`	`setClientToken(String clientToken)` A unique identifier that you use to retry a request.
`void`	`setGatewayARN(String gatewayARN)` The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with.
`void`	`setKMSEncrypted(Boolean kMSEncrypted)` True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`void`	`setKMSKey(String kMSKey)` The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
`void`	`setNumTapesToCreate(Integer numTapesToCreate)` The number of virtual tapes that you want to create.
`void`	`setPoolId(String poolId)` The ID of the pool that you want to add your tape to for archiving.
`void`	`setTags(Collection<Tag> tags)` A list of up to 50 tags that can be assigned to a virtual tape.
`void`	`setTapeBarcodePrefix(String tapeBarcodePrefix)` A prefix that you append to the barcode of the virtual tape you are creating.
`void`	`setTapeSizeInBytes(Long tapeSizeInBytes)` The size, in bytes, of the virtual tapes that you want to create.
`String`	`toString()` Returns a string representation of this object.
`CreateTapesRequest`	`withClientToken(String clientToken)` A unique identifier that you use to retry a request.
`CreateTapesRequest`	`withGatewayARN(String gatewayARN)` The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with.
`CreateTapesRequest`	`withKMSEncrypted(Boolean kMSEncrypted)` True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`CreateTapesRequest`	`withKMSKey(String kMSKey)` The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
`CreateTapesRequest`	`withNumTapesToCreate(Integer numTapesToCreate)` The number of virtual tapes that you want to create.
`CreateTapesRequest`	`withPoolId(String poolId)` The ID of the pool that you want to add your tape to for archiving.
`CreateTapesRequest`	`withTags(Collection<Tag> tags)` A list of up to 50 tags that can be assigned to a virtual tape.
`CreateTapesRequest`	`withTags(Tag... tags)` A list of up to 50 tags that can be assigned to a virtual tape.
`CreateTapesRequest`	`withTapeBarcodePrefix(String tapeBarcodePrefix)` A prefix that you append to the barcode of the virtual tape you are creating.
`CreateTapesRequest`	`withTapeSizeInBytes(Long tapeSizeInBytes)` The size, in bytes, of the virtual tapes that you want to create.

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

- Constructor Detail
  - CreateTapesRequest
```
public CreateTapesRequest()
```
- Method Detail
  - setGatewayARN
```
public void setGatewayARN(String gatewayARN)
```
    The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
    
    Parameters:
    
    gatewayARN - The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
  - getGatewayARN
```
public String getGatewayARN()
```
    The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
    
    Returns:
    
    The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
  - withGatewayARN
```
public CreateTapesRequest withGatewayARN(String gatewayARN)
```
    The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
    
    Parameters:
    
    gatewayARN - The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
    
    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 tapes that you want to create.
    
    The size must be aligned by gigabyte (1024*1024*1024 byte).
    
    Parameters:
    
    tapeSizeInBytes - The size, in bytes, of the virtual tapes that you want to create.
    
    The size must be aligned by gigabyte (1024*1024*1024 byte).
  - getTapeSizeInBytes
```
public Long getTapeSizeInBytes()
```
    The size, in bytes, of the virtual tapes that you want to create.
    
    The size must be aligned by gigabyte (1024*1024*1024 byte).
    
    Returns:
    
    The size, in bytes, of the virtual tapes that you want to create.
    
    The size must be aligned by gigabyte (1024*1024*1024 byte).
  - withTapeSizeInBytes
```
public CreateTapesRequest withTapeSizeInBytes(Long tapeSizeInBytes)
```
    The size, in bytes, of the virtual tapes that you want to create.
    
    The size must be aligned by gigabyte (1024*1024*1024 byte).
    
    Parameters:
    
    tapeSizeInBytes - The size, in bytes, of the virtual tapes that you want to create.
    
    The size must be aligned by gigabyte (1024*1024*1024 byte).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientToken
```
public void setClientToken(String clientToken)
```
    A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
    
    Using the same ClientToken prevents creating the tape multiple times.
    
    Parameters:
    
    clientToken - A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
    
    Using the same ClientToken prevents creating the tape multiple times.
  - getClientToken
```
public String getClientToken()
```
    A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
    
    Using the same ClientToken prevents creating the tape multiple times.
    
    Returns:
    
    A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
    
    Using the same ClientToken prevents creating the tape multiple times.
  - withClientToken
```
public CreateTapesRequest withClientToken(String clientToken)
```
    A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
    
    Using the same ClientToken prevents creating the tape multiple times.
    
    Parameters:
    
    clientToken - A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
    
    Using the same ClientToken prevents creating the tape multiple times.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumTapesToCreate
```
public void setNumTapesToCreate(Integer numTapesToCreate)
```
    The number of virtual tapes that you want to create.
    
    Parameters:
    
    numTapesToCreate - The number of virtual tapes that you want to create.
  - getNumTapesToCreate
```
public Integer getNumTapesToCreate()
```
    The number of virtual tapes that you want to create.
    
    Returns:
    
    The number of virtual tapes that you want to create.
  - withNumTapesToCreate
```
public CreateTapesRequest withNumTapesToCreate(Integer numTapesToCreate)
```
    The number of virtual tapes that you want to create.
    
    Parameters:
    
    numTapesToCreate - The number of virtual tapes that you want to create.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTapeBarcodePrefix
```
public void setTapeBarcodePrefix(String tapeBarcodePrefix)
```
    A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.
    
    The prefix must be 1 to 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 you are creating. This prefix makes the barcode unique.
    
    The prefix must be 1 to 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 you are creating. This prefix makes the barcode unique.
    
    The prefix must be 1 to 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 you are creating. This prefix makes the barcode unique.
    
    The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z.
  - withTapeBarcodePrefix
```
public CreateTapesRequest withTapeBarcodePrefix(String tapeBarcodePrefix)
```
    A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.
    
    The prefix must be 1 to 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 you are creating. This prefix makes the barcode unique.
    
    The prefix must be 1 to 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.
  - setKMSEncrypted
```
public void setKMSEncrypted(Boolean kMSEncrypted)
```
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Parameters:
    
    kMSEncrypted - True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
  - getKMSEncrypted
```
public Boolean getKMSEncrypted()
```
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Returns:
    
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
  - withKMSEncrypted
```
public CreateTapesRequest withKMSEncrypted(Boolean kMSEncrypted)
```
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Parameters:
    
    kMSEncrypted - True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isKMSEncrypted
```
public Boolean isKMSEncrypted()
```
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Returns:
    
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
  - setKMSKey
```
public void setKMSKey(String kMSKey)
```
    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
    
    Parameters:
    
    kMSKey - The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
  - getKMSKey
```
public String getKMSKey()
```
    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
  - withKMSKey
```
public CreateTapesRequest withKMSKey(String kMSKey)
```
    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
    
    Parameters:
    
    kMSKey - The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
    
    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 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 (Glacier or Deep Archive) that corresponds to the pool.
    
    Valid values: "GLACIER", "DEEP_ARCHIVE"
    
    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 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 (Glacier or Deep Archive) that corresponds to the pool.
    
    Valid values: "GLACIER", "DEEP_ARCHIVE"
  - 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 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 (Glacier or 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 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 (Glacier or Deep Archive) that corresponds to the pool.
    
    Valid values: "GLACIER", "DEEP_ARCHIVE"
  - withPoolId
```
public CreateTapesRequest 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 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 (Glacier or Deep Archive) that corresponds to the pool.
    
    Valid values: "GLACIER", "DEEP_ARCHIVE"
    
    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 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 (Glacier or Deep Archive) that corresponds to the pool.
    
    Valid values: "GLACIER", "DEEP_ARCHIVE"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    Returns:
    
    A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    Parameters:
    
    tags - A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
  - withTags
```
public CreateTapesRequest withTags(Tag... tags)
```
    A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateTapesRequest withTags(Collection<Tag> tags)
```
    A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    Parameters:
    
    tags - A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 CreateTapesRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateTapesRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateTapesRequest

Method Detail

setGatewayARN

getGatewayARN

withGatewayARN

setTapeSizeInBytes

getTapeSizeInBytes

withTapeSizeInBytes

setClientToken

getClientToken

withClientToken

setNumTapesToCreate

getNumTapesToCreate

withNumTapesToCreate

setTapeBarcodePrefix

getTapeBarcodePrefix

withTapeBarcodePrefix

setKMSEncrypted

getKMSEncrypted

withKMSEncrypted

isKMSEncrypted

setKMSKey

getKMSKey

withKMSKey

setPoolId

getPoolId

withPoolId

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone