Bare Metal Solution v2 API - Class Volume (1.3.0)

public sealed class Volume : IMessage<Volume>, IEquatable<Volume>, IDeepCloneable<Volume>, IBufferMessage, IMessage

Reference documentation and code samples for the Bare Metal Solution v2 API class Volume.

A storage volume.

Inheritance

object > Volume

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

Volume()

public Volume()

Volume(Volume)

public Volume(Volume other)
Parameter
NameDescription
otherVolume

Properties

Attached

public bool Attached { get; set; }

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.

Property Value
TypeDescription
bool

AutoGrownSizeGib

public long AutoGrownSizeGib { get; set; }

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.

Property Value
TypeDescription
long

BootVolume

public bool BootVolume { get; set; }

Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.

Property Value
TypeDescription
bool

CurrentSizeGib

public long CurrentSizeGib { get; set; }

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.

Property Value
TypeDescription
long

EmergencySizeGib

public long EmergencySizeGib { get; set; }

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

Property Value
TypeDescription
long

ExpireTime

public Timestamp ExpireTime { get; set; }

Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.

Property Value
TypeDescription
Timestamp

Id

public string Id { get; set; }

An identifier for the Volume, generated by the backend.

Property Value
TypeDescription
string

Instances

public RepeatedField<string> Instances { get; }

Output only. Instances this Volume is attached to. This field is set only in Get requests.

Property Value
TypeDescription
RepeatedFieldstring

InstancesAsInstanceNames

public ResourceNameList<InstanceName> InstancesAsInstanceNames { get; }

InstanceName-typed view over the Instances resource name property.

Property Value
TypeDescription
ResourceNameListInstanceName

Labels

public MapField<string, string> Labels { get; }

Labels as key value pairs.

Property Value
TypeDescription
MapFieldstringstring

MaxSizeGib

public long MaxSizeGib { get; set; }

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

Property Value
TypeDescription
long

Name

public string Name { get; set; }

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}

Property Value
TypeDescription
string

Notes

public string Notes { get; set; }

Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.

Property Value
TypeDescription
string

OriginallyRequestedSizeGib

public long OriginallyRequestedSizeGib { get; set; }

Originally requested size, in GiB.

Property Value
TypeDescription
long

PerformanceTier

public VolumePerformanceTier PerformanceTier { get; set; }

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

Property Value
TypeDescription
VolumePerformanceTier

Pod

public string Pod { get; set; }

Immutable. Pod name.

Property Value
TypeDescription
string

Protocol

public Volume.Types.Protocol Protocol { get; set; }

Output only. Storage protocol for the Volume.

Property Value
TypeDescription
VolumeTypesProtocol

RemainingSpaceGib

public long RemainingSpaceGib { get; set; }

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

Property Value
TypeDescription
long

RequestedSizeGib

public long RequestedSizeGib { get; set; }

The requested size of this storage volume, in GiB.

Property Value
TypeDescription
long

SnapshotAutoDeleteBehavior

public Volume.Types.SnapshotAutoDeleteBehavior SnapshotAutoDeleteBehavior { get; set; }

The behavior to use when snapshot reserved space is full.

Property Value
TypeDescription
VolumeTypesSnapshotAutoDeleteBehavior

SnapshotEnabled

public bool SnapshotEnabled { get; set; }

Whether snapshots are enabled.

Property Value
TypeDescription
bool

SnapshotReservationDetail

public Volume.Types.SnapshotReservationDetail SnapshotReservationDetail { get; set; }

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

Property Value
TypeDescription
VolumeTypesSnapshotReservationDetail

State

public Volume.Types.State State { get; set; }

The state of this storage volume.

Property Value
TypeDescription
VolumeTypesState

StorageType

public Volume.Types.StorageType StorageType { get; set; }

The storage type for this volume.

Property Value
TypeDescription
VolumeTypesStorageType

VolumeName

public VolumeName VolumeName { get; set; }

VolumeName-typed view over the Name resource name property.

Property Value
TypeDescription
VolumeName

WorkloadProfile

public Volume.Types.WorkloadProfile WorkloadProfile { get; set; }

The workload profile for the volume.

Property Value
TypeDescription
VolumeTypesWorkloadProfile