com.amazonaws.services.storagegateway.model.CreateStorediSCSIVolumeRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.storagegateway.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.storagegateway.AWSStorageGateway#createStorediSCSIVolume(CreateStorediSCSIVolumeRequest) CreateStorediSCSIVolume operation}.
*
* This operation creates a volume on a specified gateway. This operation
* is supported only for the gateway-stored volume architecture.
*
*
* The size of the volume to create is inferred from the disk size. You
* can choose to preserve existing data on the disk, create volume from
* an existing snapshot, or create an empty volume. If you choose to
* create an empty gateway volume, then any existing data on the disk is
* erased.
*
*
* In the request you must specify the gateway and the disk information
* on which you are creating the volume. In response, AWS Storage Gateway
* creates the volume and returns volume information 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 com.amazonaws.services.storagegateway.AWSStorageGateway#createStorediSCSIVolume(CreateStorediSCSIVolumeRequest)
*/
public class CreateStorediSCSIVolumeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* 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
*/
private String gatewayARN;
/**
* The unique identifier for the gateway local disk that is configured as
* a stored volume. Use ListLocalDisks
* to list disk IDs for a gateway.
*
* Constraints:
* Length: 1 - 300
*/
private String diskId;
/**
* The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
* the new stored 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.
*
* Constraints:
* Pattern: \Asnap-[0-9a-fA-F]{8}\z
*/
private String snapshotId;
/**
* Specify this field as true if you want to preserve the data on the
* local disk. Otherwise, specifying this field as false creates an empty
* volume.
Valid Values: true, false
*/
private Boolean preserveExistingData;
/**
* The name of the iSCSI target used by initiators to connect to the
* target and as a suffix for the target ARN. For example, specifying
* TargetName as myvolume results in the target ARN
* of
* arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume.
* The target name must be unique across all volumes of a gateway.
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[-\.;a-z0-9]+$
*/
private String targetName;
/**
* 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.
*
* 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
*/
private String networkInterfaceId;
/**
* 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
*
* @return The Amazon Resource Name (ARN) of the gateway. Use the
* ListGateways operation to return a list of gateways for your
* account and region.
*/
public String getGatewayARN() {
return 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
*
* @param gatewayARN The Amazon Resource Name (ARN) of the gateway. Use the
* ListGateways operation to return a list of gateways for your
* account and region.
*/
public void setGatewayARN(String gatewayARN) {
this.gatewayARN = 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
*
* @param gatewayARN The Amazon Resource Name (ARN) of the gateway. Use the
* ListGateways operation to return a list of gateways for your
* account and region.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateStorediSCSIVolumeRequest withGatewayARN(String gatewayARN) {
this.gatewayARN = gatewayARN;
return this;
}
/**
* The unique identifier for the gateway local disk that is configured as
* a stored volume. Use ListLocalDisks
* to list disk IDs for a gateway.
*
* Constraints:
* Length: 1 - 300
*
* @return The unique identifier for the gateway local disk that is configured as
* a stored volume. Use ListLocalDisks
* to list disk IDs for a gateway.
*/
public String getDiskId() {
return diskId;
}
/**
* The unique identifier for the gateway local disk that is configured as
* a stored volume. Use ListLocalDisks
* to list disk IDs for a gateway.
*
* Constraints:
* Length: 1 - 300
*
* @param diskId The unique identifier for the gateway local disk that is configured as
* a stored volume. Use ListLocalDisks
* to list disk IDs for a gateway.
*/
public void setDiskId(String diskId) {
this.diskId = diskId;
}
/**
* The unique identifier for the gateway local disk that is configured as
* a stored volume. Use ListLocalDisks
* to list disk IDs for a gateway.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 300
*
* @param diskId The unique identifier for the gateway local disk that is configured as
* a stored volume. Use ListLocalDisks
* to list disk IDs for a gateway.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateStorediSCSIVolumeRequest withDiskId(String diskId) {
this.diskId = diskId;
return this;
}
/**
* The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
* the new stored 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.
*
* Constraints:
* Pattern: \Asnap-[0-9a-fA-F]{8}\z
*
* @return The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
* the new stored 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.
*/
public String getSnapshotId() {
return snapshotId;
}
/**
* The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
* the new stored 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.
*
* Constraints:
* Pattern: \Asnap-[0-9a-fA-F]{8}\z
*
* @param snapshotId The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
* the new stored 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.
*/
public void setSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
}
/**
* The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
* the new stored 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 a reference to this object so that method calls can be chained together.
*
* Constraints:
* Pattern: \Asnap-[0-9a-fA-F]{8}\z
*
* @param snapshotId The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
* the new stored 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateStorediSCSIVolumeRequest withSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
return this;
}
/**
* Specify this field as true if you want to preserve the data on the
* local disk. Otherwise, specifying this field as false creates an empty
* volume.
Valid Values: true, false
*
* @return Specify this field as true if you want to preserve the data on the
* local disk. Otherwise, specifying this field as false creates an empty
* volume.
Valid Values: true, false
*/
public Boolean isPreserveExistingData() {
return preserveExistingData;
}
/**
* Specify this field as true if you want to preserve the data on the
* local disk. Otherwise, specifying this field as false creates an empty
* volume.
Valid Values: true, false
*
* @param preserveExistingData Specify this field as true if you want to preserve the data on the
* local disk. Otherwise, specifying this field as false creates an empty
* volume.
Valid Values: true, false
*/
public void setPreserveExistingData(Boolean preserveExistingData) {
this.preserveExistingData = preserveExistingData;
}
/**
* Specify this field as true if you want to preserve the data on the
* local disk. Otherwise, specifying this field as false creates an empty
* volume.
Valid Values: true, false
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param preserveExistingData Specify this field as true if you want to preserve the data on the
* local disk. Otherwise, specifying this field as false creates an empty
* volume.
Valid Values: true, false
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateStorediSCSIVolumeRequest withPreserveExistingData(Boolean preserveExistingData) {
this.preserveExistingData = preserveExistingData;
return this;
}
/**
* Specify this field as true if you want to preserve the data on the
* local disk. Otherwise, specifying this field as false creates an empty
* volume.
Valid Values: true, false
*
* @return Specify this field as true if you want to preserve the data on the
* local disk. Otherwise, specifying this field as false creates an empty
* volume.
Valid Values: true, false
*/
public Boolean getPreserveExistingData() {
return preserveExistingData;
}
/**
* The name of the iSCSI target used by initiators to connect to the
* target and as a suffix for the target ARN. For example, specifying
* TargetName as myvolume results in the target ARN
* of
* arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume.
* The target name must be unique across all volumes of a gateway.
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[-\.;a-z0-9]+$
*
* @return The name of the iSCSI target used by initiators to connect to the
* target and as a suffix for the target ARN. For example, specifying
* TargetName as myvolume results in the target ARN
* of
* arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume.
* The target name must be unique across all volumes of a gateway.
*/
public String getTargetName() {
return targetName;
}
/**
* The name of the iSCSI target used by initiators to connect to the
* target and as a suffix for the target ARN. For example, specifying
* TargetName as myvolume results in the target ARN
* of
* arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume.
* The target name must be unique across all volumes of a gateway.
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[-\.;a-z0-9]+$
*
* @param targetName The name of the iSCSI target used by initiators to connect to the
* target and as a suffix for the target ARN. For example, specifying
* TargetName as myvolume results in the target ARN
* of
* arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume.
* The target name must be unique across all volumes of a gateway.
*/
public void setTargetName(String targetName) {
this.targetName = targetName;
}
/**
* The name of the iSCSI target used by initiators to connect to the
* target and as a suffix for the target ARN. For example, specifying
* TargetName as myvolume results in the target ARN
* of
* arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume.
* The target name must be unique across all volumes of a gateway.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[-\.;a-z0-9]+$
*
* @param targetName The name of the iSCSI target used by initiators to connect to the
* target and as a suffix for the target ARN. For example, specifying
* TargetName as myvolume results in the target ARN
* of
* arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume.
* The target name must be unique across all volumes of a gateway.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateStorediSCSIVolumeRequest withTargetName(String targetName) {
this.targetName = targetName;
return this;
}
/**
* 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.
*
* 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
*
* @return 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.
*/
public String getNetworkInterfaceId() {
return 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.
*
* 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
*
* @param 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.
*/
public void setNetworkInterfaceId(String networkInterfaceId) {
this.networkInterfaceId = 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 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
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateStorediSCSIVolumeRequest withNetworkInterfaceId(String networkInterfaceId) {
this.networkInterfaceId = networkInterfaceId;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getGatewayARN() != null) sb.append("GatewayARN: " + getGatewayARN() + ",");
if (getDiskId() != null) sb.append("DiskId: " + getDiskId() + ",");
if (getSnapshotId() != null) sb.append("SnapshotId: " + getSnapshotId() + ",");
if (isPreserveExistingData() != null) sb.append("PreserveExistingData: " + isPreserveExistingData() + ",");
if (getTargetName() != null) sb.append("TargetName: " + getTargetName() + ",");
if (getNetworkInterfaceId() != null) sb.append("NetworkInterfaceId: " + getNetworkInterfaceId() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getGatewayARN() == null) ? 0 : getGatewayARN().hashCode());
hashCode = prime * hashCode + ((getDiskId() == null) ? 0 : getDiskId().hashCode());
hashCode = prime * hashCode + ((getSnapshotId() == null) ? 0 : getSnapshotId().hashCode());
hashCode = prime * hashCode + ((isPreserveExistingData() == null) ? 0 : isPreserveExistingData().hashCode());
hashCode = prime * hashCode + ((getTargetName() == null) ? 0 : getTargetName().hashCode());
hashCode = prime * hashCode + ((getNetworkInterfaceId() == null) ? 0 : getNetworkInterfaceId().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof CreateStorediSCSIVolumeRequest == false) return false;
CreateStorediSCSIVolumeRequest other = (CreateStorediSCSIVolumeRequest)obj;
if (other.getGatewayARN() == null ^ this.getGatewayARN() == null) return false;
if (other.getGatewayARN() != null && other.getGatewayARN().equals(this.getGatewayARN()) == false) return false;
if (other.getDiskId() == null ^ this.getDiskId() == null) return false;
if (other.getDiskId() != null && other.getDiskId().equals(this.getDiskId()) == false) return false;
if (other.getSnapshotId() == null ^ this.getSnapshotId() == null) return false;
if (other.getSnapshotId() != null && other.getSnapshotId().equals(this.getSnapshotId()) == false) return false;
if (other.isPreserveExistingData() == null ^ this.isPreserveExistingData() == null) return false;
if (other.isPreserveExistingData() != null && other.isPreserveExistingData().equals(this.isPreserveExistingData()) == false) return false;
if (other.getTargetName() == null ^ this.getTargetName() == null) return false;
if (other.getTargetName() != null && other.getTargetName().equals(this.getTargetName()) == false) return false;
if (other.getNetworkInterfaceId() == null ^ this.getNetworkInterfaceId() == null) return false;
if (other.getNetworkInterfaceId() != null && other.getNetworkInterfaceId().equals(this.getNetworkInterfaceId()) == false) return false;
return true;
}
@Override
public CreateStorediSCSIVolumeRequest clone() {
return (CreateStorediSCSIVolumeRequest) super.clone();
}
}