software.amazon.awssdk.services.storagegateway.model

Class VolumeInfo

java.lang.Object

software.amazon.awssdk.services.storagegateway.model.VolumeInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VolumeInfo.Builder,VolumeInfo>

@Generated(value="software.amazon.awssdk:codegen")
public final class VolumeInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VolumeInfo.Builder,VolumeInfo>

Describes a storage volume object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VolumeInfo.Builder

Method Summary

Modifier and Type	Method and Description
static VolumeInfo.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gatewayARN() Returns the value of the GatewayARN property for this object.
String	gatewayId() The unique identifier assigned to your gateway during activation.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends VolumeInfo.Builder>	serializableBuilderClass()
VolumeInfo.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	volumeARN() The Amazon Resource Name (ARN) for the storage volume.
String	volumeAttachmentStatus() One of the VolumeStatus values that indicates the state of the storage volume.
String	volumeId() The unique identifier assigned to the volume.
Long	volumeSizeInBytes() The size of the volume in bytes.
String	volumeType() One of the VolumeType enumeration values describing the type of the volume.

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

volumeARN

public final String volumeARN()

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Returns:

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volumeId

public final String volumeId()

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Returns:

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

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.

gatewayId

public final String gatewayId()

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Returns:

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volumeType

public final String volumeType()

One of the VolumeType enumeration values describing the type of the volume.

Returns:

One of the VolumeType enumeration values describing the type of the volume.

volumeSizeInBytes

public final Long volumeSizeInBytes()

The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Returns:

The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

volumeAttachmentStatus

public final String volumeAttachmentStatus()

One of the VolumeStatus values that indicates the state of the storage volume.

Returns:

One of the VolumeStatus values that indicates the state of the storage volume.

toBuilder

public VolumeInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VolumeInfo.Builder,VolumeInfo>

builder

public static VolumeInfo.Builder builder()

serializableBuilderClass

public static Class<? extends VolumeInfo.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo