Operations

Caution: This is a deprecated version of the Deployment Manager API. Please use the latest API version instead.

Represents an Operations resource. An operation is returned for every request that modifies data.

For a list of methods for this resource, see the end of this page.

Resource representations

An operation resource, used to manage asynchronous API requests.

{
  "selfLink": string,
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": unsigned long,
  "status": string,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "warnings": [
    {
      "code": (value),
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "region": string
}

Property name	Value	Description
`clientOperationId`	`string`	[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC 3339 text format.
`endTime`	`string`	[Output Only] The time that this operation was completed. This is in RFC 3339 format.
`error`	`object`	[Output Only] If errors occurred during processing of this operation, this field will be populated.
`error.errors[]`	`list`	[Output Only] The array of errors encountered while processing this operation.
`error.errors[].code`	`string`	[Output Only] The error type identifier for this error.
`error.errors[].location`	`string`	[Output Only] Indicates the field in the request which caused the error. This property is optional.
`error.errors[].message`	`string`	[Output Only] An optional, human-readable error message.
`httpErrorMessage`	`string`	[Output Only] If operation fails, the HTTP error message returned, e.g. `NOT FOUND`.
`httpErrorStatusCode`	`integer`	[Output Only] If operation fails, the HTTP error status code returned, e.g. `404`.
`id`	`unsigned long`	[Output Only] Unique identifier for the resource; defined by the server.
`insertTime`	`string`	[Output Only] The time that this operation was requested. This is in RFC 3339 format.
`name`	`string`	[Output Only] Name of the operation.
`operationType`	`string`	[Output Only] Type of the operation. Examples include `insert`, or `delete`.
`progress`	`integer`	[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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
`region`	`string`	[Output Only] URL of the region where the operation resides.
`selfLink`	`string`	[Output Only] Self link for the manifest.
`startTime`	`string`	[Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
`status`	`string`	[Output Only] Status of the operation. 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`	`unsigned long`	[Output Only] Unique target ID which identifies a particular incarnation of the target.
`targetLink`	`string`	[Output Only] URL of the resource the operation is mutating.
`user`	`string`	[Output Only] User who requested the operation, for example, `user@example.com`.
`warnings[]`	`list`	[Output Only] If warning messages generated during processing of this operation, this field will be populated.
`warnings[].code`	`any value`	[Output Only] The warning type identifier for this warning.
`warnings[].data[]`	`list`	[Output Only] Metadata for this warning in 'key: value' format.
`warnings[].data[].key`	`string`	[Output Only] A key for the warning data.
`warnings[].data[].value`	`string`	[Output Only] A warning data value corresponding to the key.
`warnings[].message`	`string`	[Output Only] Optional human-readable details for this warning.
`zone`	`string`	[Output Only] URL of the zone where the operation resides.

Methods

get: Gets information about a specific operation.
list: Lists all operations for a project.