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.



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

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) 


299
300
301
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 299

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) 


305
306
307
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 305

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) 


311
312
313
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 311

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:



317
318
319
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 317

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) 


322
323
324
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 322

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) 


327
328
329
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 327

def http_error_status_code
  @http_error_status_code
end

#id ⇒ String

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

Returns:

  • (String) 


332
333
334
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 332

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) 


338
339
340
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 338

def insert_time
  @insert_time
end

#kind ⇒ String

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

Returns:

  • (String) 


343
344
345
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 343

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


362
363
364
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 362

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) 


368
369
370
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 368

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) 


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

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) 


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

def start_time
  @start_time
end

#status ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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) 


401
402
403
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 401

def target_link
  @target_link
end

#user ⇒ String

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

Returns:

  • (String) 


406
407
408
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 406

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:



411
412
413
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 411

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) 


417
418
419
 
# File 'generated/google/apis/replicapool_v1beta2/classes.rb', line 417

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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