Compute Engine API . globalOperations

Instance Methods

aggregatedList(project, maxResults=None, pageToken=None, filter=None)

Retrieves the list of all operations grouped by scope.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, operation)

Deletes the specified operation resource.

get(project, operation)

Retrieves the specified operation resource.

list(project, maxResults=None, pageToken=None, filter=None)

Retrieves the list of operation resources contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None)
Retrieves the list of all operations grouped by scope.

Args:
  project: string, Name of the project scoping this request. (required)
  maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
  pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
  filter: string, Optional. Filter expression for filtering listed resources.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
    "items": { # [Output Only] A map of scoped operation lists.
      "a_key": { # [Output Only] Name of the scope containing this set of operations.
        "operations": [ # [Output Only] List of operations contained in this scope.
          { # An operation resource, used to manage asynchronous API requests.
            "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
            "clientOperationId": "A String",
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
            "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
            "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
            "operationType": "A String",
            "httpErrorMessage": "A String",
            "progress": 42,
            "httpErrorStatusCode": 42,
            "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
            "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
            "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
            "warnings": [
              {
                "message": "A String", # Optional human-readable details for this warning.
                "code": "A String", # The warning type identifier for this warning.
                "data": [ # Metadata for this warning in 'key: value' format.
                  {
                    "value": "A String", # A warning data value corresponding to the key.
                    "key": "A String", # A key for the warning data.
                  },
                ],
              },
            ],
            "user": "A String",
            "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
            "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
            "name": "A String", # [Output Only] Name of the resource (output only).
            "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
            "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
              "errors": [ # [Output Only] The array of errors encountered while processing this operation.
                {
                  "message": "A String", # [Output Only] An optional, human-readable error message.
                  "code": "A String", # [Output Only] The error type identifier for this error.
                  "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
                },
              ],
            },
            "endTime": "A String",
            "selfLink": "A String", # [Output Only] Server defined URL for the resource.
            "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
          },
        ],
        "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
          "message": "A String", # Optional human-readable details for this warning.
          "code": "A String", # The warning type identifier for this warning.
          "data": [ # Metadata for this warning in 'key: value' format.
            {
              "value": "A String", # A warning data value corresponding to the key.
              "key": "A String", # A key for the warning data.
            },
          ],
        },
      },
    },
    "kind": "compute#operationAggregatedList", # Type of resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for this resource.
  }
aggregatedList_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
delete(project, operation)
Deletes the specified operation resource.

Args:
  project: string, Name of the project scoping this request. (required)
  operation: string, Name of the operation resource to delete. (required)
get(project, operation)
Retrieves the specified operation resource.

Args:
  project: string, Name of the project scoping this request. (required)
  operation: string, Name of the operation resource to return. (required)

Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
    "clientOperationId": "A String",
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
    "operationType": "A String",
    "httpErrorMessage": "A String",
    "progress": 42,
    "httpErrorStatusCode": 42,
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
    "warnings": [
      {
        "message": "A String", # Optional human-readable details for this warning.
        "code": "A String", # The warning type identifier for this warning.
        "data": [ # Metadata for this warning in 'key: value' format.
          {
            "value": "A String", # A warning data value corresponding to the key.
            "key": "A String", # A key for the warning data.
          },
        ],
      },
    ],
    "user": "A String",
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the resource (output only).
    "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String",
    "selfLink": "A String", # [Output Only] Server defined URL for the resource.
    "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
  }
list(project, maxResults=None, pageToken=None, filter=None)
Retrieves the list of operation resources contained within the specified project.

Args:
  project: string, Name of the project scoping this request. (required)
  maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
  pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
  filter: string, Optional. Filter expression for filtering listed resources.

Returns:
  An object of the form:

    { # Contains a list of operation resources.
    "nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
    "items": [ # [Output Only] The operation resources.
      { # An operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
        "clientOperationId": "A String",
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
        "operationType": "A String",
        "httpErrorMessage": "A String",
        "progress": 42,
        "httpErrorStatusCode": 42,
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
        "warnings": [
          {
            "message": "A String", # Optional human-readable details for this warning.
            "code": "A String", # The warning type identifier for this warning.
            "data": [ # Metadata for this warning in 'key: value' format.
              {
                "value": "A String", # A warning data value corresponding to the key.
                "key": "A String", # A key for the warning data.
              },
            ],
          },
        ],
        "user": "A String",
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource (output only).
        "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
        "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String",
        "selfLink": "A String", # [Output Only] Server defined URL for the resource.
        "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
      },
    ],
    "kind": "compute#operationList", # Type of resource. Always compute#operations for Operations resource.
    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
    "selfLink": "A String", # [Output Only] Server defined URL for this resource.
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.