Class: Google::Apis::ComputeAlpha::Operation
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Operation
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/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. (==
resource_for
$api_version
.globalOperations ==) (== resource_for$ api_version
.regionOperations ==) (== resource_for$api_version
. zoneOperations ==)
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.
-
#name ⇒ String
[Output Only] Name of the operation.
-
#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.
-
#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, or DONE.
-
#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.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Operation
Returns a new instance of Operation.
22256 22257 22258 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22256 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
22117 22118 22119 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22117 def client_operation_id @client_operation_id end |
#creation_timestamp ⇒ String
[Deprecated] This field is deprecated.
Corresponds to the JSON property creationTimestamp
22122 22123 22124 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22122 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
22128 22129 22130 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22128 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
22134 22135 22136 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22134 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
22140 22141 22142 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22140 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
22146 22147 22148 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22146 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
22153 22154 22155 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22153 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
22159 22160 22161 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22159 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
22165 22166 22167 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22165 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
22171 22172 22173 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22171 def kind @kind end |
#name ⇒ String
[Output Only] Name of the operation.
Corresponds to the JSON property name
22176 22177 22178 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22176 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
22182 22183 22184 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22182 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
22190 22191 22192 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22190 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
22196 22197 22198 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22196 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
22201 22202 22203 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22201 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
22206 22207 22208 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22206 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
22212 22213 22214 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22212 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
22218 22219 22220 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22218 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
22224 22225 22226 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22224 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
22230 22231 22232 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22230 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
22237 22238 22239 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22237 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
22242 22243 22244 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22242 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
22248 22249 22250 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22248 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
22254 22255 22256 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22254 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
22261 22262 22263 22264 22265 22266 22267 22268 22269 22270 22271 22272 22273 22274 22275 22276 22277 22278 22279 22280 22281 22282 22283 22284 22285 22286 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22261 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) @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 |