Class Volume.Builder (0.45.0)

public static final class Volume.Builder extends GeneratedMessageV3.Builder<Volume.Builder> implements VolumeOrBuilder

A storage volume.

Protobuf type google.cloud.baremetalsolution.v2.Volume

Inheritance

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

Implements

VolumeOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllInstances(Iterable<String> values)

public Volume.Builder addAllInstances(Iterable<String> values)

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
values Iterable<String>

The instances to add.
Returns
Type Description
Volume.Builder

This builder for chaining.

addInstances(String value)

public Volume.Builder addInstances(String value)

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
value String

The instances to add.
Returns
Type Description
Volume.Builder

This builder for chaining.

addInstancesBytes(ByteString value)

public Volume.Builder addInstancesBytes(ByteString value)

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
value ByteString

The bytes of the instances to add.
Returns
Type Description
Volume.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Volume.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Volume.Builder
Overrides

build()

public Volume build()
Returns
Type Description
Volume

buildPartial()

public Volume buildPartial()
Returns
Type Description
Volume

clear()

public Volume.Builder clear()
Returns
Type Description
Volume.Builder
Overrides

clearAttached()

public Volume.Builder clearAttached()

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
Volume.Builder

This builder for chaining.

clearAutoGrownSizeGib()

public Volume.Builder clearAutoGrownSizeGib()

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
Volume.Builder

This builder for chaining.

clearBootVolume()

public Volume.Builder clearBootVolume()

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
Volume.Builder

This builder for chaining.

clearCurrentSizeGib()

public Volume.Builder clearCurrentSizeGib()

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
Volume.Builder

This builder for chaining.

clearEmergencySizeGib()

public Volume.Builder clearEmergencySizeGib()

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
Volume.Builder

This builder for chaining.

clearExpireTime()

public Volume.Builder clearExpireTime()

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
Volume.Builder

clearField(Descriptors.FieldDescriptor field)

public Volume.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Volume.Builder
Overrides

clearId()

public Volume.Builder clearId()

An identifier for the Volume, generated by the backend.

string id = 11;

Returns
Type Description
Volume.Builder

This builder for chaining.

clearInstances()

public Volume.Builder clearInstances()

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
Volume.Builder

This builder for chaining.

clearLabels()

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

clearMaxSizeGib()

public Volume.Builder clearMaxSizeGib()

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

int64 max_size_gib = 17;

Returns
Type Description
Volume.Builder

This builder for chaining.

clearName()

public Volume.Builder clearName()

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
Volume.Builder

This builder for chaining.

clearNotes()

public Volume.Builder clearNotes()

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
Volume.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Volume.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Volume.Builder
Overrides

clearOriginallyRequestedSizeGib()

public Volume.Builder clearOriginallyRequestedSizeGib()

Originally requested size, in GiB.

int64 originally_requested_size_gib = 16;

Returns
Type Description
Volume.Builder

This builder for chaining.

clearPerformanceTier()

public Volume.Builder clearPerformanceTier()

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
Volume.Builder

This builder for chaining.

clearPod()

public Volume.Builder clearPod()

Immutable. Pod name.

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

Returns
Type Description
Volume.Builder

This builder for chaining.

clearProtocol()

public Volume.Builder clearProtocol()

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.Builder

This builder for chaining.

clearRemainingSpaceGib()

public Volume.Builder clearRemainingSpaceGib()

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
Volume.Builder

This builder for chaining.

clearRequestedSizeGib()

public Volume.Builder clearRequestedSizeGib()

The requested size of this storage volume, in GiB.

int64 requested_size_gib = 4;

Returns
Type Description
Volume.Builder

This builder for chaining.

clearSnapshotAutoDeleteBehavior()

public Volume.Builder clearSnapshotAutoDeleteBehavior()

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.Builder

This builder for chaining.

clearSnapshotEnabled()

public Volume.Builder clearSnapshotEnabled()

Whether snapshots are enabled.

bool snapshot_enabled = 13;

Returns
Type Description
Volume.Builder

This builder for chaining.

clearSnapshotReservationDetail()

public Volume.Builder clearSnapshotReservationDetail()

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.Builder

clearState()

public Volume.Builder clearState()

The state of this storage volume.

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

Returns
Type Description
Volume.Builder

This builder for chaining.

clearStorageType()

public Volume.Builder clearStorageType()

The storage type for this volume.

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

Returns
Type Description
Volume.Builder

This builder for chaining.

clearWorkloadProfile()

public Volume.Builder clearWorkloadProfile()

The workload profile for the volume.

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

Returns
Type Description
Volume.Builder

This builder for chaining.

clone()

public Volume.Builder clone()
Returns
Type Description
Volume.Builder
Overrides

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

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
Builder

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.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,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.

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.

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.

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.

getSnapshotReservationDetailBuilder()

public Volume.SnapshotReservationDetail.Builder getSnapshotReservationDetailBuilder()

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.Builder

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExpireTime(Timestamp value)

public Volume.Builder mergeExpireTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Volume.Builder

mergeFrom(Volume other)

public Volume.Builder mergeFrom(Volume other)
Parameter
Name Description
other Volume
Returns
Type Description
Volume.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Volume.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Volume.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Volume.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Volume.Builder
Overrides

mergeSnapshotReservationDetail(Volume.SnapshotReservationDetail value)

public Volume.Builder mergeSnapshotReservationDetail(Volume.SnapshotReservationDetail value)

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

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

Parameter
Name Description
value Volume.SnapshotReservationDetail
Returns
Type Description
Volume.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Volume.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Volume.Builder
Overrides

putAllLabels(Map<String,String> values)

public Volume.Builder putAllLabels(Map<String,String> values)

Labels as key value pairs.

map<string, string> labels = 12;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Volume.Builder

putLabels(String key, String value)

public Volume.Builder putLabels(String key, String value)

Labels as key value pairs.

map<string, string> labels = 12;

Parameters
Name Description
key String
value String
Returns
Type Description
Volume.Builder

removeLabels(String key)

public Volume.Builder removeLabels(String key)

Labels as key value pairs.

map<string, string> labels = 12;

Parameter
Name Description
key String
Returns
Type Description
Volume.Builder

setAttached(boolean value)

public Volume.Builder setAttached(boolean value)

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

Parameter
Name Description
value boolean

The attached to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setAutoGrownSizeGib(long value)

public Volume.Builder setAutoGrownSizeGib(long value)

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;

Parameter
Name Description
value long

The autoGrownSizeGib to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setBootVolume(boolean value)

public Volume.Builder setBootVolume(boolean value)

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

Parameter
Name Description
value boolean

The bootVolume to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setCurrentSizeGib(long value)

public Volume.Builder setCurrentSizeGib(long value)

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;

Parameter
Name Description
value long

The currentSizeGib to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setEmergencySizeGib(long value)

public Volume.Builder setEmergencySizeGib(long value)

Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.

int64 emergency_size_gib = 14;

Parameter
Name Description
value long

The emergencySizeGib to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setExpireTime(Timestamp value)

public Volume.Builder setExpireTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Volume.Builder

setExpireTime(Timestamp.Builder builderForValue)

public Volume.Builder setExpireTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Volume.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Volume.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Volume.Builder
Overrides

setId(String value)

public Volume.Builder setId(String value)

An identifier for the Volume, generated by the backend.

string id = 11;

Parameter
Name Description
value String

The id to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setIdBytes(ByteString value)

public Volume.Builder setIdBytes(ByteString value)

An identifier for the Volume, generated by the backend.

string id = 11;

Parameter
Name Description
value ByteString

The bytes for id to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setInstances(int index, String value)

public Volume.Builder setInstances(int index, String value)

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
Name Description
index int

The index to set the value at.
value String

The instances to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setMaxSizeGib(long value)

public Volume.Builder setMaxSizeGib(long value)

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

int64 max_size_gib = 17;

Parameter
Name Description
value long

The maxSizeGib to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setName(String value)

public Volume.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Volume.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setNotes(String value)

public Volume.Builder setNotes(String value)

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

Parameter
Name Description
value String

The notes to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setNotesBytes(ByteString value)

public Volume.Builder setNotesBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for notes to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setOriginallyRequestedSizeGib(long value)

public Volume.Builder setOriginallyRequestedSizeGib(long value)

Originally requested size, in GiB.

int64 originally_requested_size_gib = 16;

Parameter
Name Description
value long

The originallyRequestedSizeGib to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setPerformanceTier(VolumePerformanceTier value)

public Volume.Builder setPerformanceTier(VolumePerformanceTier value)

Immutable. Performance tier of the Volume. Default is SHARED.

.google.cloud.baremetalsolution.v2.VolumePerformanceTier performance_tier = 20 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value VolumePerformanceTier

The performanceTier to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setPerformanceTierValue(int value)

public Volume.Builder setPerformanceTierValue(int value)

Immutable. Performance tier of the Volume. Default is SHARED.

.google.cloud.baremetalsolution.v2.VolumePerformanceTier performance_tier = 20 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value int

The enum numeric value on the wire for performanceTier to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setPod(String value)

public Volume.Builder setPod(String value)

Immutable. Pod name.

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

Parameter
Name Description
value String

The pod to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setPodBytes(ByteString value)

public Volume.Builder setPodBytes(ByteString value)

Immutable. Pod name.

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

Parameter
Name Description
value ByteString

The bytes for pod to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setProtocol(Volume.Protocol value)

public Volume.Builder setProtocol(Volume.Protocol value)

Output only. Storage protocol for the Volume.

.google.cloud.baremetalsolution.v2.Volume.Protocol protocol = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Volume.Protocol

The protocol to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setProtocolValue(int value)

public Volume.Builder setProtocolValue(int value)

Output only. Storage protocol for the Volume.

.google.cloud.baremetalsolution.v2.Volume.Protocol protocol = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for protocol to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setRemainingSpaceGib(long value)

public Volume.Builder setRemainingSpaceGib(long value)

The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.

int64 remaining_space_gib = 7;

Parameter
Name Description
value long

The remainingSpaceGib to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Volume.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Volume.Builder
Overrides

setRequestedSizeGib(long value)

public Volume.Builder setRequestedSizeGib(long value)

The requested size of this storage volume, in GiB.

int64 requested_size_gib = 4;

Parameter
Name Description
value long

The requestedSizeGib to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setSnapshotAutoDeleteBehavior(Volume.SnapshotAutoDeleteBehavior value)

public Volume.Builder setSnapshotAutoDeleteBehavior(Volume.SnapshotAutoDeleteBehavior value)

The behavior to use when snapshot reserved space is full.

.google.cloud.baremetalsolution.v2.Volume.SnapshotAutoDeleteBehavior snapshot_auto_delete_behavior = 9;

Parameter
Name Description
value Volume.SnapshotAutoDeleteBehavior

The snapshotAutoDeleteBehavior to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setSnapshotAutoDeleteBehaviorValue(int value)

public Volume.Builder setSnapshotAutoDeleteBehaviorValue(int value)

The behavior to use when snapshot reserved space is full.

.google.cloud.baremetalsolution.v2.Volume.SnapshotAutoDeleteBehavior snapshot_auto_delete_behavior = 9;

Parameter
Name Description
value int

The enum numeric value on the wire for snapshotAutoDeleteBehavior to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setSnapshotEnabled(boolean value)

public Volume.Builder setSnapshotEnabled(boolean value)

Whether snapshots are enabled.

bool snapshot_enabled = 13;

Parameter
Name Description
value boolean

The snapshotEnabled to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setSnapshotReservationDetail(Volume.SnapshotReservationDetail value)

public Volume.Builder setSnapshotReservationDetail(Volume.SnapshotReservationDetail value)

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

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

Parameter
Name Description
value Volume.SnapshotReservationDetail
Returns
Type Description
Volume.Builder

setSnapshotReservationDetail(Volume.SnapshotReservationDetail.Builder builderForValue)

public Volume.Builder setSnapshotReservationDetail(Volume.SnapshotReservationDetail.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Volume.SnapshotReservationDetail.Builder
Returns
Type Description
Volume.Builder

setState(Volume.State value)

public Volume.Builder setState(Volume.State value)

The state of this storage volume.

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

Parameter
Name Description
value Volume.State

The state to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setStateValue(int value)

public Volume.Builder setStateValue(int value)

The state of this storage volume.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setStorageType(Volume.StorageType value)

public Volume.Builder setStorageType(Volume.StorageType value)

The storage type for this volume.

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

Parameter
Name Description
value Volume.StorageType

The storageType to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setStorageTypeValue(int value)

public Volume.Builder setStorageTypeValue(int value)

The storage type for this volume.

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

Parameter
Name Description
value int

The enum numeric value on the wire for storageType to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Volume.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Volume.Builder
Overrides

setWorkloadProfile(Volume.WorkloadProfile value)

public Volume.Builder setWorkloadProfile(Volume.WorkloadProfile value)

The workload profile for the volume.

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

Parameter
Name Description
value Volume.WorkloadProfile

The workloadProfile to set.
Returns
Type Description
Volume.Builder

This builder for chaining.

setWorkloadProfileValue(int value)

public Volume.Builder setWorkloadProfileValue(int value)

The workload profile for the volume.

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

Parameter
Name Description
value int

The enum numeric value on the wire for workloadProfile to set.
Returns
Type Description
Volume.Builder

This builder for chaining.