Class: Google::Apis::BaremetalsolutionV2::Volume

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Volume

Returns a new instance of Volume.



2483
2484
2485
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2483

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

Returns:

  • (Boolean) 


2340
2341
2342
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2340

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

Returns:

  • (Fixnum) 


2347
2348
2349
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2347

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

Returns:

  • (Boolean) 


2353
2354
2355
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2353

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

Returns:

  • (Fixnum) 


2361
2362
2363
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2361

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

Returns:

  • (Fixnum) 


2367
2368
2369
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2367

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

Returns:

  • (String) 


2373
2374
2375
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2373

def expire_time
  @expire_time
end

#id ⇒ String

An identifier for the Volume, generated by the backend. Corresponds to the JSON property id

Returns:

  • (String) 


2378
2379
2380
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2378

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

Returns:

  • (Array<String>) 


2384
2385
2386
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2384

def instances
  @instances
end

#labels ⇒ Hash<String,String>

Labels as key value pairs. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2389
2390
2391
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2389

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

Returns:

  • (Fixnum) 


2394
2395
2396
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2394

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`

Returns:

  • (String) 


2402
2403
2404
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2402

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

Returns:

  • (String) 


2408
2409
2410
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2408

def notes
  @notes
end

#originally_requested_size_gib ⇒ Fixnum

Originally requested size, in GiB. Corresponds to the JSON property originallyRequestedSizeGib

Returns:

  • (Fixnum) 


2413
2414
2415
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2413

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

Returns:

  • (String) 


2418
2419
2420
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2418

def performance_tier
  @performance_tier
end

#pod ⇒ String

Immutable. Pod name. Corresponds to the JSON property pod

Returns:

  • (String) 


2423
2424
2425
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2423

def pod
  @pod
end

#protocol ⇒ String

Output only. Storage protocol for the Volume. Corresponds to the JSON property protocol

Returns:

  • (String) 


2428
2429
2430
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2428

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

Returns:

  • (Fixnum) 


2434
2435
2436
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2434

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

Returns:

  • (Fixnum) 


2439
2440
2441
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2439

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

Returns:

  • (String) 


2444
2445
2446
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2444

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

Returns:

  • (Boolean) 


2449
2450
2451
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2449

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

Returns:



2455
2456
2457
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2455

def snapshot_reservation_detail
  @snapshot_reservation_detail
end

#snapshot_schedule_policy ⇒ String

The name of the snapshot schedule policy in use for this volume, if any. Corresponds to the JSON property snapshotSchedulePolicy

Returns:

  • (String) 


2460
2461
2462
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2460

def snapshot_schedule_policy
  @snapshot_schedule_policy
end

#state ⇒ String

The state of this storage volume. Corresponds to the JSON property state

Returns:

  • (String) 


2465
2466
2467
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2465

def state
  @state
end

#storage_aggregate_pool ⇒ String

Input only. Name of the storage aggregate pool to allocate the volume in. Can be used only for VOLUME_PERFORMANCE_TIER_ASSIGNED volumes. Corresponds to the JSON property storageAggregatePool

Returns:

  • (String) 


2471
2472
2473
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2471

def storage_aggregate_pool
  @storage_aggregate_pool
end

#storage_type ⇒ String

The storage type for this volume. Corresponds to the JSON property storageType

Returns:

  • (String) 


2476
2477
2478
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2476

def storage_type
  @storage_type
end

#workload_profile ⇒ String

The workload profile for the volume. Corresponds to the JSON property workloadProfile

Returns:

  • (String) 


2481
2482
2483
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2481

def workload_profile
  @workload_profile
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2488

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)
  @snapshot_schedule_policy = args[:snapshot_schedule_policy] if args.key?(:snapshot_schedule_policy)
  @state = args[:state] if args.key?(:state)
  @storage_aggregate_pool = args[:storage_aggregate_pool] if args.key?(:storage_aggregate_pool)
  @storage_type = args[:storage_type] if args.key?(:storage_type)
  @workload_profile = args[:workload_profile] if args.key?(:workload_profile)
end