# Genomics API . operations

## Instance Methods

Starts asynchronous cancellation on a long-running operation.

Gets the latest state of a long-running operation.

Lists operations that match the specified filter in the request.

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. Clients may use Operations.GetOperation
    or Operations.ListOperations
    to check whether the cancellation succeeded or the operation completed
    despite cancellation.
    Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&#58;

    * `genomics.operations.cancel`

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

`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.
    Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&#58;

    * `genomics.operations.get`

    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.
        "metadata": { # An OperationMetadata or Metadata object. This will always be returned with the Operation.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "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).
          "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.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        },
        "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
        "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.
        "response": { # An Empty object.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      }

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

    Lists operations that match the specified filter in the request.
    Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&#58;

    * `genomics.operations.list`

    Args:
      name: string, The name of the operation's parent resource. (required)
      filter: string, A string for filtering Operations.
    In v2alpha1, the following filter fields are supported&#58;

    * createTime&#58; The time this job was created
    * events&#58; The set of event (names) that have occurred while running
      the pipeline.  The &#58; operator can be used to determine if a
      particular event has occurred.
    * error&#58; If the pipeline is running, this value is NULL.  Once the
      pipeline finishes, the value is the standard Google error code.
    * labels.key or labels."key with space" where key is a label key.
    * done&#58; If the pipeline is running, this value is false. Once the
      pipeline finishes, the value is true.

    In v1 and v1alpha2, the following filter fields are supported&#58;

    * projectId&#58; Required. Corresponds to
      OperationMetadata.projectId.
    * createTime&#58; The time this job was created, in seconds from the
      [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=`
      operators.
    * status&#58; Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only
      one status may be specified.
    * labels.key where key is a label key.

    Examples&#58;

    * `projectId = my-project AND createTime >= 1432140000`
    * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING`
    * `projectId = my-project AND labels.color = *`
    * `projectId = my-project AND labels.color = red`
      pageSize: integer, The maximum number of results to return. The maximum value is 256.
      pageToken: string, The standard list page token.
      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.
            "metadata": { # An OperationMetadata or Metadata object. This will always be returned with the Operation.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
            "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).
              "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.
              "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            },
            "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
            "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.
            "response": { # An Empty object.
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          },
        ],
        "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.