com.amazonaws.services.storagegateway.model.CreateStorediSCSIVolumeRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-storagegateway Show documentation
/*
* Copyright 2011-2016 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;
/**
*
* A JSON object containing one or more of the following fields:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*/
public class CreateStorediSCSIVolumeRequest extends
com.amazonaws.AmazonWebServiceRequest implements Serializable,
Cloneable {
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.
*
*/
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.
*
*/
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/sgw-12A3456B/target/
* iqn.1997-05.com.amazon:myvolume. The target name must be unique across
* all volumes of a gateway.
*
*/
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.
*
*/
private String networkInterfaceId;
/**
* @param gatewayARN
*/
public void setGatewayARN(String gatewayARN) {
this.gatewayARN = gatewayARN;
}
/**
* @return
*/
public String getGatewayARN() {
return this.gatewayARN;
}
/**
* @param gatewayARN
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateStorediSCSIVolumeRequest withGatewayARN(String gatewayARN) {
setGatewayARN(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.
*
*
* @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.
*
*
* @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 this.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.
*
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateStorediSCSIVolumeRequest withDiskId(String diskId) {
setDiskId(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.
*
*
* @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.
*
*
* @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 this.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.
*
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateStorediSCSIVolumeRequest withSnapshotId(String snapshotId) {
setSnapshotId(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
*
*
* @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
*
*
* @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 this.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
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateStorediSCSIVolumeRequest withPreserveExistingData(
Boolean preserveExistingData) {
setPreserveExistingData(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 isPreserveExistingData() {
return this.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/sgw-12A3456B/target/
* iqn.1997-05.com.amazon:myvolume. The target name must be unique across
* all volumes of a gateway.
*
*
* @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/sgw-12
* A3456B/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/sgw-12A3456B/target/
* iqn.1997-05.com.amazon:myvolume. The target name must be unique across
* all volumes of a gateway.
*
*
* @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
* /sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target
* name must be unique across all volumes of a gateway.
*/
public String getTargetName() {
return this.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/sgw-12A3456B/target/
* iqn.1997-05.com.amazon:myvolume. The target name must be unique across
* all volumes of a gateway.
*
*
* @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/sgw-12
* A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name
* must be unique across all volumes of a gateway.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateStorediSCSIVolumeRequest withTargetName(String targetName) {
setTargetName(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.
*
*
* @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.
*
*
* @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 this.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.
*
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateStorediSCSIVolumeRequest withNetworkInterfaceId(
String networkInterfaceId) {
setNetworkInterfaceId(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 (getPreserveExistingData() != null)
sb.append("PreserveExistingData: " + getPreserveExistingData()
+ ",");
if (getTargetName() != null)
sb.append("TargetName: " + getTargetName() + ",");
if (getNetworkInterfaceId() != null)
sb.append("NetworkInterfaceId: " + getNetworkInterfaceId());
sb.append("}");
return sb.toString();
}
@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.getPreserveExistingData() == null
^ this.getPreserveExistingData() == null)
return false;
if (other.getPreserveExistingData() != null
&& other.getPreserveExistingData().equals(
this.getPreserveExistingData()) == 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 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
+ ((getPreserveExistingData() == null) ? 0
: getPreserveExistingData().hashCode());
hashCode = prime * hashCode
+ ((getTargetName() == null) ? 0 : getTargetName().hashCode());
hashCode = prime
* hashCode
+ ((getNetworkInterfaceId() == null) ? 0
: getNetworkInterfaceId().hashCode());
return hashCode;
}
@Override
public CreateStorediSCSIVolumeRequest clone() {
return (CreateStorediSCSIVolumeRequest) super.clone();
}
}