Class: Google::Apis::ComputeAlpha::Operation
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Operation
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Overview
Represents an Operation resource. Google Compute Engine has three Operation
resources: * Global *
Regional * Zonal You can use an operation
resource to manage asynchronous API requests. For more information, read
Handling API responses. Operations can be global, regional or zonal. - For
global operations, use the globalOperations
resource. - For regional
operations, use the regionOperations
resource. - For zonal operations, use
the zonalOperations
resource. For more information, read Global, Regional,
and Zonal Resources.
Defined Under Namespace
Instance Attribute Summary collapse
-
#client_operation_id ⇒ String
[Output Only] The value of
requestId
if you provided it in the request. -
#creation_timestamp ⇒ String
[Deprecated] This field is deprecated.
-
#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::ComputeAlpha::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 ⇒ Fixnum
[Output Only] The unique identifier for the operation.
-
#insert_time ⇒ String
[Output Only] The time that this operation was requested.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#metadata ⇒ Hash<String,Object>
[Output Only] Service-specific metadata attached to this operation.
-
#name ⇒ String
[Output Only] Name of the operation.
-
#operation_group_id ⇒ String
[Output Only] An ID that represents a group of operations, such as when a group of operations results from a
bulkInsert
API request. -
#operation_type ⇒ String
[Output Only] The type of operation, such as
insert
,update
, ordelete
, 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.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#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
, orDONE
. -
#status_message ⇒ String
[Output Only] An optional textual description of the current status of the operation.
-
#target_id ⇒ Fixnum
[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:
user@example.com
. -
#warnings ⇒ Array<Google::Apis::ComputeAlpha::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.
Constructor Details
#initialize(**args) ⇒ Operation
Returns a new instance of Operation.
28693 28694 28695 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28693 def initialize(**args) update!(**args) end |
Instance Attribute Details
#client_operation_id ⇒ String
[Output Only] The value of requestId
if you provided it in the request. Not
present otherwise.
Corresponds to the JSON property clientOperationId
28542 28543 28544 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28542 def client_operation_id @client_operation_id end |
#creation_timestamp ⇒ String
[Deprecated] This field is deprecated.
Corresponds to the JSON property creationTimestamp
28547 28548 28549 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28547 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
28553 28554 28555 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28553 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
28559 28560 28561 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28559 def end_time @end_time end |
#error ⇒ Google::Apis::ComputeAlpha::Operation::Error
[Output Only] If errors are generated during processing of the operation, this
field will be populated.
Corresponds to the JSON property error
28565 28566 28567 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28565 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
28571 28572 28573 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28571 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
28578 28579 28580 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28578 def http_error_status_code @http_error_status_code end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the operation. This identifier is
defined by the server.
Corresponds to the JSON property id
28584 28585 28586 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28584 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
28590 28591 28592 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28590 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
28596 28597 28598 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28596 def kind @kind end |
#metadata ⇒ Hash<String,Object>
[Output Only] Service-specific metadata attached to this operation.
Corresponds to the JSON property metadata
28601 28602 28603 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28601 def @metadata end |
#name ⇒ String
[Output Only] Name of the operation.
Corresponds to the JSON property name
28606 28607 28608 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28606 def name @name end |
#operation_group_id ⇒ String
[Output Only] An ID that represents a group of operations, such as when a
group of operations results from a bulkInsert
API request.
Corresponds to the JSON property operationGroupId
28612 28613 28614 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28612 def operation_group_id @operation_group_id 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
28618 28619 28620 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28618 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
28626 28627 28628 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28626 def progress @progress end |
#region ⇒ String
[Output Only] The URL of the region where the operation resides. Only
applicable when performing regional operations.
Corresponds to the JSON property region
28632 28633 28634 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28632 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
28637 28638 28639 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28637 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
Corresponds to the JSON property selfLinkWithId
28642 28643 28644 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28642 def self_link_with_id @self_link_with_id 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
28648 28649 28650 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28648 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
28654 28655 28656 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28654 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
28660 28661 28662 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28660 def @status_message end |
#target_id ⇒ Fixnum
[Output Only] The unique target ID, which identifies a specific incarnation of
the target resource.
Corresponds to the JSON property targetId
28666 28667 28668 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28666 def target_id @target_id end |
#target_link ⇒ String
[Output Only] The URL of the resource that the operation modifies. For
operations related to creating a snapshot, this points to the persistent disk
that the snapshot was created from.
Corresponds to the JSON property targetLink
28673 28674 28675 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28673 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
28679 28680 28681 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28679 def user @user end |
#warnings ⇒ Array<Google::Apis::ComputeAlpha::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
28685 28686 28687 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28685 def warnings @warnings end |
#zone ⇒ String
[Output Only] The URL of the zone where the operation resides. Only applicable
when performing per-zone operations.
Corresponds to the JSON property zone
28691 28692 28693 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28691 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
28698 28699 28700 28701 28702 28703 28704 28705 28706 28707 28708 28709 28710 28711 28712 28713 28714 28715 28716 28717 28718 28719 28720 28721 28722 28723 28724 28725 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28698 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) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @operation_group_id = args[:operation_group_id] if args.key?(:operation_group_id) @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) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @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 |