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.

158 lines
4.8 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_v2alpha1.html">Genomics API</a> . <a href="genomics_v2alpha1.workers.html">workers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#checkIn">checkIn(id, body, x__xgafv=None)</a></code></p>
<p class="firstline">The worker uses this method to retrieve the assigned operation and</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="checkIn">checkIn(id, body, x__xgafv=None)</code>
<pre>The worker uses this method to retrieve the assigned operation and
provide periodic status updates.
Args:
id: string, The worker id, assigned when it was created. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The parameters to the CheckIn method.
"deadlineExpired": { # A generic empty message that you can re-use to avoid defining duplicated # The deadline has expired and the worker needs more time.
# 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 `{}`.
},
"workerStatus": { # The status of the worker VM. # Data about the status of the worker VM.
"attachedDisks": { # Status of attached disks.
"a_key": { # The status of a disk on a VM.
"totalSpaceBytes": "A String", # Total disk space.
"freeSpaceBytes": "A String", # Free disk space.
},
},
"freeRamBytes": "A String", # Free RAM.
"uptimeSeconds": "A String", # System uptime.
"totalRamBytes": "A String", # Total RAM.
"bootDisk": { # The status of a disk on a VM. # Status of the boot disk.
"totalSpaceBytes": "A String", # Total disk space.
"freeSpaceBytes": "A String", # Free disk space.
},
},
"event": { # A workflow specific event occurred.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"result": { # The `Status` type defines a logical error model that is suitable for # The operation has finished with the given result.
# 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.
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to the CheckIn method.
"deadline": "A String", # The deadline by which the worker must request an extension. The backend
# will allow for network transmission time and other delays, but the worker
# must attempt to transmit the extension request no later than the deadline.
"metadata": { # The metadata that describes the operation assigned to the worker.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>