Class: Google::Apis::SaasservicemgmtV1beta1::UnitOperation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/saasservicemgmt_v1beta1/classes.rb,
lib/google/apis/saasservicemgmt_v1beta1/representations.rb,
lib/google/apis/saasservicemgmt_v1beta1/representations.rb

Overview

UnitOperation encapsulates the intent of changing/interacting with the service component represented by the specific Unit. Multiple UnitOperations can be created (requested) and scheduled in the future, however only one will be allowed to execute at a time (that can change in the future for non-mutating operations). UnitOperations allow different actors interacting with the same unit to focus only on the change they have requested. This is a base object that contains the common fields in all unit operations. Next: 22

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UnitOperation

Returns a new instance of UnitOperation.



3371
3372
3373
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3371

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


3241
3242
3243
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3241

def annotations
  @annotations
end

#cancel ⇒ Boolean Also known as: cancel?

Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional) Corresponds to the JSON property cancel

Returns:

  • (Boolean) 


3247
3248
3249
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3247

def cancel
  @cancel
end

#conditions ⇒ Array<Google::Apis::SaasservicemgmtV1beta1::UnitOperationCondition>

Optional. Output only. A set of conditions which indicate the various conditions this resource can have. Corresponds to the JSON property conditions

Returns:



3254
3255
3256
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3254

def conditions
  @conditions
end

#create_time ⇒ String

Output only. The timestamp when the resource was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


3259
3260
3261
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3259

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation). Corresponds to the JSON property deleteTime

Returns:

  • (String) 


3265
3266
3267
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3265

def delete_time
  @delete_time
end

#deprovision ⇒ Google::Apis::SaasservicemgmtV1beta1::Deprovision

Deprovision is the unit operation that deprovision the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned. Corresponds to the JSON property deprovision

Returns:



3271
3272
3273
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3271

def deprovision
  @deprovision
end

#engine_state ⇒ String

Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. Corresponds to the JSON property engineState

Returns:

  • (String) 


3277
3278
3279
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3277

def engine_state
  @engine_state
end

#error_category ⇒ String

Optional. Output only. UnitOperationErrorCategory describe the error category. Corresponds to the JSON property errorCategory

Returns:

  • (String) 


3282
3283
3284
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3282

def error_category
  @error_category
end

#etag ⇒ String

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. Corresponds to the JSON property etag

Returns:

  • (String) 


3289
3290
3291
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3289

def etag
  @etag
end

#flag_update ⇒ Google::Apis::SaasservicemgmtV1beta1::FlagUpdate

FlagUpdate is a UnitOperation that pushes new flag values to Units. Corresponds to the JSON property flagUpdate

Returns:



3294
3295
3296
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3294

def flag_update
  @flag_update
end

#labels ⇒ Hash<String,String>

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


3300
3301
3302
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3300

def labels
  @labels
end

#name ⇒ String

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/project/locations/location/ unitOperations/unitOperation" Corresponds to the JSON property name

Returns:

  • (String) 


3307
3308
3309
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3307

def name
  @name
end

#parent_unit_operation ⇒ String

Optional. Reference to parent resource: UnitOperation. If an operation needs to create other operations as part of its workflow, each of the child operations should have this field set to the parent. This can be used for tracing. (Optional) Corresponds to the JSON property parentUnitOperation

Returns:

  • (String) 


3315
3316
3317
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3315

def parent_unit_operation
  @parent_unit_operation
end

#provision ⇒ Google::Apis::SaasservicemgmtV1beta1::Provision

Provision is the unit operation that provision the underlying resources represented by a Unit. Can only execute if the Unit is not currently provisioned. Corresponds to the JSON property provision

Returns:



3322
3323
3324
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3322

def provision
  @provision
end

#rollout ⇒ String

Optional. Specifies which rollout created this Unit Operation. This cannot be modified and is used for filtering purposes only. If a dependent unit and unit operation are created as part of another unit operation, they will use the same rolloutId. Corresponds to the JSON property rollout

Returns:

  • (String) 


3330
3331
3332
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3330

def rollout
  @rollout
end

#schedule ⇒ Google::Apis::SaasservicemgmtV1beta1::Schedule

A time specification to schedule the maintenance. Corresponds to the JSON property schedule

Returns:



3335
3336
3337
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3335

def schedule
  @schedule
end

#state ⇒ String

Optional. Output only. UnitOperationState describes the current state of the unit operation. Corresponds to the JSON property state

Returns:

  • (String) 


3341
3342
3343
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3341

def state
  @state
end

#uid ⇒ String

Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. Corresponds to the JSON property uid

Returns:

  • (String) 


3350
3351
3352
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3350

def uid
  @uid
end

#unit ⇒ String

Required. Immutable. The Unit a given UnitOperation will act upon. Corresponds to the JSON property unit

Returns:

  • (String) 


3355
3356
3357
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3355

def unit
  @unit
end

#update_time ⇒ String

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. Corresponds to the JSON property updateTime

Returns:

  • (String) 


3362
3363
3364
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3362

def update_time
  @update_time
end

#upgrade ⇒ Google::Apis::SaasservicemgmtV1beta1::Upgrade

Upgrade is the unit operation that upgrades a provisioned unit, which may also include the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned. Corresponds to the JSON property upgrade

Returns:



3369
3370
3371
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3369

def upgrade
  @upgrade
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 3376

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @cancel = args[:cancel] if args.key?(:cancel)
  @conditions = args[:conditions] if args.key?(:conditions)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @deprovision = args[:deprovision] if args.key?(:deprovision)
  @engine_state = args[:engine_state] if args.key?(:engine_state)
  @error_category = args[:error_category] if args.key?(:error_category)
  @etag = args[:etag] if args.key?(:etag)
  @flag_update = args[:flag_update] if args.key?(:flag_update)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @parent_unit_operation = args[:parent_unit_operation] if args.key?(:parent_unit_operation)
  @provision = args[:provision] if args.key?(:provision)
  @rollout = args[:rollout] if args.key?(:rollout)
  @schedule = args[:schedule] if args.key?(:schedule)
  @state = args[:state] if args.key?(:state)
  @uid = args[:uid] if args.key?(:uid)
  @unit = args[:unit] if args.key?(:unit)
  @update_time = args[:update_time] if args.key?(:update_time)
  @upgrade = args[:upgrade] if args.key?(:upgrade)
end