Disk (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lightsail.model.Disk

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Disk
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the hard disk (an SSD).

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Disk()

Constructors
Constructor and Description
`Disk()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Disk`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the disk.
`String`	`getAttachedTo()` The resources to which the disk is attached.
`String`	`getAttachmentState()` The attachment state of the disk.
`Date`	`getCreatedAt()` The date when the disk was created.
`Integer`	`getGbInUse()` The number of GB in use by the disk.
`Integer`	`getIops()` The input/output operations per second (IOPS) of the disk.
`Boolean`	`getIsAttached()` A Boolean value indicating whether the disk is attached.
`Boolean`	`getIsSystemDisk()` A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
`ResourceLocation`	`getLocation()` The region and Availability Zone where the disk is located.
`String`	`getName()` The name of the disk.
`String`	`getPath()` The disk path.
`String`	`getResourceType()` The resource type of the disk.
`Integer`	`getSizeInGb()` The size of the disk in GB.
`String`	`getSupportCode()` The support code.
`int`	`hashCode()`
`Boolean`	`isAttached()` A Boolean value indicating whether the disk is attached.
`Boolean`	`isSystemDisk()` A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the disk.
`void`	`setAttachedTo(String attachedTo)` The resources to which the disk is attached.
`void`	`setAttachmentState(String attachmentState)` The attachment state of the disk.
`void`	`setCreatedAt(Date createdAt)` The date when the disk was created.
`void`	`setGbInUse(Integer gbInUse)` The number of GB in use by the disk.
`void`	`setIops(Integer iops)` The input/output operations per second (IOPS) of the disk.
`void`	`setIsAttached(Boolean isAttached)` A Boolean value indicating whether the disk is attached.
`void`	`setIsSystemDisk(Boolean isSystemDisk)` A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
`void`	`setLocation(ResourceLocation location)` The region and Availability Zone where the disk is located.
`void`	`setName(String name)` The name of the disk.
`void`	`setPath(String path)` The disk path.
`void`	`setResourceType(ResourceType resourceType)` The resource type of the disk.
`void`	`setResourceType(String resourceType)` The resource type of the disk.
`void`	`setSizeInGb(Integer sizeInGb)` The size of the disk in GB.
`void`	`setSupportCode(String supportCode)` The support code.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Disk`	`withArn(String arn)` The Amazon Resource Name (ARN) of the disk.
`Disk`	`withAttachedTo(String attachedTo)` The resources to which the disk is attached.
`Disk`	`withAttachmentState(String attachmentState)` The attachment state of the disk.
`Disk`	`withCreatedAt(Date createdAt)` The date when the disk was created.
`Disk`	`withGbInUse(Integer gbInUse)` The number of GB in use by the disk.
`Disk`	`withIops(Integer iops)` The input/output operations per second (IOPS) of the disk.
`Disk`	`withIsAttached(Boolean isAttached)` A Boolean value indicating whether the disk is attached.
`Disk`	`withIsSystemDisk(Boolean isSystemDisk)` A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
`Disk`	`withLocation(ResourceLocation location)` The region and Availability Zone where the disk is located.
`Disk`	`withName(String name)` The name of the disk.
`Disk`	`withPath(String path)` The disk path.
`Disk`	`withResourceType(ResourceType resourceType)` The resource type of the disk.
`Disk`	`withResourceType(String resourceType)` The resource type of the disk.
`Disk`	`withSizeInGb(Integer sizeInGb)` The size of the disk in GB.
`Disk`	`withSupportCode(String supportCode)` The support code.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Disk
```
public Disk()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the disk.
    
    Parameters:
    
    name - The name of the disk.
  - getName
```
public String getName()
```
    The name of the disk.
    
    Returns:
    
    The name of the disk.
  - withName
```
public Disk withName(String name)
```
    The name of the disk.
    
    Parameters:
    
    name - The name of the disk.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the disk.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the disk.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the disk.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the disk.
  - withArn
```
public Disk withArn(String arn)
```
    The Amazon Resource Name (ARN) of the disk.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the disk.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSupportCode
```
public void setSupportCode(String supportCode)
```
    The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    
    Parameters:
    
    supportCode - The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
  - getSupportCode
```
public String getSupportCode()
```
    The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    
    Returns:
    
    The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
  - withSupportCode
```
public Disk withSupportCode(String supportCode)
```
    The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    
    Parameters:
    
    supportCode - The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The date when the disk was created.
    
    Parameters:
    
    createdAt - The date when the disk was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The date when the disk was created.
    
    Returns:
    
    The date when the disk was created.
  - withCreatedAt
```
public Disk withCreatedAt(Date createdAt)
```
    The date when the disk was created.
    
    Parameters:
    
    createdAt - The date when the disk was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(ResourceLocation location)
```
    The region and Availability Zone where the disk is located.
    
    Parameters:
    
    location - The region and Availability Zone where the disk is located.
  - getLocation
```
public ResourceLocation getLocation()
```
    The region and Availability Zone where the disk is located.
    
    Returns:
    
    The region and Availability Zone where the disk is located.
  - withLocation
```
public Disk withLocation(ResourceLocation location)
```
    The region and Availability Zone where the disk is located.
    
    Parameters:
    
    location - The region and Availability Zone where the disk is located.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The resource type of the disk.
    
    Parameters:
    
    resourceType - The resource type of the disk.
    
    See Also:
    
    ResourceType
  - getResourceType
```
public String getResourceType()
```
    The resource type of the disk.
    
    Returns:
    
    The resource type of the disk.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public Disk withResourceType(String resourceType)
```
    The resource type of the disk.
    
    Parameters:
    
    resourceType - The resource type of the disk.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - setResourceType
```
public void setResourceType(ResourceType resourceType)
```
    The resource type of the disk.
    
    Parameters:
    
    resourceType - The resource type of the disk.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public Disk withResourceType(ResourceType resourceType)
```
    The resource type of the disk.
    
    Parameters:
    
    resourceType - The resource type of the disk.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - setSizeInGb
```
public void setSizeInGb(Integer sizeInGb)
```
    The size of the disk in GB.
    
    Parameters:
    
    sizeInGb - The size of the disk in GB.
  - getSizeInGb
```
public Integer getSizeInGb()
```
    The size of the disk in GB.
    
    Returns:
    
    The size of the disk in GB.
  - withSizeInGb
```
public Disk withSizeInGb(Integer sizeInGb)
```
    The size of the disk in GB.
    
    Parameters:
    
    sizeInGb - The size of the disk in GB.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGbInUse
```
public void setGbInUse(Integer gbInUse)
```
    The number of GB in use by the disk.
    
    Parameters:
    
    gbInUse - The number of GB in use by the disk.
  - getGbInUse
```
public Integer getGbInUse()
```
    The number of GB in use by the disk.
    
    Returns:
    
    The number of GB in use by the disk.
  - withGbInUse
```
public Disk withGbInUse(Integer gbInUse)
```
    The number of GB in use by the disk.
    
    Parameters:
    
    gbInUse - The number of GB in use by the disk.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsSystemDisk
```
public void setIsSystemDisk(Boolean isSystemDisk)
```
    A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
    
    Parameters:
    
    isSystemDisk - A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
  - getIsSystemDisk
```
public Boolean getIsSystemDisk()
```
    A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
    
    Returns:
    
    A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
  - withIsSystemDisk
```
public Disk withIsSystemDisk(Boolean isSystemDisk)
```
    A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
    
    Parameters:
    
    isSystemDisk - A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSystemDisk
```
public Boolean isSystemDisk()
```
    A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
    
    Returns:
    
    A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
  - setIops
```
public void setIops(Integer iops)
```
    The input/output operations per second (IOPS) of the disk.
    
    Parameters:
    
    iops - The input/output operations per second (IOPS) of the disk.
  - getIops
```
public Integer getIops()
```
    The input/output operations per second (IOPS) of the disk.
    
    Returns:
    
    The input/output operations per second (IOPS) of the disk.
  - withIops
```
public Disk withIops(Integer iops)
```
    The input/output operations per second (IOPS) of the disk.
    
    Parameters:
    
    iops - The input/output operations per second (IOPS) of the disk.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPath
```
public void setPath(String path)
```
    The disk path.
    
    Parameters:
    
    path - The disk path.
  - getPath
```
public String getPath()
```
    The disk path.
    
    Returns:
    
    The disk path.
  - withPath
```
public Disk withPath(String path)
```
    The disk path.
    
    Parameters:
    
    path - The disk path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAttachedTo
```
public void setAttachedTo(String attachedTo)
```
    The resources to which the disk is attached.
    
    Parameters:
    
    attachedTo - The resources to which the disk is attached.
  - getAttachedTo
```
public String getAttachedTo()
```
    The resources to which the disk is attached.
    
    Returns:
    
    The resources to which the disk is attached.
  - withAttachedTo
```
public Disk withAttachedTo(String attachedTo)
```
    The resources to which the disk is attached.
    
    Parameters:
    
    attachedTo - The resources to which the disk is attached.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsAttached
```
public void setIsAttached(Boolean isAttached)
```
    A Boolean value indicating whether the disk is attached.
    
    Parameters:
    
    isAttached - A Boolean value indicating whether the disk is attached.
  - getIsAttached
```
public Boolean getIsAttached()
```
    A Boolean value indicating whether the disk is attached.
    
    Returns:
    
    A Boolean value indicating whether the disk is attached.
  - withIsAttached
```
public Disk withIsAttached(Boolean isAttached)
```
    A Boolean value indicating whether the disk is attached.
    
    Parameters:
    
    isAttached - A Boolean value indicating whether the disk is attached.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAttached
```
public Boolean isAttached()
```
    A Boolean value indicating whether the disk is attached.
    
    Returns:
    
    A Boolean value indicating whether the disk is attached.
  - setAttachmentState
```
public void setAttachmentState(String attachmentState)
```
    The attachment state of the disk.
    
    Parameters:
    
    attachmentState - The attachment state of the disk.
  - getAttachmentState
```
public String getAttachmentState()
```
    The attachment state of the disk.
    
    Returns:
    
    The attachment state of the disk.
  - withAttachmentState
```
public Disk withAttachmentState(String attachmentState)
```
    The attachment state of the disk.
    
    Parameters:
    
    attachmentState - The attachment state of the disk.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Disk clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Disk

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Disk

Method Detail

setName

getName

withName

setArn

getArn

withArn

setSupportCode

getSupportCode

withSupportCode

setCreatedAt

getCreatedAt

withCreatedAt

setLocation

getLocation

withLocation

setResourceType

getResourceType

withResourceType

setResourceType

withResourceType

setSizeInGb

getSizeInGb

withSizeInGb

setGbInUse

getGbInUse

withGbInUse

setIsSystemDisk

getIsSystemDisk

withIsSystemDisk

isSystemDisk

setIops

getIops

withIops

setPath

getPath

withPath

setAttachedTo

getAttachedTo

withAttachedTo

setIsAttached

getIsAttached

withIsAttached

isAttached

setAttachmentState

getAttachmentState

withAttachmentState

toString

equals

hashCode

clone

marshall