Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 065b5307fe180bfdd4a5d9af134b1c9a0a1d2aba / . / docs / dyn / genomics_v1beta.jobs.html
blob: 07cb4001f64341d0c95c77e4b985feb86703670b [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.jobs.html">jobs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(jobId)</a></code></p>
79<p class="firstline">Cancels a job by ID. Note that it is possible for partial results to be generated and stored for cancelled jobs.</p>
80<p class="toc_element">
81 <code><a href="#get">get(jobId)</a></code></p>
82<p class="firstline">Gets a job by ID.</p>
83<p class="toc_element">
84 <code><a href="#search">search(body)</a></code></p>
85<p class="firstline">Gets a list of jobs matching the criteria.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="cancel">cancel(jobId)</code>
89 <pre>Cancels a job by ID. Note that it is possible for partial results to be generated and stored for cancelled jobs.
90
91Args:
92 jobId: string, Required. The ID of the job. (required)
93</pre>
94</div>
95
96<div class="method">
97 <code class="details" id="get">get(jobId)</code>
98 <pre>Gets a job by ID.
99
100Args:
101 jobId: string, Required. The ID of the job. (required)
102
103Returns:
104 An object of the form:
105
106 { # A Job represents an ongoing process that can be monitored for status information.
107 "status": "A String", # The status of this job.
108 "errors": [ # Any errors that occurred during processing.
109 "A String",
110 ],
111 "description": "A String", # A more detailed description of this job's current status.
112 "created": "A String", # The date this job was created, in milliseconds from the epoch.
113 "projectId": "A String", # The Google Developers Console project number to which this job belongs.
114 "warnings": [ # Any warnings that occurred during processing.
115 "A String",
116 ],
117 "importedIds": [ # If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.
118 "A String",
119 ],
120 "id": "A String", # The job ID.
121 }</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="search">search(body)</code>
126 <pre>Gets a list of jobs matching the criteria.
127
128Args:
129 body: object, The request body. (required)
130 The object takes the form of:
131
132{ # The jobs search request.
133 "status": [ # Only return jobs which have a matching status.
134 "A String",
135 ],
136 "createdAfter": "A String", # If specified, only jobs created on or after this date, given in milliseconds since Unix epoch, will be returned.
137 "projectId": "A String", # Required. Only return jobs which belong to this Google Developers Console project. Only accepts project numbers.
138 "maxResults": "A String", # Specifies the number of results to return in a single page. Defaults to 128. The maximum value is 256.
139 "pageToken": "A String", # The continuation token which is used to page through large result sets. To get the next page of results, set this parameter to the value of the "nextPageToken" from the previous response.
140 "createdBefore": "A String", # If specified, only jobs created prior to this date, given in milliseconds since Unix epoch, will be returned.
141 }
142
143
144Returns:
145 An object of the form:
146
147 { # The job search response.
148 "nextPageToken": "A String", # The continuation token which is used to page through large result sets. Provide this value is a subsequent request to return the next page of results. This field will be empty if there are no more results.
149 "jobs": [ # The list of jobs results, ordered newest to oldest.
150 { # A Job represents an ongoing process that can be monitored for status information.
151 "status": "A String", # The status of this job.
152 "errors": [ # Any errors that occurred during processing.
153 "A String",
154 ],
155 "description": "A String", # A more detailed description of this job's current status.
156 "created": "A String", # The date this job was created, in milliseconds from the epoch.
157 "projectId": "A String", # The Google Developers Console project number to which this job belongs.
158 "warnings": [ # Any warnings that occurred during processing.
159 "A String",
160 ],
161 "importedIds": [ # If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.
162 "A String",
163 ],
164 "id": "A String", # The job ID.
165 },
166 ],
167 }</pre>
168</div>
169
170</body></html>