VolumeOrBuilder (proto-google-cloud-bare-metal-solution-v2 0.6.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Volume, Volume.Builder
```
public interface VolumeOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Labels as key value pairs.
`long`	`getAutoGrownSizeGib()` The size, in GiB, that this storage volume has expanded as a result of an auto grow policy.
`long`	`getCurrentSizeGib()` The current size of this storage volume, in GiB, including space reserved for snapshots.
`long`	`getEmergencySizeGib()` Additional emergency size that was requested for this Volume, in GiB.
`String`	`getId()` An identifier for the `Volume`, generated by the backend.
`com.google.protobuf.ByteString`	`getIdBytes()` An identifier for the `Volume`, generated by the backend.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Labels as key value pairs.
`Map<String,String>`	`getLabelsMap()` Labels as key value pairs.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Labels as key value pairs.
`String`	`getLabelsOrThrow(String key)` Labels as key value pairs.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`String`	`getPod()` Immutable.
`com.google.protobuf.ByteString`	`getPodBytes()` Immutable.
`long`	`getRemainingSpaceGib()` The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
`long`	`getRequestedSizeGib()` The requested size of this storage volume, in GiB.
`Volume.SnapshotAutoDeleteBehavior`	`getSnapshotAutoDeleteBehavior()` The behavior to use when snapshot reserved space is full.
`int`	`getSnapshotAutoDeleteBehaviorValue()` The behavior to use when snapshot reserved space is full.
`boolean`	`getSnapshotEnabled()` Whether snapshots are enabled.
`Volume.SnapshotReservationDetail`	`getSnapshotReservationDetail()` Details about snapshot space reservation and usage on the storage volume.
`Volume.SnapshotReservationDetailOrBuilder`	`getSnapshotReservationDetailOrBuilder()` Details about snapshot space reservation and usage on the storage volume.
`Volume.State`	`getState()` The state of this storage volume.
`int`	`getStateValue()` The state of this storage volume.
`Volume.StorageType`	`getStorageType()` The storage type for this volume.
`int`	`getStorageTypeValue()` The storage type for this volume.
`boolean`	`hasSnapshotReservationDetail()` Details about snapshot space reservation and usage on the storage volume.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getName

String getName()

 Output only. The resource name of this `Volume`.
 Resource names are schemeless URIs that follow the conventions in
 https://cloud.google.com/apis/design/resource_names.
 Format:
 `projects/{project}/locations/{location}/volumes/{volume}`

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:: The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. The resource name of this `Volume`.
 Resource names are schemeless URIs that follow the conventions in
 https://cloud.google.com/apis/design/resource_names.
 Format:
 `projects/{project}/locations/{location}/volumes/{volume}`

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:: The bytes for name.

getId

String getId()

 An identifier for the `Volume`, generated by the backend.

string id = 11;

Returns:: The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 An identifier for the `Volume`, generated by the backend.

string id = 11;

Returns:: The bytes for id.

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

The enum numeric value on the wire for storageType.

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

The storageType.

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

The enum numeric value on the wire for state.

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

The state.

getRequestedSizeGib

long getRequestedSizeGib()

 The requested size of this storage volume, in GiB.

int64 requested_size_gib = 4;

Returns:: The requestedSizeGib.

getCurrentSizeGib

long getCurrentSizeGib()

 The current size of this storage volume, in GiB, including space reserved
 for snapshots. This size might be different than the requested size if the
 storage volume has been configured with auto grow or auto shrink.

int64 current_size_gib = 5;

Returns:: The currentSizeGib.

getEmergencySizeGib

long getEmergencySizeGib()

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

int64 emergency_size_gib = 14;

Returns:: The emergencySizeGib.

getAutoGrownSizeGib

long getAutoGrownSizeGib()

 The size, in GiB, that this storage volume has expanded as a result of an
 auto grow policy. In the absence of auto-grow, the value is 0.

int64 auto_grown_size_gib = 6;

Returns:: The autoGrownSizeGib.

getRemainingSpaceGib

long getRemainingSpaceGib()

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

int64 remaining_space_gib = 7;

Returns:: The remainingSpaceGib.

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

Whether the snapshotReservationDetail field is set.

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

The snapshotReservationDetail.

getSnapshotReservationDetailOrBuilder

Volume.SnapshotReservationDetailOrBuilder getSnapshotReservationDetailOrBuilder()

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


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

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

The enum numeric value on the wire for snapshotAutoDeleteBehavior.

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

The snapshotAutoDeleteBehavior.