# Kubernetes Engine API . projects . zones . operations

## Instance Methods

Cancels the specified operation.

Close httplib2 connections.

Gets the specified operation.

Lists all operations in a project in the specified zone or all zones.

### Method Details

`cancel(projectId, zone, operationId, body=None, x__xgafv=None)`

    Cancels the specified operation.

    Args:
      projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
      zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. (required)
      operationId: string, Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
      body: object, The request body.
        The object takes the form of:

    { # CancelOperationRequest cancels a single operation.
      "name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`.
      "operationId": "A String", # Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
      "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
      "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
    }

`close()`

    Close httplib2 connections.

`get(projectId, zone, operationId, name=None, x__xgafv=None)`

    Gets the specified operation.

    Args:
      projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
      zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
      operationId: string, Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
      name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
      "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
        { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
          "canonicalCode": "A String", # Canonical code of the condition.
          "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
          "message": "A String", # Human-friendly representation of the condition
        },
      ],
      "detail": "A String", # Detailed operation progress, if available.
      "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
      "name": "A String", # The server-assigned ID for the operation.
      "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
        { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
          "canonicalCode": "A String", # Canonical code of the condition.
          "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
          "message": "A String", # Human-friendly representation of the condition
        },
      ],
      "operationType": "A String", # The operation type.
      "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
        "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
          { # Progress metric is (string, int|float|string) pair.
            "doubleValue": 3.14, # For metrics with floating point value.
            "intValue": "A String", # For metrics with integer value.
            "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
            "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
          },
        ],
        "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
        "stages": [ # Substages of an operation or a stage.
          # Object with schema name: OperationProgress
        ],
        "status": "A String", # Status of an operation stage. Unset for single-stage operations.
      },
      "selfLink": "A String", # Server-defined URL for the resource.
      "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
      "status": "A String", # The current status of the operation.
      "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
      "targetLink": "A String", # Server-defined URL for the target of the operation.
      "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
    }

`list(projectId, zone, parent=None, x__xgafv=None)`

    Lists all operations in a project in the specified zone or all zones.

    Args:
      projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
      zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. (required)
      parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # ListOperationsResponse is the result of ListOperationsRequest.
      "missingZones": [ # If any zones are listed here, the list of operations returned may be missing the operations from those zones.
        "A String",
      ],
      "operations": [ # A list of operations in the project in the specified zone.
        { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
          "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
            { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
              "canonicalCode": "A String", # Canonical code of the condition.
              "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
              "message": "A String", # Human-friendly representation of the condition
            },
          ],
          "detail": "A String", # Detailed operation progress, if available.
          "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
          "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          },
          "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
          "name": "A String", # The server-assigned ID for the operation.
          "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
            { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
              "canonicalCode": "A String", # Canonical code of the condition.
              "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
              "message": "A String", # Human-friendly representation of the condition
            },
          ],
          "operationType": "A String", # The operation type.
          "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
            "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
              { # Progress metric is (string, int|float|string) pair.
                "doubleValue": 3.14, # For metrics with floating point value.
                "intValue": "A String", # For metrics with integer value.
                "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
                "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
              },
            ],
            "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
            "stages": [ # Substages of an operation or a stage.
              # Object with schema name: OperationProgress
            ],
            "status": "A String", # Status of an operation stage. Unset for single-stage operations.
          },
          "selfLink": "A String", # Server-defined URL for the resource.
          "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
          "status": "A String", # The current status of the operation.
          "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
          "targetLink": "A String", # Server-defined URL for the target of the operation.
          "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
        },
      ],
    }