blob: dc62800621035f1a68009cadb696c28cdeae15e2 [file] [log] [blame]
<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_v1beta2.html">Genomics API</a> . <a href="genomics_v1beta2.callsets.html">callsets</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(body)</a></code></p>
<p class="firstline">Creates a new call set.</p>
<p class="toc_element">
<code><a href="#delete">delete(callSetId)</a></code></p>
<p class="firstline">Deletes a call set.</p>
<p class="toc_element">
<code><a href="#get">get(callSetId)</a></code></p>
<p class="firstline">Gets a call set by ID.</p>
<p class="toc_element">
<code><a href="#patch">patch(callSetId, body)</a></code></p>
<p class="firstline">Updates a call set. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#search">search(body)</a></code></p>
<p class="firstline">Gets a list of call sets matching the criteria.</p>
<p class="toc_element">
<code><a href="#update">update(callSetId, body)</a></code></p>
<p class="firstline">Updates a call set.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(body)</code>
<pre>Creates a new call set.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
"info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The call set name.
"created": "A String", # The date this call set was created in milliseconds from the epoch.
"sampleId": "A String", # The sample ID this call set corresponds to.
"variantSetIds": [ # The IDs of the variant sets this call set belongs to.
"A String",
],
"id": "A String", # The Google generated ID of the call set, immutable.
}
Returns:
An object of the form:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
"info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The call set name.
"created": "A String", # The date this call set was created in milliseconds from the epoch.
"sampleId": "A String", # The sample ID this call set corresponds to.
"variantSetIds": [ # The IDs of the variant sets this call set belongs to.
"A String",
],
"id": "A String", # The Google generated ID of the call set, immutable.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(callSetId)</code>
<pre>Deletes a call set.
Args:
callSetId: string, The ID of the call set to be deleted. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(callSetId)</code>
<pre>Gets a call set by ID.
Args:
callSetId: string, The ID of the call set. (required)
Returns:
An object of the form:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
"info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The call set name.
"created": "A String", # The date this call set was created in milliseconds from the epoch.
"sampleId": "A String", # The sample ID this call set corresponds to.
"variantSetIds": [ # The IDs of the variant sets this call set belongs to.
"A String",
],
"id": "A String", # The Google generated ID of the call set, immutable.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(callSetId, body)</code>
<pre>Updates a call set. This method supports patch semantics.
Args:
callSetId: string, The ID of the call set to be updated. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
"info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The call set name.
"created": "A String", # The date this call set was created in milliseconds from the epoch.
"sampleId": "A String", # The sample ID this call set corresponds to.
"variantSetIds": [ # The IDs of the variant sets this call set belongs to.
"A String",
],
"id": "A String", # The Google generated ID of the call set, immutable.
}
Returns:
An object of the form:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
"info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The call set name.
"created": "A String", # The date this call set was created in milliseconds from the epoch.
"sampleId": "A String", # The sample ID this call set corresponds to.
"variantSetIds": [ # The IDs of the variant sets this call set belongs to.
"A String",
],
"id": "A String", # The Google generated ID of the call set, immutable.
}</pre>
</div>
<div class="method">
<code class="details" id="search">search(body)</code>
<pre>Gets a list of call sets matching the criteria.
Implements GlobalAllianceApi.searchCallSets.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # The call set search request.
"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.
"variantSetIds": [ # Restrict the query to call sets within the given variant sets. At least one ID must be provided.
"A String",
],
"name": "A String", # Only return call sets for which a substring of the name matches this string.
"pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024.
}
Returns:
An object of the form:
{ # The call set search response.
"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.
"callSets": [ # The list of matching call sets.
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
"info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The call set name.
"created": "A String", # The date this call set was created in milliseconds from the epoch.
"sampleId": "A String", # The sample ID this call set corresponds to.
"variantSetIds": [ # The IDs of the variant sets this call set belongs to.
"A String",
],
"id": "A String", # The Google generated ID of the call set, immutable.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(callSetId, body)</code>
<pre>Updates a call set.
Args:
callSetId: string, The ID of the call set to be updated. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
"info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The call set name.
"created": "A String", # The date this call set was created in milliseconds from the epoch.
"sampleId": "A String", # The sample ID this call set corresponds to.
"variantSetIds": [ # The IDs of the variant sets this call set belongs to.
"A String",
],
"id": "A String", # The Google generated ID of the call set, immutable.
}
Returns:
An object of the form:
{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
"info": { # A string which maps to an array of values.
"a_key": [ # A string which maps to an array of values.
"A String",
],
},
"name": "A String", # The call set name.
"created": "A String", # The date this call set was created in milliseconds from the epoch.
"sampleId": "A String", # The sample ID this call set corresponds to.
"variantSetIds": [ # The IDs of the variant sets this call set belongs to.
"A String",
],
"id": "A String", # The Google generated ID of the call set, immutable.
}</pre>
</div>
</body></html>