Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e8ed9ea1aa4e93ccef9afc8483818df43f78ddc8 / . / docs / dyn / genomics_v1beta2.references.html
blob: 71367507c7b13121142ddd6cd785331000896428 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[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_v1beta2.html">Genomics API</a> . <a href="genomics_v1beta2.references.html">references</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="genomics_v1beta2.references.bases.html">bases()</a></code>
79</p>
80<p class="firstline">Returns the bases Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#get">get(referenceId)</a></code></p>
84<p class="firstline">Gets a reference.</p>
85<p class="toc_element">
86 <code><a href="#search">search(body)</a></code></p>
87<p class="firstline">Searches for references which match the given criteria.</p>
88<h3>Method Details</h3>
89<div class="method">
90 <code class="details" id="get">get(referenceId)</code>
91 <pre>Gets a reference.
92
93Implements GlobalAllianceApi.getReference.
94
95Args:
96 referenceId: string, The ID of the reference. (required)
97
98Returns:
99 An object of the form:
100
101 { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets.
102 "name": "A String", # The name of this reference, for example 22.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]103 "sourceURI": "A String", # The URI from which the sequence was obtained. Typically specifies a FASTA format file.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]104 "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example GCF_000001405.26.
105 "A String",
106 ],
107 "length": "A String", # The length of this reference's sequence.
108 "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format.
109 "id": "A String", # The Google generated immutable ID of the reference.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]110 "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]111 }</pre>
112</div>
113
114<div class="method">
115 <code class="details" id="search">search(body)</code>
116 <pre>Searches for references which match the given criteria.
117
118Implements GlobalAllianceApi.searchReferences.
119
120Args:
121 body: object, The request body. (required)
122 The object takes the form of:
123
124{
125 "md5checksums": [ # If present, return references for which the md5checksum matches. See Reference.md5checksum for construction details.
126 "A String",
127 ],
128 "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 nextPageToken from the previous response.
129 "referenceSetId": "A String", # If present, return only references which belong to this reference set.
130 "accessions": [ # If present, return references for which the accession matches this string. Best to give a version number, for example GCF_000001405.26. If only the main accession number is given then all records with that main accession will be returned, whichever version. Note that different versions will have different sequences.
131 "A String",
132 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]133 "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]134 }
135
136
137Returns:
138 An object of the form:
139
140 {
141 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
142 "references": [ # The matching references.
143 { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets.
144 "name": "A String", # The name of this reference, for example 22.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]145 "sourceURI": "A String", # The URI from which the sequence was obtained. Typically specifies a FASTA format file.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]146 "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example GCF_000001405.26.
147 "A String",
148 ],
149 "length": "A String", # The length of this reference's sequence.
150 "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format.
151 "id": "A String", # The Google generated immutable ID of the reference.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]152 "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]153 },
154 ],
155 }</pre>
156</div>
157
158</body></html>