blob: 18fb4be2447f9106de946e9a78b99d3248084fe8 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -07001<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_v1.html">Genomics API</a> . <a href="genomics_v1.references.html">references</a> . <a href="genomics_v1.references.bases.html">bases</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040078 <code><a href="#list">list(referenceId, end=None, pageSize=None, start=None, pageToken=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Lists the bases in a reference, optionally restricted to a range.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -070080<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040085 <code class="details" id="list">list(referenceId, end=None, pageSize=None, start=None, pageToken=None, x__xgafv=None)</code>
86 <pre>Lists the bases in a reference, optionally restricted to a range.
87
88For the definitions of references and other genomics resources, see
89[Fundamentals of Google
90Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
91
92Implements
93[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).
Takashi Matsuo06694102015-09-11 13:55:40 -070094
95Args:
96 referenceId: string, The ID of the reference. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040097 end: string, The end position (0-based, exclusive) of this query. Defaults to the length
98of this reference.
99 pageSize: integer, The maximum number of bases to return in a single page. If unspecified,
100defaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base
101pairs).
Takashi Matsuo06694102015-09-11 13:55:40 -0700102 start: string, The start position (0-based) of this query. Defaults to 0.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400103 pageToken: string, The continuation token, which is used to page through large result sets.
104To get the next page of results, set this parameter to the value of
105`nextPageToken` from the previous response.
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700110
111Returns:
112 An object of the form:
113
114 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400115 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets.
116 # Provide this value in a subsequent request to return the next page of
117 # results. This field will be empty if there aren't any additional results.
118 "offset": "A String", # The offset position (0-based) of the given `sequence` from the
119 # start of this `Reference`. This value will differ for each page
120 # in a paginated request.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400121 "sequence": "A String", # A substring of the bases that make up this reference.
Takashi Matsuo06694102015-09-11 13:55:40 -0700122 }</pre>
123</div>
124
125<div class="method">
126 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
127 <pre>Retrieves the next page of results.
128
129Args:
130 previous_request: The request for the previous page. (required)
131 previous_response: The response from the request for the previous page. (required)
132
133Returns:
134 A request object that you can call 'execute()' on to request the next
135 page. Returns None if there are no more items in the collection.
136 </pre>
137</div>
138
139</body></html>