Class Snapshot
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Snapshot.Builder,
Snapshot>
A snapshot of an Amazon FSx for OpenZFS volume.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AdministrativeAction> A list of administrative actions for the file system that are in process or waiting to be processed.static Snapshot.Builder
builder()
final Instant
Returns the value of the CreationTime property for this object.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdministrativeActions property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final SnapshotLifecycle
The lifecycle status of the snapshot.final String
The lifecycle status of the snapshot.Returns the value of the LifecycleTransitionReason property for this object.final String
name()
The name of the snapshot.final String
Returns the value of the ResourceARN property for this object.static Class
<? extends Snapshot.Builder> final String
The ID of the snapshot.tags()
Returns the value of the Tags property for this object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
volumeId()
The ID of the volume that the snapshot is of.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
resourceARN
Returns the value of the ResourceARN property for this object.- Returns:
- The value of the ResourceARN property for this object.
-
snapshotId
The ID of the snapshot.
- Returns:
- The ID of the snapshot.
-
name
The name of the snapshot.
- Returns:
- The name of the snapshot.
-
volumeId
The ID of the volume that the snapshot is of.
- Returns:
- The ID of the volume that the snapshot is of.
-
creationTime
Returns the value of the CreationTime property for this object.- Returns:
- The value of the CreationTime property for this object.
-
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 returnSnapshotLifecycle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleAsString()
.- 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:
-
-
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 returnSnapshotLifecycle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleAsString()
.- 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:
-
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<Snapshot.Builder,
Snapshot> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-