# Cloud Firestore API . projects . databases . operations

## Instance Methods

Starts asynchronous cancellation on a long-running operation. The server

Deletes a long-running operation. This method indicates that the client is

Gets the latest state of a long-running operation. Clients can use this

Lists operations that match the specified filter in the request. If the

Retrieves the next page of results.

### Method Details

`cancel(name, body=None, x__xgafv=None)`

    Starts asynchronous cancellation on a long-running operation.  The server
    makes a best effort to cancel the operation, but success is not
    guaranteed.  If the server doesn't support this method, it returns
    `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
    Operations.GetOperation or
    other methods to check whether the cancellation succeeded or whether the
    operation completed despite cancellation. On successful cancellation,
    the operation is not deleted; instead, it becomes an operation with
    an Operation.error value with a google.rpc.Status.code of 1,
    corresponding to `Code.CANCELLED`.

    Args:
      name: string, The name of the operation resource to be cancelled. (required)
      body: object, The request body.
        The object takes the form of:

    { # The request message for Operations.CancelOperation.
      }

      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 `{}`.
      }

`delete(name, x__xgafv=None)`

    Deletes a long-running operation. This method indicates that the client is
    no longer interested in the operation result. It does not cancel the
    operation. If the server doesn't support this method, it returns
    `google.rpc.Code.UNIMPLEMENTED`.

    Args:
      name: string, The name of the operation resource to be deleted. (required)
      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(name, x__xgafv=None)`

    Gets the latest state of a long-running operation.  Clients can use this
    method to poll the operation result at intervals as recommended by the API
    service.

    Args:
      name: string, The name of the operation resource. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "response": { # The normal response of the operation in case of success.  If the original
            # method returns no data on success, such as `Delete`, the response is
            # `google.protobuf.Empty`.  If the original method is standard
            # `Get`/`Create`/`Update`, the response should be the resource.  For other
            # methods, the response should have the type `XxxResponse`, where `Xxx`
            # is the original method name.  For example, if the original method name
            # is `TakeSnapshot()`, the inferred response type is
            # `TakeSnapshotResponse`.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that
            # originally returns it. If you use the default HTTP mapping, the
            # `name` should be a resource name ending with `operations/{unique_id}`.
        "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
            # 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).
          "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.
          "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.
            },
          ],
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        },
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "done": True or False, # If the value is `false`, it means the operation is still in progress.
            # If `true`, the operation is completed, and either `error` or `response` is
            # available.
      }

`list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)`

    Lists operations that match the specified filter in the request. If the
    server doesn't support this method, it returns `UNIMPLEMENTED`.

    NOTE: the `name` binding allows API services to override the binding
    to use different resource name schemes, such as `users/*/operations`. To
    override the binding, API services can add a binding such as
    `"/v1/{name=users/*}/operations"` to their service configuration.
    For backwards compatibility, the default name includes the operations
    collection id, however overriding users must ensure the name binding
    is the parent resource, without the operations collection id.

    Args:
      name: string, The name of the operation's parent resource. (required)
      filter: string, The standard list filter.
      pageToken: string, The standard list page token.
      pageSize: integer, The standard list page size.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # The response message for Operations.ListOperations.
        "operations": [ # A list of operations that matches the specified filter in the request.
          { # This resource represents a long-running operation that is the result of a
              # network API call.
            "response": { # The normal response of the operation in case of success.  If the original
                # method returns no data on success, such as `Delete`, the response is
                # `google.protobuf.Empty`.  If the original method is standard
                # `Get`/`Create`/`Update`, the response should be the resource.  For other
                # methods, the response should have the type `XxxResponse`, where `Xxx`
                # is the original method name.  For example, if the original method name
                # is `TakeSnapshot()`, the inferred response type is
                # `TakeSnapshotResponse`.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "name": "A String", # The server-assigned name, which is only unique within the same service that
                # originally returns it. If you use the default HTTP mapping, the
                # `name` should be a resource name ending with `operations/{unique_id}`.
            "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
                # 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).
              "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.
              "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.
                },
              ],
              "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            },
            "metadata": { # Service-specific metadata associated with the operation.  It typically
                # contains progress information and common metadata such as create time.
                # Some services might not provide such metadata.  Any method that returns a
                # long-running operation should document the metadata type, if any.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "done": True or False, # If the value is `false`, it means the operation is still in progress.
                # If `true`, the operation is completed, and either `error` or `response` is
                # available.
          },
        ],
        "nextPageToken": "A String", # The standard List next-page token.
      }

`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.