Snapshot (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.fsx.model.Snapshot

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

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

A snapshot of an Amazon FSx for OpenZFS volume.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Snapshot.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AdministrativeAction>`	`administrativeActions()` A list of administrative actions for the file system that are in process or waiting to be processed.
`static Snapshot.Builder`	`builder()`
`Instant`	`creationTime()` Returns the value of the CreationTime property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdministrativeActions()` For responses, this returns true if the service returned a value for the AdministrativeActions property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`SnapshotLifecycle`	`lifecycle()` The lifecycle status of the snapshot.
`String`	`lifecycleAsString()` The lifecycle status of the snapshot.
`LifecycleTransitionReason`	`lifecycleTransitionReason()` Returns the value of the LifecycleTransitionReason property for this object.
`String`	`name()` The name of the snapshot.
`String`	`resourceARN()` Returns the value of the ResourceARN property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Snapshot.Builder>`	`serializableBuilderClass()`
`String`	`snapshotId()` The ID of the snapshot.
`List<Tag>`	`tags()` Returns the value of the Tags property for this object.
`Snapshot.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`volumeId()` The ID of the volume that the snapshot is of.

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
  - resourceARN
```
public final String resourceARN()
```
    Returns the value of the ResourceARN property for this object.
    
    Returns:
    
    The value of the ResourceARN property for this object.
  - snapshotId
```
public final String snapshotId()
```
    The ID of the snapshot.
    
    Returns:
    
    The ID of the snapshot.
  - name
```
public final String name()
```
    The name of the snapshot.
    
    Returns:
    
    The name of the snapshot.
  - volumeId
```
public final String volumeId()
```
    The ID of the volume that the snapshot is of.
    
    Returns:
    
    The ID of the volume that the snapshot is of.
  - creationTime
```
public final Instant creationTime()
```
    Returns the value of the CreationTime property for this object.
    
    Returns:
    
    The value of the CreationTime property for this object.
  - lifecycle
```
public final SnapshotLifecycle lifecycle()
```
    The lifecycle status of the snapshot.
    - PENDING - Amazon FSx hasn't started creating the snapshot.
    - CREATING - Amazon FSx is creating the snapshot.
    - DELETING - Amazon FSx is deleting the snapshot.
    - AVAILABLE - The snapshot is fully available.
    If the service returns an enum value that is not available in the current SDK version, lifecycle will return SnapshotLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().
    Returns:
    The lifecycle status of the snapshot.
    
    PENDING - Amazon FSx hasn't started creating the snapshot.
    
    CREATING - Amazon FSx is creating the snapshot.
    
    DELETING - Amazon FSx is deleting the snapshot.
    
    AVAILABLE - The snapshot is fully available.
    See Also:
    
    SnapshotLifecycle
  - lifecycleAsString
```
public final String lifecycleAsString()
```
    The lifecycle status of the snapshot.
    - PENDING - Amazon FSx hasn't started creating the snapshot.
    - CREATING - Amazon FSx is creating the snapshot.
    - DELETING - Amazon FSx is deleting the snapshot.
    - AVAILABLE - The snapshot is fully available.
    If the service returns an enum value that is not available in the current SDK version, lifecycle will return SnapshotLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().
    Returns:
    The lifecycle status of the snapshot.
    
    PENDING - Amazon FSx hasn't started creating the snapshot.
    
    CREATING - Amazon FSx is creating the snapshot.
    
    DELETING - Amazon FSx is deleting the snapshot.
    
    AVAILABLE - The snapshot is fully available.
    See Also:
    
    SnapshotLifecycle
  - lifecycleTransitionReason
```
public final LifecycleTransitionReason lifecycleTransitionReason()
```
    Returns the value of the LifecycleTransitionReason property for this object.
    
    Returns:
    
    The value of the LifecycleTransitionReason property for this object.
  - 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()
```
    Returns the value of the Tags property for this object.
    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 value of the Tags property for this object.
  - hasAdministrativeActions
```
public final boolean hasAdministrativeActions()
```
    For responses, this returns true if the service returned a value for the AdministrativeActions 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.
  - administrativeActions
```
public final List<AdministrativeAction> administrativeActions()
```
    A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.
    
    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 hasAdministrativeActions() method.
    
    Returns:
    
    A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.
  - toBuilder
```
public Snapshot.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Snapshot.Builder,Snapshot>
  - builder
```
public static Snapshot.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Snapshot.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 Snapshot

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

resourceARN

snapshotId

name

volumeId

creationTime

lifecycle

lifecycleAsString

lifecycleTransitionReason

hasTags

tags

hasAdministrativeActions

administrativeActions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields