operations

Creates, updates, deletes, gets or lists an operations resource.

Overview

Name	operations
Type	Resource
Id	google.deploymentmanager.operations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
name	string	[Output Only] Name of the operation.
clientOperationId	string	[Output Only] The value of requestId if you provided it in the request. Not present otherwise.
creationTimestamp	string	[Deprecated] This field is deprecated.
description	string	[Output Only] A textual description of the operation, which is set when the operation is created.
endTime	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
error	object	[Output Only] If errors are generated during processing of the operation, this field will be populated.
httpErrorMessage	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
httpErrorStatusCode	integer (int32)	[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.
insertTime	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
instancesBulkInsertOperationMetadata	object	(id: InstancesBulkInsertOperationMetadata)
kind	string	[Output Only] Type of the resource. Always compute#operation for Operation resources. (default: compute#operation)
operationGroupId	string	[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
operationType	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
progress	integer (int32)	[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.
region	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
selfLink	string	[Output Only] Server-defined URL for the resource.
selfLinkWithId	string	[Output Only] Server-defined URL for this resource with the resource id.
setAutoscalerLinkOperationMetadata	object	This field is used internally by the Autoscaler team and should not be promoted to "alpha/beta/v1". (id: SetAutoscalerLinkOperationMetadata)
setCommonInstanceMetadataOperationMetadata	object	[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. (id: SetCommonInstanceMetadataOperationMetadata)
startTime	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
status	string	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
statusMessage	string	[Output Only] An optional textual description of the current status of the operation.
targetId	string (uint64)	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
targetLink	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
user	string	[Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).
warnings	array	[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. Only applicable when performing per-zone operations.

list

Successful response

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the operation. This identifier is defined by the server.
name	string	[Output Only] Name of the operation.
clientOperationId	string	[Output Only] The value of requestId if you provided it in the request. Not present otherwise.
creationTimestamp	string	[Deprecated] This field is deprecated.
description	string	[Output Only] A textual description of the operation, which is set when the operation is created.
endTime	string	[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
error	object	[Output Only] If errors are generated during processing of the operation, this field will be populated.
httpErrorMessage	string	[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
httpErrorStatusCode	integer (int32)	[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.
insertTime	string	[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
instancesBulkInsertOperationMetadata	object	(id: InstancesBulkInsertOperationMetadata)
kind	string	[Output Only] Type of the resource. Always compute#operation for Operation resources. (default: compute#operation)
operationGroupId	string	[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.
operationType	string	[Output Only] The type of operation, such as insert, update, or delete, and so on.
progress	integer (int32)	[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.
region	string	[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
selfLink	string	[Output Only] Server-defined URL for the resource.
selfLinkWithId	string	[Output Only] Server-defined URL for this resource with the resource id.
setAutoscalerLinkOperationMetadata	object	This field is used internally by the Autoscaler team and should not be promoted to "alpha/beta/v1". (id: SetAutoscalerLinkOperationMetadata)
setCommonInstanceMetadataOperationMetadata	object	[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. (id: SetCommonInstanceMetadataOperationMetadata)
startTime	string	[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
status	string	[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
statusMessage	string	[Output Only] An optional textual description of the current status of the operation.
targetId	string (uint64)	[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
targetLink	string	[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
user	string	[Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).
warnings	array	[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. Only applicable when performing per-zone operations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, operation	header.bypassBillingFilter	Gets information about a specific operation.
list	select	project	maxResults, pageToken, filter, orderBy	Lists all operations for a project.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
operation	string
project	string
filter	string
header.bypassBillingFilter	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string

SELECT examples

get

Gets information about a specific operation.

SELECT
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
selfLinkWithId,
setAutoscalerLinkOperationMetadata,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
FROM google.deploymentmanager.operations
WHERE project = '{{ project }}' -- required
AND operation = '{{ operation }}' -- required
AND header.bypassBillingFilter = '{{ header.bypassBillingFilter }}';

list

Lists all operations for a project.

SELECT
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
selfLinkWithId,
setAutoscalerLinkOperationMetadata,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
FROM google.deploymentmanager.operations
WHERE project = '{{ project }}' -- required
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';