Class: Google::Apis::DeploymentmanagerAlpha::Operation
- Inherits:
-
Object
- Object
- Google::Apis::DeploymentmanagerAlpha::Operation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/deploymentmanager_alpha/classes.rb,
generated/google/apis/deploymentmanager_alpha/representations.rb,
generated/google/apis/deploymentmanager_alpha/representations.rb
Overview
An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta. regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.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::DeploymentmanagerAlpha::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 resource.
-
#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 resource.
-
#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.
-
#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::DeploymentmanagerAlpha::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 Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Operation
Returns a new instance of Operation
1433 1434 1435 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1433 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
1296 1297 1298 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1296 def client_operation_id @client_operation_id end |
#creation_timestamp ⇒ String
[Deprecated] This field is deprecated.
Corresponds to the JSON property creationTimestamp
1301 1302 1303 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1301 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
1307 1308 1309 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1307 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
1313 1314 1315 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1313 def end_time @end_time end |
#error ⇒ Google::Apis::DeploymentmanagerAlpha::Operation::Error
[Output Only] If errors are generated during processing of the operation, this
field will be populated.
Corresponds to the JSON property error
1319 1320 1321 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1319 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
1325 1326 1327 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1325 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
1332 1333 1334 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1332 def http_error_status_code @http_error_status_code end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
1338 1339 1340 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1338 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
1344 1345 1346 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1344 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
1350 1351 1352 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1350 def kind @kind end |
#name ⇒ String
[Output Only] Name of the resource.
Corresponds to the JSON property name
1355 1356 1357 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1355 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
1361 1362 1363 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1361 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
1369 1370 1371 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1369 def progress @progress end |
#region ⇒ String
[Output Only] The URL of the region where the operation resides. Only
available when performing regional operations. You must specify this field as
part of the HTTP request URL. It is not settable as a field in the request
body.
Corresponds to the JSON property region
1377 1378 1379 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1377 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
1382 1383 1384 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1382 def self_link @self_link 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
1388 1389 1390 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1388 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
1394 1395 1396 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1394 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
1400 1401 1402 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1400 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
1406 1407 1408 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1406 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
1413 1414 1415 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1413 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
1418 1419 1420 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1418 def user @user end |
#warnings ⇒ Array<Google::Apis::DeploymentmanagerAlpha::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
1424 1425 1426 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1424 def warnings @warnings end |
#zone ⇒ String
[Output Only] The URL of the zone where the operation resides. Only available
when performing per-zone operations. You must specify this field as part of
the HTTP request URL. It is not settable as a field in the request body.
Corresponds to the JSON property zone
1431 1432 1433 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1431 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 |
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1438 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) @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 |