You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
283 lines
10 KiB
283 lines
10 KiB
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="genomics_v1.html">Genomics API</a> . <a href="genomics_v1.operations.html">operations</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Starts asynchronous cancellation on a long-running operation.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Gets the latest state of a long-running operation.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
|
|
<p class="firstline">Lists operations that match the specified filter in the request.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
|
|
<pre>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:
|
|
|
|
* `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 `{}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="get">get(name, x__xgafv=None)</code>
|
|
<pre>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:
|
|
|
|
* `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.
|
|
"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.
|
|
"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.
|
|
},
|
|
],
|
|
},
|
|
"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.
|
|
},
|
|
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
|
|
"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.
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
|
|
<pre>Lists operations that match the specified filter in the request.
|
|
Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission:
|
|
|
|
* `genomics.operations.list`
|
|
|
|
Args:
|
|
name: string, The name of the operation's parent resource. (required)
|
|
pageToken: string, The standard list page token.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
pageSize: integer, The maximum number of results to return. The maximum value is 256.
|
|
filter: string, A string for filtering Operations.
|
|
In v2alpha1, the following filter fields are supported:
|
|
|
|
* createTime: The time this job was created
|
|
* events: The set of event (names) that have occurred while running
|
|
the pipeline. The : operator can be used to determine if a
|
|
particular event has occurred.
|
|
* error: 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: 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:
|
|
|
|
* projectId: Required. Corresponds to
|
|
OperationMetadata.projectId.
|
|
* createTime: The time this job was created, in seconds from the
|
|
[epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=`
|
|
operators.
|
|
* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only
|
|
one status may be specified.
|
|
* labels.key where key is a label key.
|
|
|
|
Examples:
|
|
|
|
* `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`
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # The response message for Operations.ListOperations.
|
|
"nextPageToken": "A String", # The standard List next-page token.
|
|
"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.
|
|
"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.
|
|
"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.
|
|
},
|
|
],
|
|
},
|
|
"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.
|
|
},
|
|
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
|
|
"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.
|
|
},
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
<pre>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.
|
|
</pre>
|
|
</div>
|
|
|
|
</body></html> |