Class Volume (0.7.0)

Version 0.7.0

• 0.51.0 (latest)
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.8
• 0.2.1
• 0.1.1

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

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AUTO_GROWN_SIZE_GIB_FIELD_NUMBER

public static final int AUTO_GROWN_SIZE_GIB_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

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value

Type	Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

POD_FIELD_NUMBER

public static final int POD_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

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

AbstractMessage.equals(Object other)

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.

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.

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.

getLabels()

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

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.

getParserForType()

public Parser<Volume> getParserForType()

Returns

Type	Description
Parser<Volume>

Overrides

GeneratedMessageV3.getParserForType()

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.

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

GeneratedMessageV3.getSerializedSize()

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Volume.Builder toBuilder()

Returns

Type	Description
Volume.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException