Class Volume (1.7.3)

Volume(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A storage volume.

Attributes

NameDescription
name str
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}
id str
An identifier for the Volume, generated by the backend.
storage_type google.cloud.bare_metal_solution_v2.types.Volume.StorageType
The storage type for this volume.
state google.cloud.bare_metal_solution_v2.types.Volume.State
The state of this storage volume.
requested_size_gib int
The requested size of this storage volume, in GiB.
originally_requested_size_gib int
Originally requested size, in GiB.
current_size_gib int
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.
emergency_size_gib int
Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
max_size_gib int
Maximum size volume can be expanded to in case of evergency, in GiB.
auto_grown_size_gib int
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.
remaining_space_gib int
The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
snapshot_reservation_detail google.cloud.bare_metal_solution_v2.types.Volume.SnapshotReservationDetail
Details about snapshot space reservation and usage on the storage volume.
snapshot_auto_delete_behavior google.cloud.bare_metal_solution_v2.types.Volume.SnapshotAutoDeleteBehavior
The behavior to use when snapshot reserved space is full.
labels MutableMapping[str, str]
Labels as key value pairs.
snapshot_enabled bool
Whether snapshots are enabled.
pod str
Immutable. Pod name.
protocol google.cloud.bare_metal_solution_v2.types.Volume.Protocol
Output only. Storage protocol for the Volume.
boot_volume bool
Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
performance_tier google.cloud.bare_metal_solution_v2.types.VolumePerformanceTier
Immutable. Performance tier of the Volume. Default is SHARED.
notes str
Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
workload_profile google.cloud.bare_metal_solution_v2.types.Volume.WorkloadProfile
The workload profile for the volume.
expire_time google.protobuf.timestamp_pb2.Timestamp
Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.
instances MutableSequence[str]
Output only. Instances this Volume is attached to. This field is set only in Get requests.
attached bool
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.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Protocol

Protocol(value)

Storage protocol.

Values: PROTOCOL_UNSPECIFIED (0): Value is not specified. FIBRE_CHANNEL (1): Fibre Channel protocol. NFS (2): NFS protocol means Volume is a NFS Share volume. Such volumes cannot be manipulated via Volumes API.

SnapshotAutoDeleteBehavior

SnapshotAutoDeleteBehavior(value)

The kinds of auto delete behavior to use when snapshot reserved space is full.

Values: SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED (0): The unspecified behavior. DISABLED (1): Don't delete any snapshots. This disables new snapshot creation, as long as the snapshot reserved space is full. OLDEST_FIRST (2): Delete the oldest snapshots first. NEWEST_FIRST (3): Delete the newest snapshots first.

SnapshotReservationDetail

SnapshotReservationDetail(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

State

State(value)

The possible states for a storage volume.

Values: STATE_UNSPECIFIED (0): The storage volume is in an unknown state. CREATING (1): The storage volume is being created. READY (2): The storage volume is ready for use. DELETING (3): The storage volume has been requested to be deleted. UPDATING (4): The storage volume is being updated. COOL_OFF (5): The storage volume is in cool off state. It will be deleted after expire_time.

StorageType

StorageType(value)

The storage type for a volume.

Values: STORAGE_TYPE_UNSPECIFIED (0): The storage type for this volume is unknown. SSD (1): The storage type for this volume is SSD. HDD (2): This storage type for this volume is HDD.

WorkloadProfile

WorkloadProfile(value)

The possible values for a workload profile.

Values: WORKLOAD_PROFILE_UNSPECIFIED (0): The workload profile is in an unknown state. GENERIC (1): The workload profile is generic. HANA (2): The workload profile is hana.