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.
27817 27818 27819 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27817 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
27666 27667 27668 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27666 def client_operation_id @client_operation_id end |
#creation_timestamp ⇒ String
[Deprecated] This field is deprecated.
Corresponds to the JSON property creationTimestamp
27671 27672 27673 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27671 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
27677 27678 27679 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27677 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
27683 27684 27685 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27683 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
27689 27690 27691 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27689 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
27695 27696 27697 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27695 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
27702 27703 27704 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27702 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
27708 27709 27710 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27708 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
27714 27715 27716 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27714 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
27720 27721 27722 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27720 def kind @kind end |
#metadata ⇒ Hash<String,Object>
[Output Only] Service-specific metadata attached to this operation.
Corresponds to the JSON property metadata
27725 27726 27727 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27725 def @metadata end |
#name ⇒ String
[Output Only] Name of the operation.
Corresponds to the JSON property name
27730 27731 27732 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27730 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
27736 27737 27738 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27736 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
27742 27743 27744 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27742 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
27750 27751 27752 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27750 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
27756 27757 27758 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27756 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
27761 27762 27763 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27761 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
27766 27767 27768 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27766 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
27772 27773 27774 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27772 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
27778 27779 27780 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27778 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
27784 27785 27786 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27784 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
27790 27791 27792 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27790 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
27797 27798 27799 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27797 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
27803 27804 27805 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27803 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
27809 27810 27811 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27809 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
27815 27816 27817 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27815 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
27822 27823 27824 27825 27826 27827 27828 27829 27830 27831 27832 27833 27834 27835 27836 27837 27838 27839 27840 27841 27842 27843 27844 27845 27846 27847 27848 27849 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27822 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 |