software.amazon.awssdk.services.storagegateway.model

Class CreateTapeWithBarcodeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest

software.amazon.awssdk.services.storagegateway.model.CreateTapeWithBarcodeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTapeWithBarcodeRequest.Builder,CreateTapeWithBarcodeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTapeWithBarcodeRequest
extends StorageGatewayRequest
implements ToCopyableBuilder<CreateTapeWithBarcodeRequest.Builder,CreateTapeWithBarcodeRequest>

CreateTapeWithBarcodeInput

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTapeWithBarcodeRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateTapeWithBarcodeRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gatewayARN() The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
String	kmsKey() The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption.
String	poolId() The ID of the pool that you want to add your tape to for archiving.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTapeWithBarcodeRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of up to 50 tags that can be assigned to a virtual tape that has a barcode.
String	tapeBarcode() The barcode that you want to assign to the tape.
Long	tapeSizeInBytes() The size, in bytes, of the virtual tape that you want to create.
CreateTapeWithBarcodeRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

gatewayARN

public 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.

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.

tapeSizeInBytes

public 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).

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).

tapeBarcode

public 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.

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.

kmsEncrypted

public 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.

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.

kmsKey

public 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.

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.

poolId

public 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"

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"

tags

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

toBuilder

public CreateTapeWithBarcodeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTapeWithBarcodeRequest.Builder,CreateTapeWithBarcodeRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static CreateTapeWithBarcodeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateTapeWithBarcodeRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo