Class Volume (0.48.0) 

public final class Volume extends GeneratedMessageV3 implements VolumeOrBuilder

A storage volume.

Protobuf type google.cloud.baremetalsolution.v2.Volume

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Volume

Implements

VolumeOrBuilder

Static Fields

ATTACHED_FIELD_NUMBER

public static final int ATTACHED_FIELD_NUMBER
Field Value
Type Description
int

AUTO_GROWN_SIZE_GIB_FIELD_NUMBER

public static final int AUTO_GROWN_SIZE_GIB_FIELD_NUMBER
Field Value
Type Description
int

BOOT_VOLUME_FIELD_NUMBER

public static final int BOOT_VOLUME_FIELD_NUMBER
Field Value
Type Description
int

CURRENT_SIZE_GIB_FIELD_NUMBER

public static final int CURRENT_SIZE_GIB_FIELD_NUMBER
Field Value
Type Description
int

EMERGENCY_SIZE_GIB_FIELD_NUMBER

public static final int EMERGENCY_SIZE_GIB_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

INSTANCES_FIELD_NUMBER

public static final int INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MAX_SIZE_GIB_FIELD_NUMBER

public static final int MAX_SIZE_GIB_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NOTES_FIELD_NUMBER

public static final int NOTES_FIELD_NUMBER
Field Value
Type Description
int

ORIGINALLY_REQUESTED_SIZE_GIB_FIELD_NUMBER

public static final int ORIGINALLY_REQUESTED_SIZE_GIB_FIELD_NUMBER
Field Value
Type Description
int

PERFORMANCE_TIER_FIELD_NUMBER

public static final int PERFORMANCE_TIER_FIELD_NUMBER
Field Value
Type Description
int

POD_FIELD_NUMBER

public static final int POD_FIELD_NUMBER
Field Value
Type Description
int

PROTOCOL_FIELD_NUMBER

public static final int PROTOCOL_FIELD_NUMBER
Field Value
Type Description
int

REMAINING_SPACE_GIB_FIELD_NUMBER

public static final int REMAINING_SPACE_GIB_FIELD_NUMBER
Field Value
Type Description
int

REQUESTED_SIZE_GIB_FIELD_NUMBER

public static final int REQUESTED_SIZE_GIB_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOT_AUTO_DELETE_BEHAVIOR_FIELD_NUMBER

public static final int SNAPSHOT_AUTO_DELETE_BEHAVIOR_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOT_ENABLED_FIELD_NUMBER

public static final int SNAPSHOT_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOT_RESERVATION_DETAIL_FIELD_NUMBER

public static final int SNAPSHOT_RESERVATION_DETAIL_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STORAGE_TYPE_FIELD_NUMBER

public static final int STORAGE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

WORKLOAD_PROFILE_FIELD_NUMBER

public static final int WORKLOAD_PROFILE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Volume getDefaultInstance()
Returns
Type Description
Volume

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Volume.Builder newBuilder()
Returns
Type Description
Volume.Builder

newBuilder(Volume prototype)

public static Volume.Builder newBuilder(Volume prototype)
Parameter
Name Description
prototype Volume
Returns
Type Description
Volume.Builder

parseDelimitedFrom(InputStream input)

public static Volume parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Volume
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Volume parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Volume
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Volume parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Volume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Volume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Volume parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Volume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Volume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Volume parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Volume
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Volume
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Volume parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Volume
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Volume
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Volume parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Volume
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Volume
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Volume> parser()
Returns
Type Description
Parser<Volume>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs.

map<string, string> labels = 12;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

Returns
Type Description
boolean

The attached.

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;

Returns
Type Description
long

The autoGrownSizeGib.

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

Returns
Type Description
boolean

The bootVolume.

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;

Returns
Type Description
long

The currentSizeGib.

getDefaultInstanceForType()

public Volume getDefaultInstanceForType()
Returns
Type Description
Volume

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;

Returns
Type Description
long

The emergencySizeGib.

getExpireTime()

public 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
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getId()

public String getId()

An identifier for the Volume, generated by the backend.

string id = 11;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

An identifier for the Volume, generated by the backend.

string id = 11;

Returns
Type Description
ByteString

The bytes for id.

getInstances(int index)

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) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The instances at the given index.

getInstancesBytes(int index)

public 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) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the instances at the given index.

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) = { ... }

Returns
Type Description
int

The count of instances.

getInstancesList()

public 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) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the instances.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs.

map<string, string> labels = 12;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs.

