Class StartSnapshotResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.ebs.model.EbsResponse
software.amazon.awssdk.services.ebs.model.StartSnapshotResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartSnapshotResponse.Builder,StartSnapshotResponse>
@Generated("software.amazon.awssdk:codegen") public final class StartSnapshotResponse extends EbsResponse implements ToCopyableBuilder<StartSnapshotResponse.Builder,StartSnapshotResponse>

  • Method Details

    • description

      public final String description()

      The description of the snapshot.

      Returns:
      The description of the snapshot.

    • snapshotId

      public final String snapshotId()

      The ID of the snapshot.

      Returns:
      The ID of the snapshot.

    • ownerId

      public final String ownerId()

      The Amazon Web Services account ID of the snapshot owner.

      Returns:
      The Amazon Web Services account ID of the snapshot owner.

    • status

      public final Status status()

      The status of the snapshot.

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

      Returns:
      The status of the snapshot.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the snapshot.

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

      Returns:
      The status of the snapshot.
      See Also:

    • startTime

      public final Instant startTime()

      The timestamp when the snapshot was created.

      Returns:
      The timestamp when the snapshot was created.

    • volumeSize

      public final Long volumeSize()

      The size of the volume, in GiB.

      Returns:
      The size of the volume, in GiB.

    • blockSize

      public final Integer blockSize()

      The size of the blocks in the snapshot, in bytes.

      Returns:
      The size of the blocks in the snapshot, in bytes.

    • 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 tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User 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 tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

    • parentSnapshotId

      public final String parentSnapshotId()

      The ID of the parent snapshot.

      Returns:
      The ID of the parent snapshot.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.

      Returns:
      The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.

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

    • toBuilder

      public StartSnapshotResponse.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<StartSnapshotResponse.Builder,StartSnapshotResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static StartSnapshotResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartSnapshotResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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