Package com.google.cloud.baremetalsolution.v2

Interface VolumeOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Volume, Volume.Builder
    public interface VolumeOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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];
        Returns:
        The name.

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • getId

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

      • getIdBytes

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

      • getStorageTypeValue

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

      • getStorageType

        Volume.StorageType getStorageType()
         The storage type for this volume.
        .google.cloud.baremetalsolution.v2.Volume.StorageType storage_type = 2;
        Returns:
        The storageType.

      • getStateValue

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

      • getState

        Volume.State getState()
         The state of this storage volume.
        .google.cloud.baremetalsolution.v2.Volume.State state = 3;
        Returns:
        The state.

      • getRequestedSizeGib

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

      • getOriginallyRequestedSizeGib

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

      • getCurrentSizeGib

        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;
        Returns:
        The currentSizeGib.

      • getEmergencySizeGib

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

      • getMaxSizeGib

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

      • getAutoGrownSizeGib

        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;
        Returns:
        The autoGrownSizeGib.

      • getRemainingSpaceGib

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

      • hasSnapshotReservationDetail

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

      • getSnapshotReservationDetail

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

      • getSnapshotReservationDetailOrBuilder

        Volume.SnapshotReservationDetailOrBuilder getSnapshotReservationDetailOrBuilder()
         Details about snapshot space reservation and usage on the storage volume.
        .google.cloud.baremetalsolution.v2.Volume.SnapshotReservationDetail snapshot_reservation_detail = 8;

      • getSnapshotAutoDeleteBehaviorValue

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

      • getSnapshotAutoDeleteBehavior

        Volume.SnapshotAutoDeleteBehavior getSnapshotAutoDeleteBehavior()
         The behavior to use when snapshot reserved space is full.
        .google.cloud.baremetalsolution.v2.Volume.SnapshotAutoDeleteBehavior snapshot_auto_delete_behavior = 9;
        Returns:
        The snapshotAutoDeleteBehavior.

      • getLabelsCount

        int getLabelsCount()
         Labels as key value pairs.
        map<string, string> labels = 12;

      • containsLabels

        boolean containsLabels​(String key)
         Labels as key value pairs.
        map<string, string> labels = 12;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Labels as key value pairs.
        map<string, string> labels = 12;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Labels as key value pairs.
        map<string, string> labels = 12;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Labels as key value pairs.
        map<string, string> labels = 12;

      • getSnapshotEnabled

        boolean getSnapshotEnabled()
         Whether snapshots are enabled.
        bool snapshot_enabled = 13;
        Returns:
        The snapshotEnabled.

      • getPod

        String getPod()
         Immutable. Pod name.
        string pod = 15 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The pod.

      • getPodBytes

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

      • getProtocolValue

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

      • getProtocol

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

      • getBootVolume

        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];
        Returns:
        The bootVolume.

      • getPerformanceTierValue

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

      • getPerformanceTier

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

      • getNotes

        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];
        Returns:
        The notes.

      • getNotesBytes

        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];
        Returns:
        The bytes for notes.

      • getWorkloadProfileValue

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

      • getWorkloadProfile

        Volume.WorkloadProfile getWorkloadProfile()
         The workload profile for the volume.
        .google.cloud.baremetalsolution.v2.Volume.WorkloadProfile workload_profile = 22;
        Returns:
        The workloadProfile.

      • hasExpireTime

        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];
        Returns:
        Whether the expireTime field is set.

      • getExpireTime

        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];
        Returns:
        The expireTime.

      • getExpireTimeOrBuilder

        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];

      • getInstancesList

        List<String> 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) = { ... }
        Returns:
        A list containing the instances.

      • getInstancesCount

        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) = { ... }
        Returns:
        The count of instances.

      • getInstances

        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) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The instances at the given index.

      • getInstancesBytes

        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) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the instances at the given index.

      • getAttached

        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];
        Returns:
        The attached.