Class AttachVolumeResponse

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

Describes volume attachment details.

  • Method Details

    • deleteOnTermination

      public final Boolean deleteOnTermination()

      Indicates whether the EBS volume is deleted on instance termination.

      Returns:
      Indicates whether the EBS volume is deleted on instance termination.

    • associatedResource

      public final String associatedResource()

      The ARN of the Amazon ECS or Fargate task to which the volume is attached.

      Returns:
      The ARN of the Amazon ECS or Fargate task to which the volume is attached.

    • instanceOwningService

      public final String instanceOwningService()

      The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.

      This parameter is returned only for volumes that are attached to Fargate tasks.

      Returns:
      The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.

      This parameter is returned only for volumes that are attached to Fargate tasks.

    • volumeId

      public final String volumeId()

      The ID of the volume.

      Returns:
      The ID of the volume.

    • instanceId

      public final String instanceId()

      The ID of the instance.

      If the volume is attached to a Fargate task, this parameter returns null.

      Returns:
      The ID of the instance.

      If the volume is attached to a Fargate task, this parameter returns null.

    • device

      public final String device()

      The device name.

      If the volume is attached to a Fargate task, this parameter returns null.

      Returns:
      The device name.

      If the volume is attached to a Fargate task, this parameter returns null.

    • state

      public final VolumeAttachmentState state()

      The attachment state of the volume.

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

      Returns:
      The attachment state of the volume.
      See Also:

    • stateAsString

      public final String stateAsString()

      The attachment state of the volume.

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

      Returns:
      The attachment state of the volume.
      See Also:

    • attachTime

      public final Instant attachTime()

      The time stamp when the attachment initiated.

      Returns:
      The time stamp when the attachment initiated.

    • toBuilder

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

    • builder

      public static AttachVolumeResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AttachVolumeResponse.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.