Class: Google::Apis::DeploymentmanagerV2beta2::Operation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable
Defined in:
generated/google/apis/deploymentmanager_v2beta2/classes.rb,
generated/google/apis/deploymentmanager_v2beta2/representations.rb,
generated/google/apis/deploymentmanager_v2beta2/representations.rb

Overview

An Operation resource, used to manage asynchronous API requests.

Defined Under Namespace

Classes: Error, Warning

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Operation

Returns a new instance of Operation



431
432
433
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 431

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

Instance Attribute Details

#client_operation_id ⇒ String

[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. Corresponds to the JSON property clientOperationId

Returns:

  • (String) 


308
309
310
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 308

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


313
314
315
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 313

def creation_timestamp
  @creation_timestamp
end

#end_time ⇒ String

[Output Only] The time that this operation was completed. This is in RFC3339 text format. Corresponds to the JSON property endTime

Returns:

  • (String) 


319
320
321
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 319

def end_time
  @end_time
end

#error ⇒ Google::Apis::DeploymentmanagerV2beta2::Operation::Error

[Output Only] If errors are generated during processing of the operation, this field will be populated. Corresponds to the JSON property error

Returns:



325
326
327
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 325

def error
  @error
end

#http_error_message ⇒ String

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. Corresponds to the JSON property httpErrorMessage

Returns:

  • (String) 


331
332
333
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 331

def http_error_message
  @http_error_message
end

#http_error_status_code ⇒ Fixnum

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. Corresponds to the JSON property httpErrorStatusCode

Returns:

  • (Fixnum) 


337
338
339
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 337

def http_error_status_code
  @http_error_status_code
end

#id ⇒ String

[Output Only] Unique identifier for the resource; defined by the server. Corresponds to the JSON property id

Returns:

  • (String) 


342
343
344
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 342

def id
  @id
end

#insert_time ⇒ String

[Output Only] The time that this operation was requested. This is in RFC3339 text format. Corresponds to the JSON property insertTime

Returns:

  • (String) 


348
349
350
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 348

def insert_time
  @insert_time
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#operation for Operation resources. Corresponds to the JSON property kind

Returns:

  • (String) 


354
355
356
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 354

def kind
  @kind
end

#name ⇒ String

[Output Only] Name of the resource. Corresponds to the JSON property name

Returns:

  • (String) 


359
360
361
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 359

def name
  @name
end

#operation_type ⇒ String

[Output Only] Type of the operation, such as insert, compute.instanceGroups. update, or compute.instanceGroups.delete. Corresponds to the JSON property operationType

Returns:

  • (String) 


365
366
367
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 365

def operation_type
  @operation_type
end

#progress ⇒ Fixnum

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses. Corresponds to the JSON property progress

Returns:

  • (Fixnum) 


373
374
375
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 373

def progress
  @progress
end

#region ⇒ String

[Output Only] URL of the region where the operation resides. Only applicable for regional resources. Corresponds to the JSON property region

Returns:

  • (String) 


379
380
381
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 379

def region
  @region
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


384
385
386
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 384

def self_link
  @self_link
end

#start_time ⇒ String

[Output Only] The time that this operation was started by the server. This is in RFC3339 text format. Corresponds to the JSON property startTime

Returns:

  • (String) 


390
391
392
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 390

def start_time
  @start_time
end

#status ⇒ String

[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. Corresponds to the JSON property status

Returns:

  • (String) 


396
397
398
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 396

def status
  @status
end

#status_message ⇒ String

[Output Only] An optional textual description of the current status of the operation. Corresponds to the JSON property statusMessage

Returns:

  • (String) 


402
403
404
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 402

def status_message
  @status_message
end

#target_id ⇒ String

[Output Only] Unique target ID which identifies a particular incarnation of the target. Corresponds to the JSON property targetId

Returns:

  • (String) 


408
409
410
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 408

def target_id
  @target_id
end

#target_link ⇒ String

[Output Only] URL of the resource the operation is mutating. Corresponds to the JSON property targetLink

Returns:

  • (String) 


413
414
415
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 413

def target_link
  @target_link
end

#user ⇒ String

[Output Only] User who requested the operation, for example: user@example.com. Corresponds to the JSON property user

Returns:

  • (String) 


418
419
420
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 418

def user
  @user
end

#warnings ⇒ Array<Google::Apis::DeploymentmanagerV2beta2::Operation::Warning>

[Output Only] If warning messages are generated during processing of the operation, this field will be populated. Corresponds to the JSON property warnings

Returns:



424
425
426
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 424

def warnings
  @warnings
end

#zone ⇒ String

[Output Only] URL of the zone where the operation resides. Corresponds to the JSON property zone

Returns:

  • (String) 


429
430
431
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 429

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'generated/google/apis/deploymentmanager_v2beta2/classes.rb', line 436

def update!(**args)
  @client_operation_id = args[:client_operation_id] unless args[:client_operation_id].nil?
  @creation_timestamp = args[:creation_timestamp] unless args[:creation_timestamp].nil?
  @end_time = args[:end_time] unless args[:end_time].nil?
  @error = args[:error] unless args[:error].nil?
  @http_error_message = args[:http_error_message] unless args[:http_error_message].nil?
  @http_error_status_code = args[:http_error_status_code] unless args[:http_error_status_code].nil?
  @id = args[:id] unless args[:id].nil?
  @insert_time = args[:insert_time] unless args[:insert_time].nil?
  @kind = args[:kind] unless args[:kind].nil?
  @name = args[:name] unless args[:name].nil?
  @operation_type = args[:operation_type] unless args[:operation_type].nil?
  @progress = args[:progress] unless args[:progress].nil?
  @region = args[:region] unless args[:region].nil?
  @self_link = args[:self_link] unless args[:self_link].nil?
  @start_time = args[:start_time] unless args[:start_time].nil?
  @status = args[:status] unless args[:status].nil?
  @status_message = args[:status_message] unless args[:status_message].nil?
  @target_id = args[:target_id] unless args[:target_id].nil?
  @target_link = args[:target_link] unless args[:target_link].nil?
  @user = args[:user] unless args[:user].nil?
  @warnings = args[:warnings] unless args[:warnings].nil?
  @zone = args[:zone] unless args[:zone].nil?
end