Class: Google::Apis::ReplicapoolV1beta2::Operation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/replicapool_v1beta2/classes.rb,
generated/google/apis/replicapool_v1beta2/representations.rb,
generated/google/apis/replicapool_v1beta2/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::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Operation

Returns a new instance of Operation



421
422
423
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 421

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) 


301
302
303
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 301

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


307
308
309
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 307

def creation_timestamp
  @creation_timestamp
end

#end_time ⇒ String

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

Returns:

  • (String) 


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

def end_time
  @end_time
end

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

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

Returns:



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

def error
  @error
end

#http_error_message ⇒ String

[Output only] If operation fails, the HTTP error message returned. Corresponds to the JSON property httpErrorMessage

Returns:

  • (String) 


324
325
326
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 324

def http_error_message
  @http_error_message
end

#http_error_status_code ⇒ Fixnum

[Output only] If operation fails, the HTTP error status code returned. Corresponds to the JSON property httpErrorStatusCode

Returns:

  • (Fixnum) 


329
330
331
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 329

def http_error_status_code
  @http_error_status_code
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


334
335
336
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 334

def id
  @id
end

#insert_time ⇒ String

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

Returns:

  • (String) 


340
341
342
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 340

def insert_time
  @insert_time
end

#kind ⇒ String

[Output only] Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


345
346
347
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 345

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


350
351
352
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 350

def name
  @name
end

#operation_type ⇒ String

[Output only] Type of the operation. Operations include insert, update, and delete. Corresponds to the JSON property operationType

Returns:

  • (String) 


356
357
358
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 356

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 be monotonically increasing as the operation progresses. Corresponds to the JSON property progress

Returns:

  • (Fixnum) 


364
365
366
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 364

def progress
  @progress
end

#region ⇒ String

[Output Only] URL of the region where the operation resides. Only available when performing regional operations. Corresponds to the JSON property region

Returns:

  • (String) 


370
371
372
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 370

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


375
376
377
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 375

def self_link
  @self_link
end

#start_time ⇒ String

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

Returns:

  • (String) 


381
382
383
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 381

def start_time
  @start_time
end

#status ⇒ String

[Output Only] Status of the operation. Corresponds to the JSON property status

Returns:

  • (String) 


386
387
388
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 386

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) 


392
393
394
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 392

def status_message
  @status_message
end

#target_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


398
399
400
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 398

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) 


403
404
405
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 403

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) 


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

def user
  @user
end

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

[Output Only] If there are issues with this operation, a warning is returned. Corresponds to the JSON property warnings

Returns:



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

def warnings
  @warnings
end

#zone ⇒ String

[Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations. Corresponds to the JSON property zone

Returns:

  • (String) 


419
420
421
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 419

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 426

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