Package com.ibm.cloud.is.vpc.v1.model

Class VolumePatch

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class VolumePatch
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    VolumePatch.

    • Method Detail

      • newBuilder

        public VolumePatch.Builder newBuilder()
        New builder.
        Returns:
        a VolumePatch builder

      • capacity

        public Long capacity()
        Gets the capacity. The capacity to use for the volume (in gigabytes). For the capacity to be changed the volume's current `attachment_state` must be one of the values included in `adjustable_capacity_states`. If `adjustable_capacity_states` is empty, then the volume capacity cannot be changed. Additionally: - The specified value must not be less than the current capacity. - If the volume is attached as a boot volume, the specified value must not exceed the `boot_capacity.max` of the volume profile. - If the volume is attached as a data volume, the specified value must not exceed the `capacity.max` of the volume profile.
        Returns:
        the capacity

      • iops

        public Long iops()
        Gets the iops. The maximum I/O operations per second (IOPS) to use for this volume. For the IOPS to be changed the volume's current `attachment_state` must be one of the values included in `adjustable_iops_states`. If `adjustable_iops_states` is empty, then the IOPS cannot be changed.
        Returns:
        the iops

      • name

        public String name()
        Gets the name. The name for this volume. The name must not be used by another volume in the region.
        Returns:
        the name

      • profile

        public VolumeProfileIdentity profile()
        Gets the profile. The profile to use for this volume. The requested profile must be in the same `family` as the current profile. Additionally: - If the volume is a boot volume then the value specified for `capacity` property must not be less than the `boot_capacity.min` and must not exceed the `boot_capacity.max` of the specified volume profile. - If the volume is a data volume then the value specified for `capacity` property must not be less than the `capacity.min` and must not exceed the `capacity.max` of the specified volume profile.
        Returns:
        the profile

      • userTags

        public List<String> userTags()
        Gets the userTags. The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this volume.
        Returns:
        the userTags

      • asPatch

        public Map<String,​Object> asPatch()
        Construct a JSON merge-patch from the VolumePatch. Note that properties of the VolumePatch with null values are not represented in the constructed JSON merge-patch object, but can be explicitly set afterward to signify a property delete.
        Returns:
        a JSON merge-patch for the VolumePatch