map<string, string> labels = 12;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs.

map<string, string> labels = 12;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs.

map<string, string> labels = 12;

Parameter
Name Description
key String
Returns
Type Description
String

getMaxSizeGib()

public long getMaxSizeGib()

Maximum size volume can be expanded to in case of evergency, in GiB.

int64 max_size_gib = 17;

Returns
Type Description
long

The maxSizeGib.

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

Returns
Type Description
String

The name.

getNameBytes()

public 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
Type Description
ByteString

The bytes for name.

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

Returns
Type Description
String

The notes.

getNotesBytes()

public 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
Type Description
ByteString

The bytes for notes.

getOriginallyRequestedSizeGib()

public long getOriginallyRequestedSizeGib()

Originally requested size, in GiB.

int64 originally_requested_size_gib = 16;

Returns
Type Description
long

The originallyRequestedSizeGib.

getParserForType()

public Parser<Volume> getParserForType()
Returns
Type Description
Parser<Volume>
Overrides

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

Returns
Type Description
VolumePerformanceTier

The performanceTier.

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

Returns
Type Description
int

The enum numeric value on the wire for performanceTier.

getPod()

public String getPod()

Immutable. Pod name.

string pod = 15 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The pod.

getPodBytes()

public ByteString getPodBytes()

Immutable. Pod name.

string pod = 15 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for pod.

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

Returns
Type Description
Volume.Protocol

The protocol.

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

Returns
Type Description
int

The enum numeric value on the wire for protocol.

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;

Returns
Type Description
long

The remainingSpaceGib.

getRequestedSizeGib()

public long getRequestedSizeGib()

The requested size of this storage volume, in GiB.

int64 requested_size_gib = 4;

Returns
Type Description
long

The requestedSizeGib.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSnapshotAutoDeleteBehavior()

public 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
Type Description
Volume.SnapshotAutoDeleteBehavior

The snapshotAutoDeleteBehavior.

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;

Returns
Type Description
int

The enum numeric value on the wire for snapshotAutoDeleteBehavior.

getSnapshotEnabled()

public boolean getSnapshotEnabled()

Whether snapshots are enabled.

bool snapshot_enabled = 13;

Returns
Type Description
boolean

The snapshotEnabled.

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;

Returns
Type Description
Volume.SnapshotReservationDetail

The snapshotReservationDetail.

getSnapshotReservationDetailOrBuilder()

public Volume.SnapshotReservationDetailOrBuilder getSnapshotReservationDetailOrBuilder()

Details about snapshot space reservation and usage on the storage volume.

.google.cloud.baremetalsolution.v2.Volume.SnapshotReservationDetail snapshot_reservation_detail = 8;

Returns
Type Description
Volume.SnapshotReservationDetailOrBuilder

getState()

public Volume.State getState()

The state of this storage volume.

.google.cloud.baremetalsolution.v2.Volume.State state = 3;

Returns
Type Description
Volume.State

The state.

getStateValue()

public int getStateValue()

The state of this storage volume.

.google.cloud.baremetalsolution.v2.Volume.State state = 3;

Returns
Type Description
int

The enum numeric value on the wire for state.

getStorageType()

public Volume.StorageType getStorageType()

The storage type for this volume.

.google.cloud.baremetalsolution.v2.Volume.StorageType storage_type = 2;

Returns
Type Description
Volume.StorageType

The storageType.

getStorageTypeValue()

public int getStorageTypeValue()

The storage type for this volume.

.google.cloud.baremetalsolution.v2.Volume.StorageType storage_type = 2;

Returns
Type Description
int

The enum numeric value on the wire for storageType.

getWorkloadProfile()

public Volume.WorkloadProfile getWorkloadProfile()

The workload profile for the volume.

.google.cloud.baremetalsolution.v2.Volume.WorkloadProfile workload_profile = 22;

Returns
Type Description
Volume.WorkloadProfile

The workloadProfile.

getWorkloadProfileValue()

public int getWorkloadProfileValue()

The workload profile for the volume.

.google.cloud.baremetalsolution.v2.Volume.WorkloadProfile workload_profile = 22;

Returns
Type Description
int

The enum numeric value on the wire for 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];

Returns
Type Description
boolean

Whether the expireTime field is set.

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;

Returns
Type Description
boolean

Whether the snapshotReservationDetail field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Volume.Builder newBuilderForType()
Returns
Type Description
Volume.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Volume.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Volume.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Volume.Builder toBuilder()
Returns
Type Description
Volume.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException