Bare Metal Solution V2 API - Class Google::Cloud::BareMetalSolution::V2::Volume (v1.3.1)

Reference documentation and code samples for the Bare Metal Solution V2 API class Google::Cloud::BareMetalSolution::V2::Volume.

A storage volume.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#attached

def attached() -> ::Boolean
Returns
  • (::Boolean) — 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.

#auto_grown_size_gib

def auto_grown_size_gib() -> ::Integer
Returns
  • (::Integer) — 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.

#auto_grown_size_gib=

def auto_grown_size_gib=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#boot_volume

def boot_volume() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.

#current_size_gib

def current_size_gib() -> ::Integer
Returns
  • (::Integer) — 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.

#current_size_gib=

def current_size_gib=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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

def emergency_size_gib() -> ::Integer
Returns
  • (::Integer) — Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.

#emergency_size_gib=

def emergency_size_gib=(value) -> ::Integer
Parameter
  • value (::Integer) — Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
Returns
  • (::Integer) — Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.

#id

def id() -> ::String
Returns
  • (::String) — An identifier for the Volume, generated by the backend.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — An identifier for the Volume, generated by the backend.
Returns
  • (::String) — An identifier for the Volume, generated by the backend.

#instances

def instances() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. Instances this Volume is attached to. This field is set only in Get requests.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs.

#max_size_gib

def max_size_gib() -> ::Integer
Returns
  • (::Integer) — Maximum size volume can be expanded to in case of evergency, in GiB.

#max_size_gib=

def max_size_gib=(value) -> ::Integer
Parameter
  • value (::Integer) — Maximum size volume can be expanded to in case of evergency, in GiB.
Returns
  • (::Integer) — Maximum size volume can be expanded to in case of evergency, in GiB.

#name

def name() -> ::String
Returns
  • (::String) — 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}

#notes

def notes() -> ::String
Returns
  • (::String) — Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.

#notes=

def notes=(value) -> ::String
Parameter
  • value (::String) — Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
Returns
  • (::String) — Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.

#originally_requested_size_gib

def originally_requested_size_gib() -> ::Integer
Returns
  • (::Integer) — Originally requested size, in GiB.

#originally_requested_size_gib=

def originally_requested_size_gib=(value) -> ::Integer
Parameter
  • value (::Integer) — Originally requested size, in GiB.
Returns
  • (::Integer) — Originally requested size, in GiB.

#performance_tier

def performance_tier() -> ::Google::Cloud::BareMetalSolution::V2::VolumePerformanceTier
Returns

#performance_tier=

def performance_tier=(value) -> ::Google::Cloud::BareMetalSolution::V2::VolumePerformanceTier
Parameter
Returns

#pod

def pod() -> ::String
Returns
  • (::String) — Immutable. Pod name.

#pod=

def pod=(value) -> ::String
Parameter
  • value (::String) — Immutable. Pod name.
Returns
  • (::String) — Immutable. Pod name.

#protocol

def protocol() -> ::Google::Cloud::BareMetalSolution::V2::Volume::Protocol
Returns

#remaining_space_gib

def remaining_space_gib() -> ::Integer
Returns
  • (::Integer) — The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.

#remaining_space_gib=

def remaining_space_gib=(value) -> ::Integer
Parameter
  • value (::Integer) — The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
Returns
  • (::Integer) — The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.

#requested_size_gib

def requested_size_gib() -> ::Integer
Returns
  • (::Integer) — The requested size of this storage volume, in GiB.

#requested_size_gib=

def requested_size_gib=(value) -> ::Integer
Parameter
  • value (::Integer) — The requested size of this storage volume, in GiB.
Returns
  • (::Integer) — The requested size of this storage volume, in GiB.

#snapshot_auto_delete_behavior

def snapshot_auto_delete_behavior() -> ::Google::Cloud::BareMetalSolution::V2::Volume::SnapshotAutoDeleteBehavior
Returns

#snapshot_auto_delete_behavior=

def snapshot_auto_delete_behavior=(value) -> ::Google::Cloud::BareMetalSolution::V2::Volume::SnapshotAutoDeleteBehavior
Parameter
Returns

#snapshot_enabled

def snapshot_enabled() -> ::Boolean
Returns
  • (::Boolean) — Whether snapshots are enabled.

#snapshot_enabled=

def snapshot_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether snapshots are enabled.
Returns
  • (::Boolean) — Whether snapshots are enabled.

#snapshot_reservation_detail

def snapshot_reservation_detail() -> ::Google::Cloud::BareMetalSolution::V2::Volume::SnapshotReservationDetail
Returns

#snapshot_reservation_detail=

def snapshot_reservation_detail=(value) -> ::Google::Cloud::BareMetalSolution::V2::Volume::SnapshotReservationDetail
Parameter
Returns

#state

def state() -> ::Google::Cloud::BareMetalSolution::V2::Volume::State
Returns

#state=

def state=(value) -> ::Google::Cloud::BareMetalSolution::V2::Volume::State
Parameter
Returns

#storage_type

def storage_type() -> ::Google::Cloud::BareMetalSolution::V2::Volume::StorageType
Returns

#storage_type=

def storage_type=(value) -> ::Google::Cloud::BareMetalSolution::V2::Volume::StorageType
Parameter
Returns

#workload_profile

def workload_profile() -> ::Google::Cloud::BareMetalSolution::V2::Volume::WorkloadProfile
Returns

#workload_profile=

def workload_profile=(value) -> ::Google::Cloud::BareMetalSolution::V2::Volume::WorkloadProfile
Parameter
Returns