Package com.google.cloud.baremetalsolution.v2

Class Volume

  • All Implemented Interfaces:
    VolumeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Volume
extends com.google.protobuf.GeneratedMessageV3
implements VolumeOrBuilder
     A storage volume.
    Protobuf type google.cloud.baremetalsolution.v2.Volume
    See Also:
    Serialized Form

    • Field Detail

      • STORAGE_TYPE_FIELD_NUMBER

        public static final int STORAGE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUESTED_SIZE_GIB_FIELD_NUMBER

        public static final int REQUESTED_SIZE_GIB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ORIGINALLY_REQUESTED_SIZE_GIB_FIELD_NUMBER

        public static final int ORIGINALLY_REQUESTED_SIZE_GIB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENT_SIZE_GIB_FIELD_NUMBER

        public static final int CURRENT_SIZE_GIB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EMERGENCY_SIZE_GIB_FIELD_NUMBER

        public static final int EMERGENCY_SIZE_GIB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_SIZE_GIB_FIELD_NUMBER

        public static final int MAX_SIZE_GIB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTO_GROWN_SIZE_GIB_FIELD_NUMBER

        public static final int AUTO_GROWN_SIZE_GIB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REMAINING_SPACE_GIB_FIELD_NUMBER

        public static final int REMAINING_SPACE_GIB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SNAPSHOT_RESERVATION_DETAIL_FIELD_NUMBER

        public static final int SNAPSHOT_RESERVATION_DETAIL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SNAPSHOT_AUTO_DELETE_BEHAVIOR_FIELD_NUMBER

        public static final int SNAPSHOT_AUTO_DELETE_BEHAVIOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SNAPSHOT_ENABLED_FIELD_NUMBER

        public static final int SNAPSHOT_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BOOT_VOLUME_FIELD_NUMBER

        public static final int BOOT_VOLUME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PERFORMANCE_TIER_FIELD_NUMBER

        public static final int PERFORMANCE_TIER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKLOAD_PROFILE_FIELD_NUMBER

        public static final int WORKLOAD_PROFILE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPIRE_TIME_FIELD_NUMBER

        public static final int EXPIRE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The resource name of this `Volume`.
 Resource names are schemeless URIs that follow the conventions in
 https://cloud.google.com/apis/design/resource_names.
 Format:
 `projects/{project}/locations/{location}/volumes/{volume}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface VolumeOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of this `Volume`.
 Resource names are schemeless URIs that follow the conventions in
 https://cloud.google.com/apis/design/resource_names.
 Format:
 `projects/{project}/locations/{location}/volumes/{volume}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface VolumeOrBuilder
        Returns:
        The bytes for name.

      • getId

        public String getId()
         An identifier for the `Volume`, generated by the backend.
        string id = 11;
        Specified by:
        getId in interface VolumeOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         An identifier for the `Volume`, generated by the backend.
        string id = 11;
        Specified by:
        getIdBytes in interface VolumeOrBuilder
        Returns:
        The bytes for id.

      • getStorageTypeValue

        public int getStorageTypeValue()
         The storage type for this volume.
        .google.cloud.baremetalsolution.v2.Volume.StorageType storage_type = 2;
        Specified by:
        getStorageTypeValue in interface VolumeOrBuilder
        Returns:
        The enum numeric value on the wire for storageType.

      • getStorageType

        public Volume.StorageType getStorageType()
         The storage type for this volume.
        .google.cloud.baremetalsolution.v2.Volume.StorageType storage_type = 2;
        Specified by:
        getStorageType in interface VolumeOrBuilder
        Returns:
        The storageType.

      • getStateValue

        public int getStateValue()
         The state of this storage volume.
        .google.cloud.baremetalsolution.v2.Volume.State state = 3;
        Specified by:
        getStateValue in interface VolumeOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Volume.State getState()
         The state of this storage volume.
        .google.cloud.baremetalsolution.v2.Volume.State state = 3;
        Specified by:
        getState in interface VolumeOrBuilder
        Returns:
        The state.

      • getRequestedSizeGib

        public long getRequestedSizeGib()
         The requested size of this storage volume, in GiB.
        int64 requested_size_gib = 4;
        Specified by:
        getRequestedSizeGib in interface VolumeOrBuilder
        Returns:
        The requestedSizeGib.

      • getOriginallyRequestedSizeGib

        public long getOriginallyRequestedSizeGib()
         Originally requested size, in GiB.
        int64 originally_requested_size_gib = 16;
        Specified by:
        getOriginallyRequestedSizeGib in interface VolumeOrBuilder
        Returns:
        The originallyRequestedSizeGib.

      • getCurrentSizeGib

        public long getCurrentSizeGib()
         The current size of this storage volume, in GiB, including space reserved
 for snapshots. This size might be different than the requested size if the
 storage volume has been configured with auto grow or auto shrink.
        int64 current_size_gib = 5;
        Specified by:
        getCurrentSizeGib in interface VolumeOrBuilder
        Returns:
        The currentSizeGib.

      • getEmergencySizeGib

        public long getEmergencySizeGib()
         Additional emergency size that was requested for this Volume, in GiB.
 current_size_gib includes this value.
        int64 emergency_size_gib = 14;
        Specified by:
        getEmergencySizeGib in interface VolumeOrBuilder
        Returns:
        The emergencySizeGib.

      • getMaxSizeGib

        public long getMaxSizeGib()
         Maximum size volume can be expanded to in case of evergency, in GiB.
        int64 max_size_gib = 17;
        Specified by:
        getMaxSizeGib in interface VolumeOrBuilder
        Returns:
        The maxSizeGib.

      • getAutoGrownSizeGib

        public long getAutoGrownSizeGib()
         The size, in GiB, that this storage volume has expanded as a result of an
 auto grow policy. In the absence of auto-grow, the value is 0.
        int64 auto_grown_size_gib = 6;
        Specified by:
        getAutoGrownSizeGib in interface VolumeOrBuilder
        Returns:
        The autoGrownSizeGib.

      • getRemainingSpaceGib

        public long getRemainingSpaceGib()
         The space remaining in the storage volume for new LUNs, in GiB, excluding
 space reserved for snapshots.
        int64 remaining_space_gib = 7;
        Specified by:
        getRemainingSpaceGib in interface VolumeOrBuilder
        Returns:
        The remainingSpaceGib.

      • hasSnapshotReservationDetail

        public boolean hasSnapshotReservationDetail()
         Details about snapshot space reservation and usage on the storage volume.
        .google.cloud.baremetalsolution.v2.Volume.SnapshotReservationDetail snapshot_reservation_detail = 8;
        Specified by:
        hasSnapshotReservationDetail in interface VolumeOrBuilder
        Returns:
        Whether the snapshotReservationDetail field is set.

      • getSnapshotReservationDetail

        public Volume.SnapshotReservationDetail getSnapshotReservationDetail()
         Details about snapshot space reservation and usage on the storage volume.
        .google.cloud.baremetalsolution.v2.Volume.SnapshotReservationDetail snapshot_reservation_detail = 8;
        Specified by:
        getSnapshotReservationDetail in interface VolumeOrBuilder
        Returns:
        The snapshotReservationDetail.

      • getSnapshotAutoDeleteBehaviorValue

        public int getSnapshotAutoDeleteBehaviorValue()
         The behavior to use when snapshot reserved space is full.
        .google.cloud.baremetalsolution.v2.Volume.SnapshotAutoDeleteBehavior snapshot_auto_delete_behavior = 9;
        Specified by:
        getSnapshotAutoDeleteBehaviorValue in interface VolumeOrBuilder
        Returns:
        The enum numeric value on the wire for snapshotAutoDeleteBehavior.

      • containsLabels

        public boolean containsLabels​(String key)
         Labels as key value pairs.
        map<string, string> labels = 12;
        Specified by:
        containsLabels in interface VolumeOrBuilder

      • getSnapshotEnabled

        public boolean getSnapshotEnabled()
         Whether snapshots are enabled.
        bool snapshot_enabled = 13;
        Specified by:
        getSnapshotEnabled in interface VolumeOrBuilder
        Returns:
        The snapshotEnabled.

      • getPod

        public String getPod()
         Immutable. Pod name.
        string pod = 15 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPod in interface VolumeOrBuilder
        Returns:
        The pod.

      • getPodBytes

        public com.google.protobuf.ByteString getPodBytes()
         Immutable. Pod name.
        string pod = 15 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPodBytes in interface VolumeOrBuilder
        Returns:
        The bytes for pod.

      • getProtocolValue

        public int getProtocolValue()
         Output only. Storage protocol for the Volume.
        .google.cloud.baremetalsolution.v2.Volume.Protocol protocol = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getProtocolValue in interface VolumeOrBuilder
        Returns:
        The enum numeric value on the wire for protocol.

      • getProtocol

        public Volume.Protocol getProtocol()
         Output only. Storage protocol for the Volume.
        .google.cloud.baremetalsolution.v2.Volume.Protocol protocol = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getProtocol in interface VolumeOrBuilder
        Returns:
        The protocol.

      • getBootVolume

        public boolean getBootVolume()
         Output only. Whether this volume is a boot volume. A boot volume is one
 which contains a boot LUN.
        bool boot_volume = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getBootVolume in interface VolumeOrBuilder
        Returns:
        The bootVolume.

      • getPerformanceTierValue

        public int getPerformanceTierValue()
         Immutable. Performance tier of the Volume.
 Default is SHARED.
        .google.cloud.baremetalsolution.v2.VolumePerformanceTier performance_tier = 20 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPerformanceTierValue in interface VolumeOrBuilder
        Returns:
        The enum numeric value on the wire for performanceTier.

      • getPerformanceTier

        public VolumePerformanceTier getPerformanceTier()
         Immutable. Performance tier of the Volume.
 Default is SHARED.
        .google.cloud.baremetalsolution.v2.VolumePerformanceTier performance_tier = 20 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPerformanceTier in interface VolumeOrBuilder
        Returns:
        The performanceTier.

      • getNotes

        public String getNotes()
         Input only. User-specified notes for new Volume.
 Used to provision Volumes that require manual intervention.
        string notes = 21 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getNotes in interface VolumeOrBuilder
        Returns:
        The notes.

      • getNotesBytes

        public com.google.protobuf.ByteString getNotesBytes()
         Input only. User-specified notes for new Volume.
 Used to provision Volumes that require manual intervention.
        string notes = 21 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getNotesBytes in interface VolumeOrBuilder
        Returns:
        The bytes for notes.

      • getWorkloadProfileValue

        public int getWorkloadProfileValue()
         The workload profile for the volume.
        .google.cloud.baremetalsolution.v2.Volume.WorkloadProfile workload_profile = 22;
        Specified by:
        getWorkloadProfileValue in interface VolumeOrBuilder
        Returns:
        The enum numeric value on the wire for workloadProfile.

      • getWorkloadProfile

        public Volume.WorkloadProfile getWorkloadProfile()
         The workload profile for the volume.
        .google.cloud.baremetalsolution.v2.Volume.WorkloadProfile workload_profile = 22;
        Specified by:
        getWorkloadProfile in interface VolumeOrBuilder
        Returns:
        The workloadProfile.

      • hasExpireTime

        public boolean hasExpireTime()
         Output only. Time after which volume will be fully deleted.
 It is filled only for volumes in COOLOFF state.
        .google.protobuf.Timestamp expire_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasExpireTime in interface VolumeOrBuilder
        Returns:
        Whether the expireTime field is set.

      • getExpireTime

        public com.google.protobuf.Timestamp getExpireTime()
         Output only. Time after which volume will be fully deleted.
 It is filled only for volumes in COOLOFF state.
        .google.protobuf.Timestamp expire_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getExpireTime in interface VolumeOrBuilder
        Returns:
        The expireTime.

      • getExpireTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
         Output only. Time after which volume will be fully deleted.
 It is filled only for volumes in COOLOFF state.
        .google.protobuf.Timestamp expire_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getExpireTimeOrBuilder in interface VolumeOrBuilder

      • getInstancesList

        public com.google.protobuf.ProtocolStringList getInstancesList()
         Output only. Instances this Volume is attached to.
 This field is set only in Get requests.
        repeated string instances = 25 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getInstancesList in interface VolumeOrBuilder
        Returns:
        A list containing the instances.

      • getInstancesCount

        public int getInstancesCount()
         Output only. Instances this Volume is attached to.
 This field is set only in Get requests.
        repeated string instances = 25 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getInstancesCount in interface VolumeOrBuilder
        Returns:
        The count of instances.

      • getInstances

        public String getInstances​(int index)
         Output only. Instances this Volume is attached to.
 This field is set only in Get requests.
        repeated string instances = 25 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getInstances in interface VolumeOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The instances at the given index.

      • getInstancesBytes

        public com.google.protobuf.ByteString getInstancesBytes​(int index)
         Output only. Instances this Volume is attached to.
 This field is set only in Get requests.
        repeated string instances = 25 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getInstancesBytes in interface VolumeOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the instances at the given index.

      • getAttached

        public boolean getAttached()
         Output only. Is the Volume attached at at least one instance.
 This field is a lightweight counterpart of `instances` field.
 It is filled in List responses as well.
        bool attached = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttached in interface VolumeOrBuilder
        Returns:
        The attached.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Volume parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Volume parseFrom​(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Volume parseFrom​(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Volume parseFrom​(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Volume parseFrom​(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Volume parseFrom​(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Volume parseFrom​(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Volume.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Volume.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Volume.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Volume getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Volume> parser()

      • getParserForType

        public com.google.protobuf.Parser<Volume> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Volume getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder