Class SnapshotInfo

java.lang.Object
software.amazon.awssdk.services.ec2.model.SnapshotInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SnapshotInfo.Builder,SnapshotInfo>
@Generated("software.amazon.awssdk:codegen") public final class SnapshotInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SnapshotInfo.Builder,SnapshotInfo>

Information about a snapshot.

See Also:

  • Method Details

    • 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:

    • 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:

    • 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 EBS 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 EBS User Guide.

    • sseType

      public final SSEType sseType()

      Reserved for future use.

      If the service returns an enum value that is not available in the current SDK version, sseType will return SSEType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sseTypeAsString().

      Returns:
      Reserved for future use.
      See Also:

    • sseTypeAsString

      public final String sseTypeAsString()

      Reserved for future use.

      If the service returns an enum value that is not available in the current SDK version, sseType will return SSEType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sseTypeAsString().

      Returns:
      Reserved for future use.
      See Also:

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone or Local Zone of the snapshots. For example, us-west-1a (Availability Zone) or us-west-2-lax-1a (Local Zone).

      Returns:
      The Availability Zone or Local Zone of the snapshots. For example, us-west-1a (Availability Zone) or us-west-2-lax-1a (Local Zone).

    • toBuilder

      public SnapshotInfo.Builder 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 interface ToCopyableBuilder<SnapshotInfo.Builder,SnapshotInfo>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.