com.amazonaws.services.storagegateway.model

Class CreateTapeWithBarcodeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.CreateTapeWithBarcodeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

CreateTapeWithBarcodeInput

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateTapeWithBarcodeRequest()

Method Summary

Modifier and Type	Method and Description
CreateTapeWithBarcodeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getGatewayARN() The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape 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.
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 that has a barcode.
String	getTapeBarcode() The barcode that you want to assign to the tape.
Long	getTapeSizeInBytes() The size, in bytes, of the virtual tape 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	setGatewayARN(String gatewayARN) The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape 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	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 that has a barcode.
void	setTapeBarcode(String tapeBarcode) The barcode that you want to assign to the tape.
void	setTapeSizeInBytes(Long tapeSizeInBytes) The size, in bytes, of the virtual tape that you want to create.
String	toString() Returns a string representation of this object.
CreateTapeWithBarcodeRequest	withGatewayARN(String gatewayARN) The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with.
CreateTapeWithBarcodeRequest	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.
CreateTapeWithBarcodeRequest	withKMSKey(String kMSKey) The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption.
CreateTapeWithBarcodeRequest	withPoolId(String poolId) The ID of the pool that you want to add your tape to for archiving.
CreateTapeWithBarcodeRequest	withTags(Collection<Tag> tags) A list of up to 50 tags that can be assigned to a virtual tape that has a barcode.
CreateTapeWithBarcodeRequest	withTags(Tag... tags) A list of up to 50 tags that can be assigned to a virtual tape that has a barcode.
CreateTapeWithBarcodeRequest	withTapeBarcode(String tapeBarcode) The barcode that you want to assign to the tape.
CreateTapeWithBarcodeRequest	withTapeSizeInBytes(Long tapeSizeInBytes) The size, in bytes, of the virtual tape that you want to create.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTapeWithBarcodeRequest

public CreateTapeWithBarcodeRequest()

Method Detail

setGatewayARN

public void setGatewayARN(String gatewayARN)

The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape 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 tape 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 tape 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 tape with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

withGatewayARN

public CreateTapeWithBarcodeRequest withGatewayARN(String gatewayARN)

The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape 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 tape 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 tape 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 tape 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 tape that you want to create.

The size must be aligned by gigabyte (1024*1024*1024 byte).

Returns:

The size, in bytes, of the virtual tape that you want to create.

The size must be aligned by gigabyte (1024*1024*1024 byte).

withTapeSizeInBytes

public CreateTapeWithBarcodeRequest withTapeSizeInBytes(Long tapeSizeInBytes)

The size, in bytes, of the virtual tape 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 tape 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.

setTapeBarcode

public void setTapeBarcode(String tapeBarcode)

The barcode that you want to assign to the tape.

Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

Parameters:

tapeBarcode - The barcode that you want to assign to the tape.

Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

getTapeBarcode

public String getTapeBarcode()

The barcode that you want to assign to the tape.

Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

Returns:

The barcode that you want to assign to the tape.

Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

withTapeBarcode

public CreateTapeWithBarcodeRequest withTapeBarcode(String tapeBarcode)

The barcode that you want to assign to the tape.

Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

Parameters:

tapeBarcode - The barcode that you want to assign to the tape.

Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

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 CreateTapeWithBarcodeRequest 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 CreateTapeWithBarcodeRequest 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 CreateTapeWithBarcodeRequest 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 that has a barcode. 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 that has a barcode. 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 that has a barcode. 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 that has a barcode. 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 CreateTapeWithBarcodeRequest withTags(Tag... tags)

A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. 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 that has a barcode. 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 CreateTapeWithBarcodeRequest withTags(Collection<Tag> tags)

A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. 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 that has a barcode. 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 CreateTapeWithBarcodeRequest 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()