Class: Google::Apis::DeploymentmanagerV2beta::Operation
- Inherits:
-
Object
- Object
- Google::Apis::DeploymentmanagerV2beta::Operation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/deploymentmanager_v2beta/classes.rb,
lib/google/apis/deploymentmanager_v2beta/representations.rb,
lib/google/apis/deploymentmanager_v2beta/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 zoneOperations
resource. For more information,
read Global, Regional, and Zonal Resources. Note that completed Operation
resources have a limited retention period.
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::DeploymentmanagerV2beta::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.
-
#instances_bulk_insert_operation_metadata ⇒ Google::Apis::DeploymentmanagerV2beta::InstancesBulkInsertOperationMetadata
Corresponds to the JSON property
instancesBulkInsertOperationMetadata
. -
#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.
-
#set_common_instance_metadata_operation_metadata ⇒ Google::Apis::DeploymentmanagerV2beta::SetCommonInstanceMetadataOperationMetadata
[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-
#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
oralice_smith_identifier (global/workforcePools/example-com-us-employees)
. -
#warnings ⇒ Array<Google::Apis::DeploymentmanagerV2beta::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.
1320 1321 1322 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1320 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
1168 1169 1170 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1168 def client_operation_id @client_operation_id end |
#creation_timestamp ⇒ String
[Deprecated] This field is deprecated.
Corresponds to the JSON property creationTimestamp
1173 1174 1175 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1173 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
1179 1180 1181 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1179 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
1185 1186 1187 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1185 def end_time @end_time end |
#error ⇒ Google::Apis::DeploymentmanagerV2beta::Operation::Error
[Output Only] If errors are generated during processing of the operation, this
field will be populated.
Corresponds to the JSON property error
1191 1192 1193 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1191 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
1197 1198 1199 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1197 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
1204 1205 1206 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1204 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
1210 1211 1212 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1210 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
1216 1217 1218 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1216 def insert_time @insert_time end |
#instances_bulk_insert_operation_metadata ⇒ Google::Apis::DeploymentmanagerV2beta::InstancesBulkInsertOperationMetadata
Corresponds to the JSON property instancesBulkInsertOperationMetadata
1221 1222 1223 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1221 def @instances_bulk_insert_operation_metadata end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#operation
for Operation
resources.
Corresponds to the JSON property kind
1227 1228 1229 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1227 def kind @kind end |
#name ⇒ String
[Output Only] Name of the operation.
Corresponds to the JSON property name
1232 1233 1234 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1232 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
1238 1239 1240 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1238 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
1244 1245 1246 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1244 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
1252 1253 1254 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1252 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
1258 1259 1260 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1258 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
1263 1264 1265 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1263 def self_link @self_link end |
#set_common_instance_metadata_operation_metadata ⇒ Google::Apis::DeploymentmanagerV2beta::SetCommonInstanceMetadataOperationMetadata
[Output Only] If the operation is for projects.setCommonInstanceMetadata, this
field will contain information on all underlying zonal actions and their state.
Corresponds to the JSON property setCommonInstanceMetadataOperationMetadata
1269 1270 1271 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1269 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
1275 1276 1277 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1275 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
1281 1282 1283 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1281 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
1287 1288 1289 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1287 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
1293 1294 1295 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1293 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
1300 1301 1302 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1300 def target_link @target_link end |
#user ⇒ String
[Output Only] User who requested the operation, for example: user@example.com
or alice_smith_identifier (global/workforcePools/example-com-us-employees)
.
Corresponds to the JSON property user
1306 1307 1308 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1306 def user @user end |
#warnings ⇒ Array<Google::Apis::DeploymentmanagerV2beta::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
1312 1313 1314 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1312 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
1318 1319 1320 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1318 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 |
# File 'lib/google/apis/deploymentmanager_v2beta/classes.rb', line 1325 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) @instances_bulk_insert_operation_metadata = args[:instances_bulk_insert_operation_metadata] if args.key?(:instances_bulk_insert_operation_metadata) @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) @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 |