DiskSnapshot (AWS Java SDK :: Services :: Amazon Lightsail 2.16.30 API)

java.lang.Object
- software.amazon.awssdk.services.lightsail.model.DiskSnapshot

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DiskSnapshot.Builder,DiskSnapshot>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DiskSnapshot.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DiskSnapshot.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the disk snapshot.
`static DiskSnapshot.Builder`	`builder()`
`Instant`	`createdAt()` The date when the disk snapshot was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fromDiskArn()` The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
`String`	`fromDiskName()` The unique name of the source disk from which the disk snapshot was created.
`String`	`fromInstanceArn()` The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
`String`	`fromInstanceName()` The unique name of the source instance from which the disk (system volume) snapshot was created.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Boolean`	`isFromAutoSnapshot()` A Boolean value indicating whether the snapshot was created from an automatic snapshot.
`ResourceLocation`	`location()` The AWS Region and Availability Zone where the disk snapshot was created.
`String`	`name()` The name of the disk snapshot (e.g., `my-disk-snapshot`).
`String`	`progress()` The progress of the snapshot.
`ResourceType`	`resourceType()` The Lightsail resource type (e.g., `DiskSnapshot`).
`String`	`resourceTypeAsString()` The Lightsail resource type (e.g., `DiskSnapshot`).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DiskSnapshot.Builder>`	`serializableBuilderClass()`
`Integer`	`sizeInGb()` The size of the disk in GB.
`DiskSnapshotState`	`state()` The status of the disk snapshot operation.
`String`	`stateAsString()` The status of the disk snapshot operation.
`String`	`supportCode()` The support code.
`List<Tag>`	`tags()` The tag keys and optional values for the resource.
`DiskSnapshot.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
  - name
```
public final String name()
```
    The name of the disk snapshot (e.g., my-disk-snapshot).
    
    Returns:
    
    The name of the disk snapshot (e.g., 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 (e.g., 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 (e.g., DiskSnapshot).
    
    See Also:
    
    ResourceType
  - resourceTypeAsString
```
public final String resourceTypeAsString()
```
    The Lightsail resource type (e.g., 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 (e.g., DiskSnapshot).
    
    See Also:
    
    ResourceType
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev 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:
    
    DiskSnapshotState
  - 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:
    
    DiskSnapshotState
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DiskSnapshot.Builder,DiskSnapshot>
  - 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)
```
    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

Class DiskSnapshot

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

arn

supportCode

createdAt

location

resourceType

resourceTypeAsString

hasTags

tags

sizeInGb

state

stateAsString

progress

fromDiskName

fromDiskArn

fromInstanceName

fromInstanceArn

isFromAutoSnapshot

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields