Class Volume.Builder (0.2.1)

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

A storage volume.

Protobuf type google.cloud.baremetalsolution.v2.Volume

Implements

VolumeOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Volume.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Volume.Builder
Overrides

build()

public Volume build()
Returns
TypeDescription
Volume

buildPartial()

public Volume buildPartial()
Returns
TypeDescription
Volume

clear()

public Volume.Builder clear()
Returns
TypeDescription
Volume.Builder
Overrides

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Volume.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Volume.Builder
Overrides

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Volume.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Volume.Builder
Overrides

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

clearSnapshotSchedulePolicy()

public Volume.Builder clearSnapshotSchedulePolicy()

The name of the snapshot schedule policy in use for this volume, if any.

string snapshot_schedule_policy = 10 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
Volume.Builder

This builder for chaining.

clearState()

public Volume.Builder clearState()

The state of this storage volume.

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

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

This builder for chaining.

clone()

public Volume.Builder clone()
Returns
TypeDescription
Volume.Builder
Overrides

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
TypeDescription
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
TypeDescription
long

The currentSizeGib.

getDefaultInstanceForType()

public Volume getDefaultInstanceForType()
Returns
TypeDescription
Volume

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

The bytes for name.

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
TypeDescription
long

The remainingSpaceGib.

getRequestedSizeGib()

public long getRequestedSizeGib()

The requested size of this storage volume, in GiB.

int64 requested_size_gib = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for snapshotAutoDeleteBehavior.

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
TypeDescription
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
TypeDescription
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
TypeDescription
Volume.SnapshotReservationDetailOrBuilder

getSnapshotSchedulePolicy()

public String getSnapshotSchedulePolicy()

The name of the snapshot schedule policy in use for this volume, if any.

string snapshot_schedule_policy = 10 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The snapshotSchedulePolicy.

getSnapshotSchedulePolicyBytes()

public ByteString getSnapshotSchedulePolicyBytes()

The name of the snapshot schedule policy in use for this volume, if any.

string snapshot_schedule_policy = 10 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for snapshotSchedulePolicy.

getState()

public Volume.State getState()

The state of this storage volume.

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

Returns
TypeDescription
Volume.State

The state.

getStateValue()

public int getStateValue()

The state of this storage volume.

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

Returns
TypeDescription
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
TypeDescription
Volume.StorageType

The storageType.

getStorageTypeValue()

public int getStorageTypeValue()

The storage type for this volume.

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

Returns
TypeDescription
int

The enum numeric value on the wire for storageType.

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
TypeDescription
boolean

Whether the snapshotReservationDetail field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Volume other)

public Volume.Builder mergeFrom(Volume other)
Parameter
NameDescription
otherVolume
Returns
TypeDescription
Volume.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Volume.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Volume.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Volume.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueVolume.SnapshotReservationDetail
Returns
TypeDescription
Volume.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Volume.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Volume.Builder
Overrides

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
NameDescription
valuelong

The autoGrownSizeGib to set.

Returns
TypeDescription
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
NameDescription
valuelong

The currentSizeGib to set.

Returns
TypeDescription
Volume.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Volume.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Volume.Builder
Overrides

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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valuelong

The remainingSpaceGib to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valuelong

The requestedSizeGib to set.

Returns
TypeDescription
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
NameDescription
valueVolume.SnapshotAutoDeleteBehavior

The snapshotAutoDeleteBehavior to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for snapshotAutoDeleteBehavior to set.

Returns
TypeDescription
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
NameDescription
valueVolume.SnapshotReservationDetail
Returns
TypeDescription
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
NameDescription
builderForValueVolume.SnapshotReservationDetail.Builder
Returns
TypeDescription
Volume.Builder

setSnapshotSchedulePolicy(String value)

public Volume.Builder setSnapshotSchedulePolicy(String value)

The name of the snapshot schedule policy in use for this volume, if any.

string snapshot_schedule_policy = 10 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The snapshotSchedulePolicy to set.

Returns
TypeDescription
Volume.Builder

This builder for chaining.

setSnapshotSchedulePolicyBytes(ByteString value)

public Volume.Builder setSnapshotSchedulePolicyBytes(ByteString value)

The name of the snapshot schedule policy in use for this volume, if any.

string snapshot_schedule_policy = 10 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for snapshotSchedulePolicy to set.

Returns
TypeDescription
Volume.Builder

This builder for chaining.

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
NameDescription
valueVolume.State

The state to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
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
NameDescription
valueVolume.StorageType

The storageType to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for storageType to set.

Returns
TypeDescription
Volume.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Volume.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Volume.Builder
Overrides