InstanceSnapshot (AWS Java SDK :: Services :: Amazon Lightsail 2.18.21 API)

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

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

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

Describes an instance snapshot.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface InstanceSnapshot.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InstanceSnapshot.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 snapshot (e.g., `arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE`).
`static InstanceSnapshot.Builder`	`builder()`
`Instant`	`createdAt()` The timestamp when the snapshot was created (e.g., `1479907467.024`).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Disk>`	`fromAttachedDisks()` An array of disk objects containing information about all block storage disks.
`String`	`fromBlueprintId()` The blueprint ID from which you created the snapshot (e.g., `os_debian_8_3`).
`String`	`fromBundleId()` The bundle ID from which you created the snapshot (e.g., `micro_1_0`).
`String`	`fromInstanceArn()` The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., `arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE`).
`String`	`fromInstanceName()` The instance from which the snapshot was created.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFromAttachedDisks()` For responses, this returns true if the service returned a value for the FromAttachedDisks property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`Boolean`	`isFromAutoSnapshot()` A Boolean value indicating whether the snapshot was created from an automatic snapshot.
`ResourceLocation`	`location()` The region name and Availability Zone where you created the snapshot.
`String`	`name()` The name of the snapshot.
`String`	`progress()` The progress of the snapshot.
`ResourceType`	`resourceType()` The type of resource (usually `InstanceSnapshot`).
`String`	`resourceTypeAsString()` The type of resource (usually `InstanceSnapshot`).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InstanceSnapshot.Builder>`	`serializableBuilderClass()`
`Integer`	`sizeInGb()` The size in GB of the SSD.
`InstanceSnapshotState`	`state()` The state the snapshot is in.
`String`	`stateAsString()` The state the snapshot is in.
`String`	`supportCode()` The support code.
`List<Tag>`	`tags()` The tag keys and optional values for the resource.
`InstanceSnapshot.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 snapshot.
    
    Returns:
    
    The name of the snapshot.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
    
    Returns:
    
    The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE ).
  - 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 timestamp when the snapshot was created (e.g., 1479907467.024).
    
    Returns:
    
    The timestamp when the snapshot was created (e.g., 1479907467.024).
  - location
```
public final ResourceLocation location()
```
    The region name and Availability Zone where you created the snapshot.
    
    Returns:
    
    The region name and Availability Zone where you created the snapshot.
  - resourceType
```
public final ResourceType resourceType()
```
    The type of resource (usually InstanceSnapshot).
    
    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 type of resource (usually InstanceSnapshot).
    
    See Also:
    
    ResourceType
  - resourceTypeAsString
```
public final String resourceTypeAsString()
```
    The type of resource (usually InstanceSnapshot).
    
    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 type of resource (usually InstanceSnapshot).
    
    See Also:
    
    ResourceType
  - 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.
  - state
```
public final InstanceSnapshotState state()
```
    The state the snapshot is in.
    
    If the service returns an enum value that is not available in the current SDK version, state will return InstanceSnapshotState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state the snapshot is in.
    
    See Also:
    
    InstanceSnapshotState
  - stateAsString
```
public final String stateAsString()
```
    The state the snapshot is in.
    
    If the service returns an enum value that is not available in the current SDK version, state will return InstanceSnapshotState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state the snapshot is in.
    
    See Also:
    
    InstanceSnapshotState
  - progress
```
public final String progress()
```
    The progress of the snapshot.
    
    This is populated only for disk snapshots, and is null for instance snapshots.
    
    Returns:
    
    The progress of the snapshot.
    
    This is populated only for disk snapshots, and is null for instance snapshots.
  - hasFromAttachedDisks
```
public final boolean hasFromAttachedDisks()
```
    For responses, this returns true if the service returned a value for the FromAttachedDisks 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.
  - fromAttachedDisks
```
public final List<Disk> fromAttachedDisks()
```
    An array of disk objects containing information about all block storage disks.
    
    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 hasFromAttachedDisks() method.
    
    Returns:
    
    An array of disk objects containing information about all block storage disks.
  - fromInstanceName
```
public final String fromInstanceName()
```
    The instance from which the snapshot was created.
    
    Returns:
    
    The instance from which the snapshot was created.
  - fromInstanceArn
```
public final String fromInstanceArn()
```
    The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
    
    Returns:
    
    The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
  - fromBlueprintId
```
public final String fromBlueprintId()
```
    The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.
    
    Returns:
    
    The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.
  - fromBundleId
```
public final String fromBundleId()
```
    The bundle ID from which you created the snapshot (e.g., micro_1_0).
    
    Returns:
    
    The bundle ID from which you created the snapshot (e.g., micro_1_0).
  - 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.
  - sizeInGb
```
public final Integer sizeInGb()
```
    The size in GB of the SSD.
    
    Returns:
    
    The size in GB of the SSD.
  - toBuilder
```
public InstanceSnapshot.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InstanceSnapshot.Builder,InstanceSnapshot>
  - builder
```
public static InstanceSnapshot.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InstanceSnapshot.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 InstanceSnapshot

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

state

stateAsString

progress

hasFromAttachedDisks

fromAttachedDisks

fromInstanceName

fromInstanceArn

fromBlueprintId

fromBundleId

isFromAutoSnapshot

sizeInGb

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields