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.
-
#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.
-
#set_common_instance_metadata_operation_metadata ⇒ Google::Apis::ComputeAlpha::SetCommonInstanceMetadataOperationMetadata
Encapsulates partial completion metadata for SetCommonInstanceMetadata.
-
#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.
30521 30522 30523 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30521 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
30368 30369 30370 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30368 def client_operation_id @client_operation_id end |
#creation_timestamp ⇒ String
[Deprecated] This field is deprecated.
Corresponds to the JSON property creationTimestamp
30373 30374 30375 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30373 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
30379 30380 30381 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30379 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
30385 30386 30387 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30385 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
30391 30392 30393 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30391 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
30397 30398 30399 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30397 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
30404 30405 30406 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30404 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
30410 30411 30412 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30410 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
30416 30417 30418 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30416 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
30422 30423 30424 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30422 def kind @kind end |
#name ⇒ String
[Output Only] Name of the operation.
Corresponds to the JSON property name
30427 30428 30429 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30427 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
30433 30434 30435 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30433 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
30439 30440 30441 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30439 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
30447 30448 30449 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30447 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
30453 30454 30455 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30453 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
30458 30459 30460 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30458 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
30463 30464 30465 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30463 def self_link_with_id @self_link_with_id end |
#set_common_instance_metadata_operation_metadata ⇒ Google::Apis::ComputeAlpha::SetCommonInstanceMetadataOperationMetadata
Encapsulates partial completion metadata for SetCommonInstanceMetadata. Will
be propagated on Operation.metadata as per go/partial-completion-api-clean.
See go/gce-aips/2822 for API council results.
Corresponds to the JSON property setCommonInstanceMetadataOperationMetadata
30470 30471 30472 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30470 def @set_common_instance_metadata_operation_metadata 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
30476 30477 30478 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30476 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
30482 30483 30484 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30482 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
30488 30489 30490 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30488 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
30494 30495 30496 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30494 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
30501 30502 30503 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30501 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
30507 30508 30509 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30507 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
30513 30514 30515 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30513 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
30519 30520 30521 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30519 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
30526 30527 30528 30529 30530 30531 30532 30533 30534 30535 30536 30537 30538 30539 30540 30541 30542 30543 30544 30545 30546 30547 30548 30549 30550 30551 30552 30553 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 30526 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_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) @set_common_instance_metadata_operation_metadata = args[:set_common_instance_metadata_operation_metadata] if args.key?(:set_common_instance_metadata_operation_metadata) @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 |