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.
28071 28072 28073 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28071 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
27920 27921 27922 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27920 def client_operation_id @client_operation_id end |
#creation_timestamp ⇒ String
[Deprecated] This field is deprecated.
Corresponds to the JSON property creationTimestamp
27925 27926 27927 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27925 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
27931 27932 27933 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27931 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
27937 27938 27939 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27937 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
27943 27944 27945 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27943 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
27949 27950 27951 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27949 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
27956 27957 27958 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27956 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
27962 27963 27964 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27962 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
27968 27969 27970 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27968 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
27974 27975 27976 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27974 def kind @kind end |
#metadata ⇒ Hash<String,Object>
[Output Only] Service-specific metadata attached to this operation.
Corresponds to the JSON property metadata
27979 27980 27981 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27979 def @metadata end |
#name ⇒ String
[Output Only] Name of the operation.
Corresponds to the JSON property name
27984 27985 27986 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27984 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
27990 27991 27992 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27990 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
27996 27997 27998 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 27996 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
28004 28005 28006 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28004 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
28010 28011 28012 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28010 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
28015 28016 28017 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28015 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
28020 28021 28022 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28020 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
28026 28027 28028 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28026 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
28032 28033 28034 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28032 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
28038 28039 28040 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28038 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
28044 28045 28046 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28044 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
28051 28052 28053 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28051 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
28057 28058 28059 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28057 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
28063 28064 28065 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28063 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
28069 28070 28071 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28069 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
28076 28077 28078 28079 28080 28081 28082 28083 28084 28085 28086 28087 28088 28089 28090 28091 28092 28093 28094 28095 28096 28097 28098 28099 28100 28101 28102 28103 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 28076 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 |