CreateCachediSCSIVolumeRequest (AWS SDK for Java

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

All Implemented Interfaces:

Serializable
```
public class CreateCachediSCSIVolumeRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the CreateCachediSCSIVolume operation.
This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.

NOTE:Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

See Also:
AWSStorageGateway.createCachediSCSIVolume(CreateCachediSCSIVolumeRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateCachediSCSIVolumeRequest()

Constructors
Constructor and Description
`CreateCachediSCSIVolumeRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getClientToken()` Returns the value of the ClientToken property for this object.
`String`	`getGatewayARN()` The Amazon Resource Name (ARN) of the gateway.
`String`	`getNetworkInterfaceId()` Returns the value of the NetworkInterfaceId property for this object.
`String`	`getSnapshotId()` Returns the value of the SnapshotId property for this object.
`String`	`getTargetName()` Returns the value of the TargetName property for this object.
`Long`	`getVolumeSizeInBytes()` Returns the value of the VolumeSizeInBytes property for this object.
`int`	`hashCode()`
`void`	`setClientToken(String clientToken)` Sets the value of the ClientToken property for this object.
`void`	`setGatewayARN(String gatewayARN)` The Amazon Resource Name (ARN) of the gateway.
`void`	`setNetworkInterfaceId(String networkInterfaceId)` Sets the value of the NetworkInterfaceId property for this object.
`void`	`setSnapshotId(String snapshotId)` Sets the value of the SnapshotId property for this object.
`void`	`setTargetName(String targetName)` Sets the value of the TargetName property for this object.
`void`	`setVolumeSizeInBytes(Long volumeSizeInBytes)` Sets the value of the VolumeSizeInBytes property for this object.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateCachediSCSIVolumeRequest`	`withClientToken(String clientToken)` Sets the value of the ClientToken property for this object.
`CreateCachediSCSIVolumeRequest`	`withGatewayARN(String gatewayARN)` The Amazon Resource Name (ARN) of the gateway.
`CreateCachediSCSIVolumeRequest`	`withNetworkInterfaceId(String networkInterfaceId)` Sets the value of the NetworkInterfaceId property for this object.
`CreateCachediSCSIVolumeRequest`	`withSnapshotId(String snapshotId)` Sets the value of the SnapshotId property for this object.
`CreateCachediSCSIVolumeRequest`	`withTargetName(String targetName)` Sets the value of the TargetName property for this object.
`CreateCachediSCSIVolumeRequest`	`withVolumeSizeInBytes(Long volumeSizeInBytes)` Sets the value of the VolumeSizeInBytes property for this object.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

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

- Constructor Detail
  - CreateCachediSCSIVolumeRequest
```
public CreateCachediSCSIVolumeRequest()
```
- Method Detail
  - getGatewayARN
```
public String getGatewayARN()
```
    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
    Constraints:
    Length: 50 - 500
    
    Returns:
    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
  - setGatewayARN
```
public void setGatewayARN(String gatewayARN)
```
    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
    Constraints:
    Length: 50 - 500
    
    Parameters:
    gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
  - withGatewayARN
```
public CreateCachediSCSIVolumeRequest withGatewayARN(String gatewayARN)
```
    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 50 - 500
    
    Parameters:
    gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getVolumeSizeInBytes
```
public Long getVolumeSizeInBytes()
```
    Returns the value of the VolumeSizeInBytes property for this object.
    
    Returns:
    The value of the VolumeSizeInBytes property for this object.
  - setVolumeSizeInBytes
```
public void setVolumeSizeInBytes(Long volumeSizeInBytes)
```
    Sets the value of the VolumeSizeInBytes property for this object.
    
    Parameters:
    volumeSizeInBytes - The new value for the VolumeSizeInBytes property for this object.
  - withVolumeSizeInBytes
```
public CreateCachediSCSIVolumeRequest withVolumeSizeInBytes(Long volumeSizeInBytes)
```
    Sets the value of the VolumeSizeInBytes property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    volumeSizeInBytes - The new value for the VolumeSizeInBytes property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSnapshotId
```
public String getSnapshotId()
```
    Returns the value of the SnapshotId property for this object.
    Constraints:
    Pattern: \Asnap-[0-9a-fA-F]{8}\z
    
    Returns:
    The value of the SnapshotId property for this object.
  - setSnapshotId
```
public void setSnapshotId(String snapshotId)
```
    Sets the value of the SnapshotId property for this object.
    Constraints:
    Pattern: \Asnap-[0-9a-fA-F]{8}\z
    
    Parameters:
    snapshotId - The new value for the SnapshotId property for this object.
  - withSnapshotId
```
public CreateCachediSCSIVolumeRequest withSnapshotId(String snapshotId)
```
    Sets the value of the SnapshotId property for this object.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: \Asnap-[0-9a-fA-F]{8}\z
    
    Parameters:
    snapshotId - The new value for the SnapshotId property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getTargetName
```
public String getTargetName()
```
    Returns the value of the TargetName property for this object.
    Constraints:
    Length: 1 - 200
    Pattern: ^[-\.;a-z0-9]+$
    
    Returns:
    The value of the TargetName property for this object.
  - setTargetName
```
public void setTargetName(String targetName)
```
    Sets the value of the TargetName property for this object.
    Constraints:
    Length: 1 - 200
    Pattern: ^[-\.;a-z0-9]+$
    
    Parameters:
    targetName - The new value for the TargetName property for this object.
  - withTargetName
```
public CreateCachediSCSIVolumeRequest withTargetName(String targetName)
```
    Sets the value of the TargetName property for this object.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 200
    Pattern: ^[-\.;a-z0-9]+$
    
    Parameters:
    targetName - The new value for the TargetName property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getNetworkInterfaceId
```
public String getNetworkInterfaceId()
```
    Returns the value of the NetworkInterfaceId property for this object.
    Constraints:
    Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z
    
    Returns:
    The value of the NetworkInterfaceId property for this object.
  - setNetworkInterfaceId
```
public void setNetworkInterfaceId(String networkInterfaceId)
```
    Sets the value of the NetworkInterfaceId property for this object.
    Constraints:
    Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z
    
    Parameters:
    networkInterfaceId - The new value for the NetworkInterfaceId property for this object.
  - withNetworkInterfaceId
```
public CreateCachediSCSIVolumeRequest withNetworkInterfaceId(String networkInterfaceId)
```
    Sets the value of the NetworkInterfaceId property for this object.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z
    
    Parameters:
    networkInterfaceId - The new value for the NetworkInterfaceId property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getClientToken
```
public String getClientToken()
```
    Returns the value of the ClientToken property for this object.
    Constraints:
    Length: 5 - 100
    
    Returns:
    The value of the ClientToken property for this object.
  - setClientToken
```
public void setClientToken(String clientToken)
```
    Sets the value of the ClientToken property for this object.
    Constraints:
    Length: 5 - 100
    
    Parameters:
    clientToken - The new value for the ClientToken property for this object.
  - withClientToken
```
public CreateCachediSCSIVolumeRequest withClientToken(String clientToken)
```
    Sets the value of the ClientToken property for this object.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 5 - 100
    
    Parameters:
    clientToken - The new value for the ClientToken property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class CreateCachediSCSIVolumeRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateCachediSCSIVolumeRequest

Method Detail

getGatewayARN

setGatewayARN

withGatewayARN

getVolumeSizeInBytes

setVolumeSizeInBytes

withVolumeSizeInBytes

getSnapshotId

setSnapshotId

withSnapshotId

getTargetName

setTargetName

withTargetName

getNetworkInterfaceId

setNetworkInterfaceId

withNetworkInterfaceId

getClientToken

setClientToken

withClientToken

toString

hashCode

equals