Class ModifyVolumeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.workspacesinstances.model.WorkspacesInstancesRequest
software.amazon.awssdk.services.workspacesinstances.model.ModifyVolumeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyVolumeRequest extends WorkspacesInstancesRequest implements ToCopyableBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>

Contains the parameters for modifying a volume, including the target size, volume type, IOPS, or throughput.

  • Method Details

    • volumeId

      public final String volumeId()

      Specifies the identifier of the volume to modify.

      Returns:
      Specifies the identifier of the volume to modify.

    • sizeInGB

      public final Integer sizeInGB()

      Specifies the target size of the volume, in GiB. The target size must be greater than or equal to the current size of the volume. If you don't specify a size, the current size is retained.

      Returns:
      Specifies the target size of the volume, in GiB. The target size must be greater than or equal to the current size of the volume. If you don't specify a size, the current size is retained.

    • volumeType

      public final VolumeTypeEnum volumeType()

      Specifies the target Amazon Elastic Block Store (Amazon EBS) volume type. If you don't specify a volume type, the current volume type is retained.

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

      Returns:
      Specifies the target Amazon Elastic Block Store (Amazon EBS) volume type. If you don't specify a volume type, the current volume type is retained.
      See Also:

    • volumeTypeAsString

      public final String volumeTypeAsString()

      Specifies the target Amazon Elastic Block Store (Amazon EBS) volume type. If you don't specify a volume type, the current volume type is retained.

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

      Returns:
      Specifies the target Amazon Elastic Block Store (Amazon EBS) volume type. If you don't specify a volume type, the current volume type is retained.
      See Also:

    • iops

      public final Integer iops()

      Specifies the target IOPS rate of the volume. This parameter is valid only for gp3, io1 , and io2 volumes. If you don't specify IOPS and keep the same volume type, the current IOPS rate is retained.

      Returns:
      Specifies the target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes. If you don't specify IOPS and keep the same volume type, the current IOPS rate is retained.

    • throughput

      public final Integer throughput()

      Specifies the target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. If you don't specify throughput and the volume remains gp3, the current throughput is retained.

      Returns:
      Specifies the target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. If you don't specify throughput and the volume remains gp3, the current throughput is retained.

    • clientToken

      public final String clientToken()

      Unique token to ensure idempotent volume modification, preventing duplicate volume modifications.

      Returns:
      Unique token to ensure idempotent volume modification, preventing duplicate volume modifications.

    • toBuilder

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

    • builder

      public static ModifyVolumeRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.