com.amazonaws.services.storagegateway.model.DescribeStorediSCSIVolumesResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-storagegateway Show documentation
/*
* Copyright 2017-2022 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 javax.annotation.Generated;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeStorediSCSIVolumesResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:
*
*
* -
*
* ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
*
*
* -
*
* LunNumber: The logical disk number.
*
*
* -
*
* NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the
* stored volume as an iSCSI target.
*
*
* -
*
* NetworkInterfacePort: The port used to communicate with iSCSI targets.
*
*
* -
*
* PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying
* local disk was preserved.
*
*
* -
*
* SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot
* ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
*
*
* -
*
* StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about
* one stored volume.
*
*
* -
*
* TargetARN: The Amazon Resource Name (ARN) of the volume target.
*
*
* -
*
* VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
*
*
* -
*
* VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume
* operation.
*
*
* -
*
* VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
*
*
* -
*
* VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI
* attributes for one stored volume.
*
*
* -
*
* VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that
* represents the percent of data transferred. This field does not appear in the response if the stored volume is
* not restoring or bootstrapping.
*
*
* -
*
* VolumeSizeInBytes: The size of the volume in bytes.
*
*
* -
*
* VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.
*
*
* -
*
* VolumeType: One of the enumeration values describing the type of the volume. Currently, only
* STORED volumes are supported.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList storediSCSIVolumes;
/**
*
* Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:
*
*
* -
*
* ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
*
*
* -
*
* LunNumber: The logical disk number.
*
*
* -
*
* NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the
* stored volume as an iSCSI target.
*
*
* -
*
* NetworkInterfacePort: The port used to communicate with iSCSI targets.
*
*
* -
*
* PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying
* local disk was preserved.
*
*
* -
*
* SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot
* ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
*
*
* -
*
* StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about
* one stored volume.
*
*
* -
*
* TargetARN: The Amazon Resource Name (ARN) of the volume target.
*
*
* -
*
* VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
*
*
* -
*
* VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume
* operation.
*
*
* -
*
* VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
*
*
* -
*
* VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI
* attributes for one stored volume.
*
*
* -
*
* VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that
* represents the percent of data transferred. This field does not appear in the response if the stored volume is
* not restoring or bootstrapping.
*
*
* -
*
* VolumeSizeInBytes: The size of the volume in bytes.
*
*
* -
*
* VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.
*
*
* -
*
* VolumeType: One of the enumeration values describing the type of the volume. Currently, only
* STORED volumes are supported.
*
*
*
*
* @return Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are
* returned:
*
* -
*
* ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
*
*
* -
*
* LunNumber: The logical disk number.
*
*
* -
*
* NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map
* the stored volume as an iSCSI target.
*
*
* -
*
* NetworkInterfacePort: The port used to communicate with iSCSI targets.
*
*
* -
*
* PreservedExistingData: Indicates when the stored volume was created, existing data on the
* underlying local disk was preserved.
*
*
* -
*
* SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the
* snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
*
*
* -
*
* StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains
* metadata about one stored volume.
*
*
* -
*
* TargetARN: The Amazon Resource Name (ARN) of the volume target.
*
*
* -
*
* VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
*
*
* -
*
* VolumeDiskId: The disk ID of the local disk that was specified in the
* CreateStorediSCSIVolume operation.
*
*
* -
*
* VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
*
*
* -
*
* VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection
* of iSCSI attributes for one stored volume.
*
*
* -
*
* VolumeProgress: Represents the percentage complete if the volume is restoring or
* bootstrapping that represents the percent of data transferred. This field does not appear in the response
* if the stored volume is not restoring or bootstrapping.
*
*
* -
*
* VolumeSizeInBytes: The size of the volume in bytes.
*
*
* -
*
* VolumeStatus: One of the VolumeStatus values that indicates the state of the
* volume.
*
*
* -
*
* VolumeType: One of the enumeration values describing the type of the volume. Currently, only
* STORED volumes are supported.
*
*
*/
public java.util.List getStorediSCSIVolumes() {
if (storediSCSIVolumes == null) {
storediSCSIVolumes = new com.amazonaws.internal.SdkInternalList();
}
return storediSCSIVolumes;
}
/**
*
* Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:
*
*
* -
*
* ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
*
*
* -
*
* LunNumber: The logical disk number.
*
*
* -
*
* NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the
* stored volume as an iSCSI target.
*
*
* -
*
* NetworkInterfacePort: The port used to communicate with iSCSI targets.
*
*
* -
*
* PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying
* local disk was preserved.
*
*
* -
*
* SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot
* ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
*
*
* -
*
* StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about
* one stored volume.
*
*
* -
*
* TargetARN: The Amazon Resource Name (ARN) of the volume target.
*
*
* -
*
* VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
*
*
* -
*
* VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume
* operation.
*
*
* -
*
* VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
*
*
* -
*
* VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI
* attributes for one stored volume.
*
*
* -
*
* VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that
* represents the percent of data transferred. This field does not appear in the response if the stored volume is
* not restoring or bootstrapping.
*
*
* -
*
* VolumeSizeInBytes: The size of the volume in bytes.
*
*
* -
*
* VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.
*
*
* -
*
* VolumeType: One of the enumeration values describing the type of the volume. Currently, only
* STORED volumes are supported.
*
*
*
*
* @param storediSCSIVolumes
* Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are
* returned:
*
* -
*
* ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
*
*
* -
*
* LunNumber: The logical disk number.
*
*
* -
*
* NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map
* the stored volume as an iSCSI target.
*
*
* -
*
* NetworkInterfacePort: The port used to communicate with iSCSI targets.
*
*
* -
*
* PreservedExistingData: Indicates when the stored volume was created, existing data on the
* underlying local disk was preserved.
*
*
* -
*
* SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the
* snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
*
*
* -
*
* StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata
* about one stored volume.
*
*
* -
*
* TargetARN: The Amazon Resource Name (ARN) of the volume target.
*
*
* -
*
* VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
*
*
* -
*
* VolumeDiskId: The disk ID of the local disk that was specified in the
* CreateStorediSCSIVolume operation.
*
*
* -
*
* VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
*
*
* -
*
* VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of
* iSCSI attributes for one stored volume.
*
*
* -
*
* VolumeProgress: Represents the percentage complete if the volume is restoring or
* bootstrapping that represents the percent of data transferred. This field does not appear in the response
* if the stored volume is not restoring or bootstrapping.
*
*
* -
*
* VolumeSizeInBytes: The size of the volume in bytes.
*
*
* -
*
* VolumeStatus: One of the VolumeStatus values that indicates the state of the
* volume.
*
*
* -
*
* VolumeType: One of the enumeration values describing the type of the volume. Currently, only
* STORED volumes are supported.
*
*
*/
public void setStorediSCSIVolumes(java.util.Collection storediSCSIVolumes) {
if (storediSCSIVolumes == null) {
this.storediSCSIVolumes = null;
return;
}
this.storediSCSIVolumes = new com.amazonaws.internal.SdkInternalList(storediSCSIVolumes);
}
/**
*
* Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:
*
*
* -
*
* ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
*
*
* -
*
* LunNumber: The logical disk number.
*
*
* -
*
* NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the
* stored volume as an iSCSI target.
*
*
* -
*
* NetworkInterfacePort: The port used to communicate with iSCSI targets.
*
*
* -
*
* PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying
* local disk was preserved.
*
*
* -
*
* SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot
* ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
*
*
* -
*
* StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about
* one stored volume.
*
*
* -
*
* TargetARN: The Amazon Resource Name (ARN) of the volume target.
*
*
* -
*
* VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
*
*
* -
*
* VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume
* operation.
*
*
* -
*
* VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
*
*
* -
*
* VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI
* attributes for one stored volume.
*
*
* -
*
* VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that
* represents the percent of data transferred. This field does not appear in the response if the stored volume is
* not restoring or bootstrapping.
*
*
* -
*
* VolumeSizeInBytes: The size of the volume in bytes.
*
*
* -
*
* VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.
*
*
* -
*
* VolumeType: One of the enumeration values describing the type of the volume. Currently, only
* STORED volumes are supported.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setStorediSCSIVolumes(java.util.Collection)} or {@link #withStorediSCSIVolumes(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param storediSCSIVolumes
* Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are
* returned:
*
* -
*
* ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
*
*
* -
*
* LunNumber: The logical disk number.
*
*
* -
*
* NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map
* the stored volume as an iSCSI target.
*
*
* -
*
* NetworkInterfacePort: The port used to communicate with iSCSI targets.
*
*
* -
*
* PreservedExistingData: Indicates when the stored volume was created, existing data on the
* underlying local disk was preserved.
*
*
* -
*
* SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the
* snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
*
*
* -
*
* StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata
* about one stored volume.
*
*
* -
*
* TargetARN: The Amazon Resource Name (ARN) of the volume target.
*
*
* -
*
* VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
*
*
* -
*
* VolumeDiskId: The disk ID of the local disk that was specified in the
* CreateStorediSCSIVolume operation.
*
*
* -
*
* VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
*
*
* -
*
* VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of
* iSCSI attributes for one stored volume.
*
*
* -
*
* VolumeProgress: Represents the percentage complete if the volume is restoring or
* bootstrapping that represents the percent of data transferred. This field does not appear in the response
* if the stored volume is not restoring or bootstrapping.
*
*
* -
*
* VolumeSizeInBytes: The size of the volume in bytes.
*
*
* -
*
* VolumeStatus: One of the VolumeStatus values that indicates the state of the
* volume.
*
*
* -
*
* VolumeType: One of the enumeration values describing the type of the volume. Currently, only
* STORED volumes are supported.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeStorediSCSIVolumesResult withStorediSCSIVolumes(StorediSCSIVolume... storediSCSIVolumes) {
if (this.storediSCSIVolumes == null) {
setStorediSCSIVolumes(new com.amazonaws.internal.SdkInternalList(storediSCSIVolumes.length));
}
for (StorediSCSIVolume ele : storediSCSIVolumes) {
this.storediSCSIVolumes.add(ele);
}
return this;
}
/**
*
* Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:
*
*
* -
*
* ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
*
*
* -
*
* LunNumber: The logical disk number.
*
*
* -
*
* NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the
* stored volume as an iSCSI target.
*
*
* -
*
* NetworkInterfacePort: The port used to communicate with iSCSI targets.
*
*
* -
*
* PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying
* local disk was preserved.
*
*
* -
*
* SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot
* ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
*
*
* -
*
* StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about
* one stored volume.
*
*
* -
*
* TargetARN: The Amazon Resource Name (ARN) of the volume target.
*
*
* -
*
* VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
*
*
* -
*
* VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume
* operation.
*
*
* -
*
* VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
*
*
* -
*
* VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI
* attributes for one stored volume.
*
*
* -
*
* VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that
* represents the percent of data transferred. This field does not appear in the response if the stored volume is
* not restoring or bootstrapping.
*
*
* -
*
* VolumeSizeInBytes: The size of the volume in bytes.
*
*
* -
*
* VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.
*
*
* -
*
* VolumeType: One of the enumeration values describing the type of the volume. Currently, only
* STORED volumes are supported.
*
*
*
*
* @param storediSCSIVolumes
* Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are
* returned:
*
* -
*
* ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
*
*
* -
*
* LunNumber: The logical disk number.
*
*
* -
*
* NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map
* the stored volume as an iSCSI target.
*
*
* -
*
* NetworkInterfacePort: The port used to communicate with iSCSI targets.
*
*
* -
*
* PreservedExistingData: Indicates when the stored volume was created, existing data on the
* underlying local disk was preserved.
*
*
* -
*
* SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the
* snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
*
*
* -
*
* StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata
* about one stored volume.
*
*
* -
*
* TargetARN: The Amazon Resource Name (ARN) of the volume target.
*
*
* -
*
* VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
*
*
* -
*
* VolumeDiskId: The disk ID of the local disk that was specified in the
* CreateStorediSCSIVolume operation.
*
*
* -
*
* VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
*
*
* -
*
* VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of
* iSCSI attributes for one stored volume.
*
*
* -
*
* VolumeProgress: Represents the percentage complete if the volume is restoring or
* bootstrapping that represents the percent of data transferred. This field does not appear in the response
* if the stored volume is not restoring or bootstrapping.
*
*
* -
*
* VolumeSizeInBytes: The size of the volume in bytes.
*
*
* -
*
* VolumeStatus: One of the VolumeStatus values that indicates the state of the
* volume.
*
*
* -
*
* VolumeType: One of the enumeration values describing the type of the volume. Currently, only
* STORED volumes are supported.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeStorediSCSIVolumesResult withStorediSCSIVolumes(java.util.Collection storediSCSIVolumes) {
setStorediSCSIVolumes(storediSCSIVolumes);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStorediSCSIVolumes() != null)
sb.append("StorediSCSIVolumes: ").append(getStorediSCSIVolumes());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeStorediSCSIVolumesResult == false)
return false;
DescribeStorediSCSIVolumesResult other = (DescribeStorediSCSIVolumesResult) obj;
if (other.getStorediSCSIVolumes() == null ^ this.getStorediSCSIVolumes() == null)
return false;
if (other.getStorediSCSIVolumes() != null && other.getStorediSCSIVolumes().equals(this.getStorediSCSIVolumes()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStorediSCSIVolumes() == null) ? 0 : getStorediSCSIVolumes().hashCode());
return hashCode;
}
@Override
public DescribeStorediSCSIVolumesResult clone() {
try {
return (DescribeStorediSCSIVolumesResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}