Class: Google::Apis::BaremetalsolutionV2::Volume
- Inherits:
 - 
      Object
      
        
- Object
 - Google::Apis::BaremetalsolutionV2::Volume
 
 
- Includes:
 - Core::Hashable, Core::JsonObjectSupport
 
- Defined in:
 - lib/google/apis/baremetalsolution_v2/classes.rb,
lib/google/apis/baremetalsolution_v2/representations.rb,
lib/google/apis/baremetalsolution_v2/representations.rb 
Overview
A storage volume.
Instance Attribute Summary collapse
- 
  
    
      #attached  ⇒ Boolean 
    
    
      (also: #attached?)
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Output only.
 - 
  
    
      #auto_grown_size_gib  ⇒ Fixnum 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The size, in GiB, that this storage volume has expanded as a result of an auto grow policy.
 - 
  
    
      #boot_volume  ⇒ Boolean 
    
    
      (also: #boot_volume?)
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Output only.
 - 
  
    
      #current_size_gib  ⇒ Fixnum 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The current size of this storage volume, in GiB, including space reserved for snapshots.
 - 
  
    
      #emergency_size_gib  ⇒ Fixnum 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Additional emergency size that was requested for this Volume, in GiB.
 - 
  
    
      #expire_time  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Output only.
 - 
  
    
      #id  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
An identifier for the
Volume, generated by the backend. - 
  
    
      #instances  ⇒ Array<String> 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Output only.
 - 
  
    
      #labels  ⇒ Hash<String,String> 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Labels as key value pairs.
 - 
  
    
      #max_size_gib  ⇒ Fixnum 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Maximum size volume can be expanded to in case of evergency, in GiB.
 - 
  
    
      #name  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Output only.
 - 
  
    
      #notes  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Input only.
 - 
  
    
      #originally_requested_size_gib  ⇒ Fixnum 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Originally requested size, in GiB.
 - 
  
    
      #performance_tier  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Immutable.
 - 
  
    
      #pod  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Immutable.
 - 
  
    
      #protocol  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Output only.
 - 
  
    
      #remaining_space_gib  ⇒ Fixnum 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
 - 
  
    
      #requested_size_gib  ⇒ Fixnum 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The requested size of this storage volume, in GiB.
 - 
  
    
      #snapshot_auto_delete_behavior  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The behavior to use when snapshot reserved space is full.
 - 
  
    
      #snapshot_enabled  ⇒ Boolean 
    
    
      (also: #snapshot_enabled?)
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Whether snapshots are enabled.
 - 
  
    
      #snapshot_reservation_detail  ⇒ Google::Apis::BaremetalsolutionV2::SnapshotReservationDetail 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Details about snapshot space reservation and usage on the storage volume.
 - 
  
    
      #state  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The state of this storage volume.
 - 
  
    
      #storage_type  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The storage type for this volume.
 - 
  
    
      #workload_profile  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The workload profile for the volume.
 
Instance Method Summary collapse
- 
  
    
      #initialize(**args)  ⇒ Volume 
    
    
  
  
  
    constructor
  
  
  
  
  
  
  
    
A new instance of Volume.
 - 
  
    
      #update!(**args)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Update properties of this object.
 
Constructor Details
#initialize(**args) ⇒ Volume
Returns a new instance of Volume.
      2640 2641 2642  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2640 def initialize(**args) update!(**args) end  | 
  
Instance Attribute Details
#attached ⇒ Boolean Also known as: attached?
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.
Corresponds to the JSON property attached
      2507 2508 2509  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2507 def attached @attached end  | 
  
#auto_grown_size_gib ⇒ Fixnum
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.
Corresponds to the JSON property autoGrownSizeGib
      2514 2515 2516  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2514 def auto_grown_size_gib @auto_grown_size_gib end  | 
  
#boot_volume ⇒ Boolean Also known as: boot_volume?
Output only. Whether this volume is a boot volume. A boot volume is one which
contains a boot LUN.
Corresponds to the JSON property bootVolume
      2520 2521 2522  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2520 def boot_volume @boot_volume end  | 
  
#current_size_gib ⇒ Fixnum
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.
Corresponds to the JSON property currentSizeGib
      2528 2529 2530  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2528 def current_size_gib @current_size_gib end  | 
  
#emergency_size_gib ⇒ Fixnum
Additional emergency size that was requested for this Volume, in GiB.
current_size_gib includes this value.
Corresponds to the JSON property emergencySizeGib
      2534 2535 2536  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2534 def emergency_size_gib @emergency_size_gib end  | 
  
#expire_time ⇒ String
Output only. Time after which volume will be fully deleted. It is filled only
for volumes in COOLOFF state.
Corresponds to the JSON property expireTime
      2540 2541 2542  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2540 def expire_time @expire_time end  | 
  
#id ⇒ String
An identifier for the Volume, generated by the backend.
Corresponds to the JSON property id
      2545 2546 2547  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2545 def id @id end  | 
  
#instances ⇒ Array<String>
Output only. Instances this Volume is attached to. This field is set only in
Get requests.
Corresponds to the JSON property instances
      2551 2552 2553  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2551 def instances @instances end  | 
  
#labels ⇒ Hash<String,String>
Labels as key value pairs.
Corresponds to the JSON property labels
      2556 2557 2558  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2556 def labels @labels end  | 
  
#max_size_gib ⇒ Fixnum
Maximum size volume can be expanded to in case of evergency, in GiB.
Corresponds to the JSON property maxSizeGib
      2561 2562 2563  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2561 def max_size_gib @max_size_gib end  | 
  
#name ⇒ 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`
Corresponds to the JSON propertyname`
      2569 2570 2571  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2569 def name @name end  | 
  
#notes ⇒ String
Input only. User-specified notes for new Volume. Used to provision Volumes
that require manual intervention.
Corresponds to the JSON property notes
      2575 2576 2577  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2575 def notes @notes end  | 
  
#originally_requested_size_gib ⇒ Fixnum
Originally requested size, in GiB.
Corresponds to the JSON property originallyRequestedSizeGib
      2580 2581 2582  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2580 def originally_requested_size_gib @originally_requested_size_gib end  | 
  
#performance_tier ⇒ String
Immutable. Performance tier of the Volume. Default is SHARED.
Corresponds to the JSON property performanceTier
      2585 2586 2587  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2585 def performance_tier @performance_tier end  | 
  
#pod ⇒ String
Immutable. Pod name. Pod is an independent part of infrastructure. Volume can
only be connected to the instances allocated in the same pod.
Corresponds to the JSON property pod
      2591 2592 2593  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2591 def pod @pod end  | 
  
#protocol ⇒ String
Output only. Storage protocol for the Volume.
Corresponds to the JSON property protocol
      2596 2597 2598  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2596 def protocol @protocol end  | 
  
#remaining_space_gib ⇒ Fixnum
The space remaining in the storage volume for new LUNs, in GiB, excluding
space reserved for snapshots.
Corresponds to the JSON property remainingSpaceGib
      2602 2603 2604  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2602 def remaining_space_gib @remaining_space_gib end  | 
  
#requested_size_gib ⇒ Fixnum
The requested size of this storage volume, in GiB.
Corresponds to the JSON property requestedSizeGib
      2607 2608 2609  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2607 def requested_size_gib @requested_size_gib end  | 
  
#snapshot_auto_delete_behavior ⇒ String
The behavior to use when snapshot reserved space is full.
Corresponds to the JSON property snapshotAutoDeleteBehavior
      2612 2613 2614  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2612 def snapshot_auto_delete_behavior @snapshot_auto_delete_behavior end  | 
  
#snapshot_enabled ⇒ Boolean Also known as: snapshot_enabled?
Whether snapshots are enabled.
Corresponds to the JSON property snapshotEnabled
      2617 2618 2619  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2617 def snapshot_enabled @snapshot_enabled end  | 
  
#snapshot_reservation_detail ⇒ Google::Apis::BaremetalsolutionV2::SnapshotReservationDetail
Details about snapshot space reservation and usage on the storage volume.
Corresponds to the JSON property snapshotReservationDetail
      2623 2624 2625  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2623 def snapshot_reservation_detail @snapshot_reservation_detail end  | 
  
#state ⇒ String
The state of this storage volume.
Corresponds to the JSON property state
      2628 2629 2630  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2628 def state @state end  | 
  
#storage_type ⇒ String
The storage type for this volume.
Corresponds to the JSON property storageType
      2633 2634 2635  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2633 def storage_type @storage_type end  | 
  
#workload_profile ⇒ String
The workload profile for the volume.
Corresponds to the JSON property workloadProfile
      2638 2639 2640  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2638 def workload_profile @workload_profile end  | 
  
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
      2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670  | 
    
      # File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2645 def update!(**args) @attached = args[:attached] if args.key?(:attached) @auto_grown_size_gib = args[:auto_grown_size_gib] if args.key?(:auto_grown_size_gib) @boot_volume = args[:boot_volume] if args.key?(:boot_volume) @current_size_gib = args[:current_size_gib] if args.key?(:current_size_gib) @emergency_size_gib = args[:emergency_size_gib] if args.key?(:emergency_size_gib) @expire_time = args[:expire_time] if args.key?(:expire_time) @id = args[:id] if args.key?(:id) @instances = args[:instances] if args.key?(:instances) @labels = args[:labels] if args.key?(:labels) @max_size_gib = args[:max_size_gib] if args.key?(:max_size_gib) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @originally_requested_size_gib = args[:originally_requested_size_gib] if args.key?(:originally_requested_size_gib) @performance_tier = args[:performance_tier] if args.key?(:performance_tier) @pod = args[:pod] if args.key?(:pod) @protocol = args[:protocol] if args.key?(:protocol) @remaining_space_gib = args[:remaining_space_gib] if args.key?(:remaining_space_gib) @requested_size_gib = args[:requested_size_gib] if args.key?(:requested_size_gib) @snapshot_auto_delete_behavior = args[:snapshot_auto_delete_behavior] if args.key?(:snapshot_auto_delete_behavior) @snapshot_enabled = args[:snapshot_enabled] if args.key?(:snapshot_enabled) @snapshot_reservation_detail = args[:snapshot_reservation_detail] if args.key?(:snapshot_reservation_detail) @state = args[:state] if args.key?(:state) @storage_type = args[:storage_type] if args.key?(:storage_type) @workload_profile = args[:workload_profile] if args.key?(:workload_profile) end  |