Package software.amazon.awssdk.services.lightsail.model

Class DiskSnapshot

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

Describes a block storage disk snapshot.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the disk snapshot (my-disk-snapshot).

      Returns:
      The name of the disk snapshot (my-disk-snapshot).

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the disk snapshot.

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

    • 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 snapshot was created.

      Returns:
      The date when the disk snapshot was created.

    • location

      public final ResourceLocation location()

      The AWS Region and Availability Zone where the disk snapshot was created.

      Returns:
      The AWS Region and Availability Zone where the disk snapshot was created.

    • resourceType

      public final ResourceType resourceType()

      The Lightsail resource type (DiskSnapshot).

      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 (DiskSnapshot).
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The Lightsail resource type (DiskSnapshot).

      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 (DiskSnapshot).
      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.

    • sizeInGb

      public final Integer sizeInGb()

      The size of the disk in GB.

      Returns:
      The size of the disk in GB.

    • state

      public final DiskSnapshotState state()

      The status of the disk snapshot operation.

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

      Returns:
      The status of the disk snapshot operation.
      See Also:

    • stateAsString

      public final String stateAsString()

      The status of the disk snapshot operation.

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

      Returns:
      The status of the disk snapshot operation.
      See Also:

    • progress

      public final String progress()

      The progress of the snapshot.

      Returns:
      The progress of the snapshot.

    • fromDiskName

      public final String fromDiskName()

      The unique name of the source disk from which the disk snapshot was created.

      Returns:
      The unique name of the source disk from which the disk snapshot was created.

    • fromDiskArn

      public final String fromDiskArn()

      The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

      Returns:
      The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

    • fromInstanceName

      public final String fromInstanceName()

      The unique name of the source instance from which the disk (system volume) snapshot was created.

      Returns:
      The unique name of the source instance from which the disk (system volume) snapshot was created.

    • fromInstanceArn

      public final String fromInstanceArn()

      The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

      Returns:
      The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

    • isFromAutoSnapshot

      public final Boolean isFromAutoSnapshot()

      A Boolean value indicating whether the snapshot was created from an automatic snapshot.

      Returns:
      A Boolean value indicating whether the snapshot was created from an automatic snapshot.

    • toBuilder

      public DiskSnapshot.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<DiskSnapshot.Builder,DiskSnapshot>
      Returns:
      a builder for type T

    • builder

      public static DiskSnapshot.Builder builder()

    • serializableBuilderClass

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