Class: Google::Apis::ClouduseraccountsBeta::Operation

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

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Operation

Returns a new instance of Operation.


486
487
488
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 486

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

Instance Attribute Details

#client_operation_idString

[Output Only] Reserved for future use. Corresponds to the JSON property clientOperationId

Returns:

  • (String)

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

def client_operation_id
  @client_operation_id
end

#creation_timestampString

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

Returns:

  • (String)

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

def creation_timestamp
  @creation_timestamp
end

#descriptionString

[Output Only] A textual description of the operation, which is set when the operation is created. Corresponds to the JSON property description

Returns:

  • (String)

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

def description
  @description
end

#end_timeString

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

Returns:

  • (String)

371
372
373
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 371

def end_time
  @end_time
end

#errorGoogle::Apis::ClouduseraccountsBeta::Operation::Error

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


377
378
379
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 377

def error
  @error
end

#http_error_messageString

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

383
384
385
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 383

def http_error_message
  @http_error_message
end

#http_error_status_codeFixnum

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. Corresponds to the JSON property httpErrorStatusCode

Returns:

  • (Fixnum)

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

def http_error_status_code
  @http_error_status_code
end

#idString

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (String)

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

def id
  @id
end

#insert_timeString

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

Returns:

  • (String)

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

def insert_time
  @insert_time
end

#kindString

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

Returns:

  • (String)

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

def kind
  @kind
end

#nameString

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

Returns:

  • (String)

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

def name
  @name
end

#operation_typeString

[Output Only] The type of operation, such as insert, update, or delete, and so on. Corresponds to the JSON property operationType

Returns:

  • (String)

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

def operation_type
  @operation_type
end

#progressFixnum

[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 when the operation will be complete. This number should monotonically increase as the operation progresses. Corresponds to the JSON property progress

Returns:

  • (Fixnum)

427
428
429
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 427

def progress
  @progress
end

#regionString

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

Returns:

  • (String)

433
434
435
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 433

def region
  @region
end

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

Returns:

  • (String)

438
439
440
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 438

def self_link
  @self_link
end

#start_timeString

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

Returns:

  • (String)

444
445
446
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 444

def start_time
  @start_time
end

#statusString

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

Returns:

  • (String)

450
451
452
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 450

def status
  @status
end

#status_messageString

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

Returns:

  • (String)

456
457
458
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 456

def status_message
  @status_message
end

#target_idString

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. Corresponds to the JSON property targetId

Returns:

  • (String)

462
463
464
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 462

def target_id
  @target_id
end

[Output Only] The URL of the resource that the operation modifies. Corresponds to the JSON property targetLink

Returns:

  • (String)

467
468
469
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 467

def target_link
  @target_link
end

#userString

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

Returns:

  • (String)

472
473
474
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 472

def user
  @user
end

#warningsArray<Google::Apis::ClouduseraccountsBeta::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


478
479
480
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 478

def warnings
  @warnings
end

#zoneString

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

Returns:

  • (String)

484
485
486
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 484

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
# File 'generated/google/apis/clouduseraccounts_beta/classes.rb', line 491

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)
  @description = args[:description] if args.key?(:description)
  @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