CreateCachediScsiVolumeRequest (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateCachediScsiVolumeRequest.Builder,CreateCachediScsiVolumeRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateCachediScsiVolumeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateCachediScsiVolumeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateCachediScsiVolumeRequest.Builder`	`builder()`
`String`	`clientToken()` A unique identifier that you use to retry a request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`gatewayARN()` Returns the value of the GatewayARN property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`Boolean`	`kmsEncrypted()` Set to `true` to use Amazon S3 server-side encryption with your own KMS key, or `false` to use a key managed by Amazon S3.
`String`	`kmsKey()` The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
`String`	`networkInterfaceId()` The network interface of the gateway on which to expose the iSCSI target.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateCachediScsiVolumeRequest.Builder>`	`serializableBuilderClass()`
`String`	`snapshotId()` The snapshot ID (e.g.
`String`	`sourceVolumeARN()` The ARN for an existing volume.
`List<Tag>`	`tags()` A list of up to 50 tags that you can assign to a cached volume.
`String`	`targetName()` The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
`CreateCachediScsiVolumeRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Long`	`volumeSizeInBytes()` The size of the volume in bytes.

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 final String gatewayARN()
```
    Returns the value of the GatewayARN property for this object.
    
    Returns:
    
    The value of the GatewayARN property for this object.
  - volumeSizeInBytes
```
public final Long volumeSizeInBytes()
```
    The size of the volume in bytes.
    
    Returns:
    
    The size of the volume in bytes.
  - snapshotId
```
public final String snapshotId()
```
    The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
    
    Returns:
    
    The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
  - targetName
```
public final String targetName()
```
    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.
    
    If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
    
    Returns:
    
    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.
    
    If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
  - sourceVolumeARN
```
public final String sourceVolumeARN()
```
    The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.
    
    Returns:
    
    The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.
  - networkInterfaceId
```
public final String networkInterfaceId()
```
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
    
    Valid Values: A valid IP address.
    
    Returns:
    
    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
    
    Valid Values: A valid IP address.
  - clientToken
```
public final 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.
    
    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.
  - kmsEncrypted
```
public final Boolean kmsEncrypted()
```
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false 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, or false to use a key managed by Amazon S3. Optional.
    
    Valid Values: true | false
  - kmsKey
```
public final String 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 is true. 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 is true. Optional.
  - 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 the isEmpty() 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
```
public final List<Tag> tags()
```
    A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.
    
    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 you can assign to a cached volume. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.
  - toBuilder
```
public CreateCachediScsiVolumeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateCachediScsiVolumeRequest.Builder,CreateCachediScsiVolumeRequest>
    
    Specified by:
    
    toBuilder in class StorageGatewayRequest
  - builder
```
public static CreateCachediScsiVolumeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateCachediScsiVolumeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateCachediScsiVolumeRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

gatewayARN

volumeSizeInBytes

snapshotId

targetName

sourceVolumeARN

networkInterfaceId

clientToken

kmsEncrypted

kmsKey

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields