software.amazon.awssdk.services.storagegateway.model

Class Disk

java.lang.Object

software.amazon.awssdk.services.storagegateway.model.Disk

All Implemented Interfaces:

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

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

Represents a gateway's local disk.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Disk.Builder

Method Summary

Modifier and Type	Method and Description
static Disk.Builder	builder()
String	diskAllocationResource() The iSCSI qualified name (IQN) that is defined for a disk.
String	diskAllocationType() Returns the value of the DiskAllocationType property for this object.
List<String>	diskAttributeList() Returns the value of the DiskAttributeList property for this object.
String	diskId() The unique device ID or other distinguishing data that identifies a local disk.
String	diskNode() The device node of a local disk as assigned by the virtualization environment.
String	diskPath() The path of a local disk in the gateway virtual machine (VM).
Long	diskSizeInBytes() The local disk size in bytes.
String	diskStatus() A value that represents the status of a local disk.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDiskAttributeList() For responses, this returns true if the service returned a value for the DiskAttributeList property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Disk.Builder>	serializableBuilderClass()
Disk.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

diskId

public final String diskId()

The unique device ID or other distinguishing data that identifies a local disk.

Returns:

The unique device ID or other distinguishing data that identifies a local disk.

diskPath

public final String diskPath()

The path of a local disk in the gateway virtual machine (VM).

Returns:

The path of a local disk in the gateway virtual machine (VM).

diskNode

public final String diskNode()

The device node of a local disk as assigned by the virtualization environment.

Returns:

The device node of a local disk as assigned by the virtualization environment.

diskStatus

public final String diskStatus()

A value that represents the status of a local disk.

Returns:

A value that represents the status of a local disk.

diskSizeInBytes

public final Long diskSizeInBytes()

The local disk size in bytes.

Returns:

The local disk size in bytes.

diskAllocationType

public final String diskAllocationType()

Returns the value of the DiskAllocationType property for this object.

Returns:

The value of the DiskAllocationType property for this object.

diskAllocationResource

public final String diskAllocationResource()

The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId.

Returns:

The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId.

hasDiskAttributeList

public final boolean hasDiskAttributeList()

For responses, this returns true if the service returned a value for the DiskAttributeList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

diskAttributeList

public final List<String> diskAttributeList()

Returns the value of the DiskAttributeList property for this object.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDiskAttributeList() method.

Returns:

The value of the DiskAttributeList property for this object.

toBuilder

public Disk.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Disk.Builder,Disk>

builder

public static Disk.Builder builder()

serializableBuilderClass

public static Class<? extends Disk.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