Class Disk

java.lang.Object
software.amazon.awssdk.services.lightsail.model.Disk
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Disk.Builder,Disk>
@Generated("software.amazon.awssdk:codegen") public final class Disk extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Disk.Builder,Disk>

Describes a block storage disk.

See Also:

  • Method Details

    • name

      public final String name()

      The unique name of the disk.

      Returns:
      The unique name of the disk.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the disk.

      Returns:
      The Amazon Resource Name (ARN) of the disk.

    • supportCode

      public final 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.

      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.

    • createdAt

      public final Instant createdAt()

      The date when the disk was created.

      Returns:
      The date when the disk was created.

    • location

      public final ResourceLocation location()

      The AWS Region and Availability Zone where the disk is located.

      Returns:
      The AWS Region and Availability Zone where the disk is located.

    • resourceType

      public final ResourceType resourceType()

      The Lightsail resource type (Disk).

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      The Lightsail resource type (Disk).
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The Lightsail resource type (Disk).

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      The Lightsail resource type (Disk).
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

      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 hasTags() method.

      Returns:
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

    • hasAddOns

      public final boolean hasAddOns()
      For responses, this returns true if the service returned a value for the AddOns 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.

    • addOns

      public final List<AddOn> addOns()

      An array of objects representing the add-ons enabled on the disk.

      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 hasAddOns() method.

      Returns:
      An array of objects representing the add-ons enabled on the disk.

    • sizeInGb

      public final Integer sizeInGb()

      The size of the disk in GB.

      Returns:
      The size of the disk in GB.

    • isSystemDisk

      public final 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).

    • iops

      public final Integer iops()

      The input/output operations per second (IOPS) of the disk.

      Returns:
      The input/output operations per second (IOPS) of the disk.

    • path

      public final String path()

      The disk path.

      Returns:
      The disk path.

    • state

      public final DiskState state()

      Describes the status of the disk.

      If the service returns an enum value that is not available in the current SDK version, state will return DiskState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      Describes the status of the disk.
      See Also:

    • stateAsString

      public final String stateAsString()

      Describes the status of the disk.

      If the service returns an enum value that is not available in the current SDK version, state will return DiskState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      Describes the status of the disk.
      See Also:

    • attachedTo

      public final String attachedTo()

      The resources to which the disk is attached.

      Returns:
      The resources to which the disk is attached.

    • isAttached

      public final Boolean isAttached()

      A Boolean value indicating whether the disk is attached.

      Returns:
      A Boolean value indicating whether the disk is attached.

    • attachmentState

      @Deprecated public final String attachmentState()
      Deprecated.

      (Discontinued) The attachment state of the disk.

      In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now discontinued, but still included in the response. Use isAttached instead.

      Returns:
      (Discontinued) The attachment state of the disk.

      In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now discontinued, but still included in the response. Use isAttached instead.

    • gbInUse

      @Deprecated public final Integer gbInUse()
      Deprecated.

      (Discontinued) The number of GB in use by the disk.

      In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.

      Returns:
      (Discontinued) The number of GB in use by the disk.

      In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.

    • autoMountStatus

      public final AutoMountStatus autoMountStatus()

      The status of automatically mounting a storage disk to a virtual computer.

      This parameter only applies to Lightsail for Research resources.

      If the service returns an enum value that is not available in the current SDK version, autoMountStatus will return AutoMountStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoMountStatusAsString().

      Returns:
      The status of automatically mounting a storage disk to a virtual computer.

      This parameter only applies to Lightsail for Research resources.

      See Also:

    • autoMountStatusAsString

      public final String autoMountStatusAsString()

      The status of automatically mounting a storage disk to a virtual computer.

      This parameter only applies to Lightsail for Research resources.

      If the service returns an enum value that is not available in the current SDK version, autoMountStatus will return AutoMountStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoMountStatusAsString().

      Returns:
      The status of automatically mounting a storage disk to a virtual computer.

      This parameter only applies to Lightsail for Research resources.

      See Also:

    • toBuilder

      public Disk.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Disk.Builder,Disk>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.