Class CreateTapeWithBarcodeRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateTapeWithBarcodeRequest.Builder,
CreateTapeWithBarcodeRequest>
CreateTapeWithBarcodeInput
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Boolean
Set totrue
to use Amazon S3 server-side encryption with your own KMS key, orfalse
to use a key managed by Amazon S3.final String
kmsKey()
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.final String
poolId()
The ID of the pool that you want to add your tape to for archiving.static Class
<? extends CreateTapeWithBarcodeRequest.Builder> tags()
A list of up to 50 tags that can be assigned to a virtual tape that has a barcode.final String
The barcode that you want to assign to the tape.final Long
The size, in bytes, of the virtual tape that you want to create.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
worm()
Set toTRUE
if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 Amazon Web Services 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 Amazon Web Services Region.
-
tapeSizeInBytes
The size, in bytes, of the virtual tape that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
- Returns:
- The size, in bytes, of the virtual tape that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
-
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
Set to
true
to use Amazon S3 server-side encryption with your own KMS key, orfalse
to use a key managed by Amazon S3. Optional.Valid Values:
true
|false
- Returns:
- Set to
true
to use Amazon S3 server-side encryption with your own KMS key, orfalse
to use a key managed by Amazon S3. Optional.Valid Values:
true
|false
-
kmsKey
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when
KMSEncrypted
istrue
. Optional.- Returns:
- The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when
KMSEncrypted
istrue
. Optional.
-
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 (S3 Glacier or S3 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 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 Deep Archive) that corresponds to the pool.
-
worm
Set to
TRUE
if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.- Returns:
- Set to
TRUE
if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- 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
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 interfaceToCopyableBuilder<CreateTapeWithBarcodeRequest.Builder,
CreateTapeWithBarcodeRequest> - Specified by:
toBuilder
in classStorageGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-