Class: Google::Apis::DeploymentmanagerV2::Operation
- Inherits:
-
Object
- Object
- Google::Apis::DeploymentmanagerV2::Operation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/deploymentmanager_v2/classes.rb,
generated/google/apis/deploymentmanager_v2/representations.rb,
generated/google/apis/deploymentmanager_v2/representations.rb
Overview
An Operation resource, used to manage asynchronous API requests.
Defined Under Namespace
Instance Attribute Summary collapse
-
#client_operation_id ⇒ String
[Output Only] Reserved for future use.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
[Output Only] A textual description of the operation, which is set when the operation is created.
-
#end_time ⇒ String
[Output Only] The time that this operation was completed.
-
#error ⇒ Google::Apis::DeploymentmanagerV2::Operation::Error
[Output Only] If errors are generated during processing of the operation, this field will be populated.
-
#http_error_message ⇒ String
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-
#http_error_status_code ⇒ Fixnum
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned.
-
#id ⇒ String
[Output Only] The unique identifier for the resource.
-
#insert_time ⇒ String
[Output Only] The time that this operation was requested.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#name ⇒ String
[Output Only] Name of the resource.
-
#operation_type ⇒ String
[Output Only] The type of operation, such as insert, update, or delete, and so on.
-
#progress ⇒ Fixnum
[Output Only] An optional progress indicator that ranges from 0 to 100.
-
#region ⇒ String
[Output Only] The URL of the region where the operation resides.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#start_time ⇒ String
[Output Only] The time that this operation was started by the server.
-
#status ⇒ String
[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
-
#status_message ⇒ String
[Output Only] An optional textual description of the current status of the operation.
-
#target_id ⇒ String
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-
#target_link ⇒ String
[Output Only] The URL of the resource that the operation modifies.
-
#user ⇒ String
[Output Only] User who requested the operation, for example: [email protected].
-
#warnings ⇒ Array<Google::Apis::DeploymentmanagerV2::Operation::Warning>
[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-
#zone ⇒ String
[Output Only] The URL of the zone where the operation resides.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Operation
constructor
A new instance of Operation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Operation
Returns a new instance of Operation.
555 556 557 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 555 def initialize(**args) update!(**args) end |
Instance Attribute Details
#client_operation_id ⇒ String
[Output Only] Reserved for future use.
Corresponds to the JSON property clientOperationId
421 422 423 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 421 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
426 427 428 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 426 def @creation_timestamp end |
#description ⇒ String
[Output Only] A textual description of the operation, which is set when the
operation is created.
Corresponds to the JSON property description
432 433 434 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 432 def description @description end |
#end_time ⇒ String
[Output Only] The time that this operation was completed. This value is in
RFC3339 text format.
Corresponds to the JSON property endTime
438 439 440 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 438 def end_time @end_time end |
#error ⇒ Google::Apis::DeploymentmanagerV2::Operation::Error
[Output Only] If errors are generated during processing of the operation, this
field will be populated.
Corresponds to the JSON property error
444 445 446 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 444 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
450 451 452 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 450 def @http_error_message end |
#http_error_status_code ⇒ Fixnum
[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
457 458 459 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 457 def http_error_status_code @http_error_status_code end |
#id ⇒ String
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
463 464 465 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 463 def id @id end |
#insert_time ⇒ String
[Output Only] The time that this operation was requested. This value is in
RFC3339 text format.
Corresponds to the JSON property insertTime
469 470 471 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 469 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
475 476 477 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 475 def kind @kind end |
#name ⇒ String
[Output Only] Name of the resource.
Corresponds to the JSON property name
480 481 482 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 480 def name @name end |
#operation_type ⇒ String
[Output Only] The type of operation, such as insert, update, or delete, and so
on.
Corresponds to the JSON property operationType
486 487 488 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 486 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 when the operation will be complete. This
number should monotonically increase as the operation progresses.
Corresponds to the JSON property progress
494 495 496 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 494 def progress @progress end |
#region ⇒ String
[Output Only] The URL of the region where the operation resides. Only
available when performing regional operations.
Corresponds to the JSON property region
500 501 502 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 500 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
505 506 507 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 505 def self_link @self_link end |
#start_time ⇒ String
[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
511 512 513 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 511 def start_time @start_time end |
#status ⇒ String
[Output Only] The status of the operation, which can be one of the following:
PENDING, RUNNING, or DONE.
Corresponds to the JSON property status
517 518 519 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 517 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
523 524 525 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 523 def @status_message end |
#target_id ⇒ String
[Output Only] The unique target ID, which identifies a specific incarnation of
the target resource.
Corresponds to the JSON property targetId
529 530 531 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 529 def target_id @target_id end |
#target_link ⇒ String
[Output Only] The URL of the resource that the operation modifies. If creating
a persistent disk snapshot, this points to the persistent disk that the
snapshot was created from.
Corresponds to the JSON property targetLink
536 537 538 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 536 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
541 542 543 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 541 def user @user end |
#warnings ⇒ Array<Google::Apis::DeploymentmanagerV2::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
547 548 549 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 547 def warnings @warnings end |
#zone ⇒ String
[Output Only] The URL of the zone where the operation resides. Only available
when performing per-zone operations.
Corresponds to the JSON property zone
553 554 555 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 553 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 560 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 |