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.



2311
2312
2313
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2311

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) 


2168
2169
2170
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2168

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) 


2175
2176
2177
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2175

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) 


2181
2182
2183
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2181

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) 


2189
2190
2191
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2189

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) 


2195
2196
2197
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2195

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) 


2201
2202
2203
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2201

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) 


2206
2207
2208
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2206

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>) 


2212
2213
2214
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2212

def instances
  @instances
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


2217
2218
2219
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2217

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) 


2222
2223
2224
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2222

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) 


2230
2231
2232
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2230

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) 


2236
2237
2238
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2236

def notes
  @notes
end

#originally_requested_size_gib ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2241
2242
2243
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2241

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) 


2246
2247
2248
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2246

def performance_tier
  @performance_tier
end

#pod ⇒ String

Immutable. Pod name. Corresponds to the JSON property pod

Returns:

  • (String) 


2251
2252
2253
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2251

def pod
  @pod
end

#protocol ⇒ String

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

Returns:

  • (String) 


2256
2257
2258
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2256

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) 


2262
2263
2264
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2262

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) 


2267
2268
2269
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2267

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) 


2272
2273
2274
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2272

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) 


2277
2278
2279
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2277

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:



2283
2284
2285
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2283

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) 


2288
2289
2290
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2288

def snapshot_schedule_policy
  @snapshot_schedule_policy
end

#state ⇒ String

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

Returns:

  • (String) 


2293
2294
2295
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2293

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) 


2299
2300
2301
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2299

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) 


2304
2305
2306
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2304

def storage_type
  @storage_type
end

#workload_profile ⇒ String

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

Returns:

  • (String) 


2309
2310
2311
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2309

def workload_profile
  @workload_profile
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
 
# File 'lib/google/apis/baremetalsolution_v2/classes.rb', line 2316

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