SnapshotInfo (AWS Java SDK :: Services :: Amazon EC2 2.20.53 API)

java.lang.Object
- software.amazon.awssdk.services.ec2.model.SnapshotInfo

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

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

Information about a snapshot.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SnapshotInfo.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SnapshotInfo.Builder`	`builder()`
`String`	`description()` Description specified by the CreateSnapshotRequest that has been applied to all snapshots.
`Boolean`	`encrypted()` Indicates whether the snapshot is encrypted.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`outpostArn()` The ARN of the Outpost on which the snapshot is stored.
`String`	`ownerId()` Account id used when creating this snapshot.
`String`	`progress()` Progress this snapshot has made towards completing.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SnapshotInfo.Builder>`	`serializableBuilderClass()`
`String`	`snapshotId()` Snapshot id that can be used to describe this snapshot.
`Instant`	`startTime()` Time this snapshot was started.
`SnapshotState`	`state()` Current state of the snapshot.
`String`	`stateAsString()` Current state of the snapshot.
`List<Tag>`	`tags()` Tags associated with this snapshot.
`SnapshotInfo.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`volumeId()` Source volume from which this snapshot was created.
`Integer`	`volumeSize()` Size of the volume from which this snapshot was created.

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
  - description
```
public final String description()
```
    Description specified by the CreateSnapshotRequest that has been applied to all snapshots.
    
    Returns:
    
    Description specified by the CreateSnapshotRequest that has been applied to all snapshots.
  - 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()
```
    Tags associated with this snapshot.
    
    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:
    
    Tags associated with this snapshot.
  - encrypted
```
public final Boolean encrypted()
```
    Indicates whether the snapshot is encrypted.
    
    Returns:
    
    Indicates whether the snapshot is encrypted.
  - volumeId
```
public final String volumeId()
```
    Source volume from which this snapshot was created.
    
    Returns:
    
    Source volume from which this snapshot was created.
  - state
```
public final SnapshotState state()
```
    Current state of the snapshot.
    
    If the service returns an enum value that is not available in the current SDK version, state will return SnapshotState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    Current state of the snapshot.
    
    See Also:
    
    SnapshotState
  - stateAsString
```
public final String stateAsString()
```
    Current state of the snapshot.
    
    If the service returns an enum value that is not available in the current SDK version, state will return SnapshotState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    Current state of the snapshot.
    
    See Also:
    
    SnapshotState
  - volumeSize
```
public final Integer volumeSize()
```
    Size of the volume from which this snapshot was created.
    
    Returns:
    
    Size of the volume from which this snapshot was created.
  - startTime
```
public final Instant startTime()
```
    Time this snapshot was started. This is the same for all snapshots initiated by the same request.
    
    Returns:
    
    Time this snapshot was started. This is the same for all snapshots initiated by the same request.
  - progress
```
public final String progress()
```
    Progress this snapshot has made towards completing.
    
    Returns:
    
    Progress this snapshot has made towards completing.
  - ownerId
```
public final String ownerId()
```
    Account id used when creating this snapshot.
    
    Returns:
    
    Account id used when creating this snapshot.
  - snapshotId
```
public final String snapshotId()
```
    Snapshot id that can be used to describe this snapshot.
    
    Returns:
    
    Snapshot id that can be used to describe this snapshot.
  - outpostArn
```
public final String outpostArn()
```
    The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
  - toBuilder
```
public SnapshotInfo.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SnapshotInfo.Builder,SnapshotInfo>
  - builder
```
public static SnapshotInfo.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SnapshotInfo.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 SnapshotInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

description

hasTags

tags

encrypted

volumeId

state

stateAsString

volumeSize

startTime

progress

ownerId

snapshotId

outpostArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields