# Kubernetes Engine API . projects . zones . operations

## Instance Methods

Cancels the specified operation.

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://support.google.com/cloud/answer/6158840).
    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://support.google.com/cloud/answer/6158840).
            # 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);
          #     }
          #
          # The JSON representation for `Empty` is empty JSON object `{}`.
      }

`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://support.google.com/cloud/answer/6158840).
    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.
        "targetLink": "A String", # Server-defined URL for the target of the operation.
        "detail": "A String", # Detailed operation progress, if available.
        "operationType": "A String", # The operation type.
        "status": "A String", # The current status of the operation.
        "name": "A String", # The server-assigned ID for the operation.
        "nodepoolConditions": [ # Which conditions caused the current node pool state.
          { # StatusCondition describes why a cluster or a node pool has a certain status
              # (e.g., ERROR or DEGRADED).
            "code": "A String", # Machine-friendly representation of the condition
            "message": "A String", # Human-friendly representation of the condition
          },
        ],
        "endTime": "A String", # [Output only] The time the operation completed, in
            # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
        "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.
        "startTime": "A String", # [Output only] The time the operation started, in
            # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
        "clusterConditions": [ # Which conditions caused the current cluster state.
          { # StatusCondition describes why a cluster or a node pool has a certain status
              # (e.g., ERROR or DEGRADED).
            "code": "A String", # Machine-friendly representation of the condition
            "message": "A String", # Human-friendly representation of the condition
          },
        ],
        "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.
              "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
              "doubleValue": 3.14, # For metrics with floating point value.
              "intValue": "A String", # For metrics with integer value.
              "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
            },
          ],
          "status": "A String", # Status of an operation stage.
              # Unset for single-stage operations.
          "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
          ],
        },
        "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.
        "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
        "selfLink": "A String", # Server-defined URL for the resource.
      }

`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://support.google.com/cloud/answer/6158840).
    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.
        "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.
            "targetLink": "A String", # Server-defined URL for the target of the operation.
            "detail": "A String", # Detailed operation progress, if available.
            "operationType": "A String", # The operation type.
            "status": "A String", # The current status of the operation.
            "name": "A String", # The server-assigned ID for the operation.
            "nodepoolConditions": [ # Which conditions caused the current node pool state.
              { # StatusCondition describes why a cluster or a node pool has a certain status
                  # (e.g., ERROR or DEGRADED).
                "code": "A String", # Machine-friendly representation of the condition
                "message": "A String", # Human-friendly representation of the condition
              },
            ],
            "endTime": "A String", # [Output only] The time the operation completed, in
                # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
            "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.
            "startTime": "A String", # [Output only] The time the operation started, in
                # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
            "clusterConditions": [ # Which conditions caused the current cluster state.
              { # StatusCondition describes why a cluster or a node pool has a certain status
                  # (e.g., ERROR or DEGRADED).
                "code": "A String", # Machine-friendly representation of the condition
                "message": "A String", # Human-friendly representation of the condition
              },
            ],
            "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.
                  "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
                  "doubleValue": 3.14, # For metrics with floating point value.
                  "intValue": "A String", # For metrics with integer value.
                  "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
                },
              ],
              "status": "A String", # Status of an operation stage.
                  # Unset for single-stage operations.
              "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
              ],
            },
            "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.
            "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
            "selfLink": "A String", # Server-defined URL for the resource.
          },
        ],
        "missingZones": [ # If any zones are listed here, the list of operations returned
            # may be missing the operations from those zones.
          "A String",
        ],
      }