Interface VolumeOrBuilder (0.31.0)

Version 0.31.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 interface VolumeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getEmergencySizeGib()

public abstract 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 abstract 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 abstract 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 abstract String getId()

An identifier for the Volume, generated by the backend.

string id = 11;

Returns
Type	Description
String	The id.

getIdBytes()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the instances.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels as key value pairs.

map<string, string> labels = 12;

Returns
Type	Description
int

getLabelsMap()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract long getOriginallyRequestedSizeGib()

Originally requested size, in GiB.

int64 originally_requested_size_gib = 16;

Returns
Type	Description
long	The originallyRequestedSizeGib.

getPerformanceTier()

public abstract 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 abstract 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 abstract String getPod()

Immutable. Pod name.

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

Returns
Type	Description
String	The pod.

getPodBytes()

public abstract ByteString getPodBytes()

Immutable. Pod name.

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

Returns
Type	Description
ByteString	The bytes for pod.

getProtocol()

public abstract 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 abstract 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 abstract 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 abstract long getRequestedSizeGib()

The requested size of this storage volume, in GiB.

int64 requested_size_gib = 4;

Returns
Type	Description
long	The requestedSizeGib.

getSnapshotAutoDeleteBehavior()

public abstract 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 abstract 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 abstract boolean getSnapshotEnabled()

Whether snapshots are enabled.

bool snapshot_enabled = 13;

Returns
Type	Description
boolean	The snapshotEnabled.

getSnapshotReservationDetail()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.