octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-12-25 12:09:59 +00:00
Code Issues Releases Wiki Activity
315b7f282f
restic/vendor/google.golang.org/api/genomics/v1/genomics-api.json
Alexander Neumann 61cb1cc6f8 Update vendored dependencies 
This includes github.com/kurin/blazer 0.2.0, which resolves #1291
2017-10-01 10:13:39 +02:00

3818 lines
179 KiB
JSON
Raw Blame History

{
"rootUrl": "https://genomics.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "genomics",
"batchPath": "batch",
"documentationLink": "https://cloud.google.com/genomics",
"revision": "20170928",
"id": "genomics:v1",
"title": "Genomics API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"callsets": {
"methods": {
"delete": {
"description": "Deletes a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"callSetId"
],
"parameters": {
"callSetId": {
"location": "path",
"description": "The ID of the call set to be deleted.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/callsets/{callSetId}",
"path": "v1/callsets/{callSetId}",
"id": "genomics.callsets.delete"
},
"search": {
"path": "v1/callsets/search",
"id": "genomics.callsets.search",
"description": "Gets a list of call sets matching the criteria.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).",
"request": {
"$ref": "SearchCallSetsRequest"
},
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "SearchCallSetsResponse"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/callsets/search"
},
"get": {
"response": {
"$ref": "CallSet"
},
"parameterOrder": [
"callSetId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {
"callSetId": {
"location": "path",
"description": "The ID of the call set.",
"type": "string",
"required": true
}
},
"flatPath": "v1/callsets/{callSetId}",
"id": "genomics.callsets.get",
"path": "v1/callsets/{callSetId}",
"description": "Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
"patch": {
"description": "Updates a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
"request": {
"$ref": "CallSet"
},
"response": {
"$ref": "CallSet"
},
"parameterOrder": [
"callSetId"
],
"httpMethod": "PATCH",
"parameters": {
"callSetId": {
"description": "The ID of the call set to be updated.",
"type": "string",
"required": true,
"location": "path"
},
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/callsets/{callSetId}",
"id": "genomics.callsets.patch",
"path": "v1/callsets/{callSetId}"
},
"create": {
"path": "v1/callsets",
"id": "genomics.callsets.create",
"request": {
"$ref": "CallSet"
},
"description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "CallSet"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {},
"flatPath": "v1/callsets"
}
}
},
"reads": {
"methods": {
"search": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "SearchReadsResponse"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/reads/search",
"path": "v1/reads/search",
"id": "genomics.reads.search",
"description": "Gets a list of reads for one or more read group sets.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nReads search operates over a genomic coordinate space of reference sequence\n& position defined over the reference sequences to which the requested\nread group sets are aligned.\n\nIf a target positional range is specified, search returns all reads whose\nalignment to the reference genome overlap the range. A query which\nspecifies only read group set IDs yields all reads in those read group\nsets, including unmapped reads.\n\nAll reads returned (including reads on subsequent pages) are ordered by\ngenomic coordinate (by reference sequence, then position). Reads with\nequivalent genomic coordinates are returned in an unspecified order. This\norder is consistent, such that two queries for the same content (regardless\nof page size) yield reads in the same order across their respective streams\nof paginated responses.\n\nImplements\n[GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).",
"request": {
"$ref": "SearchReadsRequest"
}
}
}
},
"readgroupsets": {
"methods": {
"import": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.read_write",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {},
"flatPath": "v1/readgroupsets:import",
"path": "v1/readgroupsets:import",
"id": "genomics.readgroupsets.import",
"request": {
"$ref": "ImportReadGroupSetsRequest"
},
"description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)"
},
"delete": {
"httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"readGroupSetId"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
"readGroupSetId": {
"location": "path",
"description": "The ID of the read group set to be deleted. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
"type": "string",
"required": true
}
},
"flatPath": "v1/readgroupsets/{readGroupSetId}",
"path": "v1/readgroupsets/{readGroupSetId}",
"id": "genomics.readgroupsets.delete",
"description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
"export": {
"httpMethod": "POST",
"parameterOrder": [
"readGroupSetId"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"readGroupSetId": {
"location": "path",
"description": "Required. The ID of the read group set to export. The caller must have\nREAD access to this read group set.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.read_write",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/readgroupsets/{readGroupSetId}:export",
"path": "v1/readgroupsets/{readGroupSetId}:export",
"id": "genomics.readgroupsets.export",
"description": "Exports a read group set to a BAM file in Google Cloud Storage.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nNote that currently there may be some differences between exported BAM\nfiles and the original BAM file at the time of import. See\nImportReadGroupSets\nfor caveats.",
"request": {
"$ref": "ExportReadGroupSetRequest"
}
},
"search": {
"response": {
"$ref": "SearchReadGroupSetsResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/readgroupsets/search",
"id": "genomics.readgroupsets.search",
"path": "v1/readgroupsets/search",
"description": "Searches for read group sets matching the criteria.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).",
"request": {
"$ref": "SearchReadGroupSetsRequest"
}
},
"get": {
"id": "genomics.readgroupsets.get",
"path": "v1/readgroupsets/{readGroupSetId}",
"description": "Gets a read group set by ID.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"response": {
"$ref": "ReadGroupSet"
},
"parameterOrder": [
"readGroupSetId"
],
"httpMethod": "GET",
"parameters": {
"readGroupSetId": {
"location": "path",
"description": "The ID of the read group set.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/readgroupsets/{readGroupSetId}"
},
"patch": {
"description": "Updates a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
"request": {
"$ref": "ReadGroupSet"
},
"httpMethod": "PATCH",
"parameterOrder": [
"readGroupSetId"
],
"response": {
"$ref": "ReadGroupSet"
},
"parameters": {
"readGroupSetId": {
"description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
"type": "string",
"required": true,
"location": "path"
},
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/readgroupsets/{readGroupSetId}",
"path": "v1/readgroupsets/{readGroupSetId}",
"id": "genomics.readgroupsets.patch"
}
},
"resources": {
"coveragebuckets": {
"methods": {
"list": {
"response": {
"$ref": "ListCoverageBucketsResponse"
},
"parameterOrder": [
"readGroupSetId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {
"start": {
"format": "int64",
"description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified. Defaults to 0.",
"type": "string",
"location": "query"
},
"readGroupSetId": {
"description": "Required. The ID of the read group set over which coverage is requested.",
"type": "string",
"required": true,
"location": "path"
},
"targetBucketWidth": {
"format": "int64",
"description": "The desired width of each reported coverage bucket in base pairs. This\nwill be rounded down to the nearest precomputed bucket width; the value\nof which is returned as `bucketWidth` in the response. Defaults\nto infinity (each bucket spans an entire reference sequence) or the length\nof the target range, if specified. The smallest precomputed\n`bucketWidth` is currently 2048 base pairs; this is subject to\nchange.",
"type": "string",
"location": "query"
},
"referenceName": {
"description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
"type": "string",
"location": "query"
},
"end": {
"location": "query",
"format": "int64",
"description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified. If unset or 0, defaults\nto the length of the reference.",
"type": "string"
},
"pageToken": {
"location": "query",
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 2048.",
"type": "integer"
}
},
"flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
"id": "genomics.readgroupsets.coveragebuckets.list",
"path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
"description": "Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset."
}
}
}
}
},
"variants": {
"methods": {
"import": {
"id": "genomics.variants.import",
"path": "v1/variants:import",
"request": {
"$ref": "ImportVariantsRequest"
},
"description": "Creates variant data by asynchronously importing the provided information.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe variants for import will be merged with any existing variant that\nmatches its reference sequence, start, end, reference bases, and\nalternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant, and Variant info fields are merged\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF files, QUAL and FILTER fields will\nbe moved to the call level; these are sometimes interpreted in a\ncall-specific context.\nImported VCF headers are appended to the metadata already in a variant set.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.read_write",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {},
"flatPath": "v1/variants:import"
},
"delete": {
"httpMethod": "DELETE",
"parameterOrder": [
"variantId"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"variantId": {
"description": "The ID of the variant to be deleted.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/variants/{variantId}",
"path": "v1/variants/{variantId}",
"id": "genomics.variants.delete",
"description": "Deletes a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
"merge": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "Empty"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/variants:merge",
"path": "v1/variants:merge",
"id": "genomics.variants.merge",
"description": "Merges the given variants with existing variants.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach variant will be\nmerged with an existing variant that matches its reference sequence,\nstart, end, reference bases, and alternative bases. If no such variant\nexists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant. Variant info fields are merged as\nspecified in the\ninfoMergeConfig\nfield of the MergeVariantsRequest.\n\nPlease exercise caution when using this method! It is easy to introduce\nmistakes in existing variants and difficult to back out of them. For\nexample,\nsuppose you were trying to merge a new variant with an existing one and\nboth\nvariants contain calls that belong to callsets with the same callset ID.\n\n // Existing variant - irrelevant fields trimmed for clarity\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 0,\n 1\n ],\n }\n ]\n }\n\n // New variant with conflicting call information\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThe resulting merged variant would overwrite the existing calls with those\nfrom the new variant:\n\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThis may be the desired outcome, but it is up to the user to determine if\nif that is indeed the case.",
"request": {
"$ref": "MergeVariantsRequest"
}
},
"create": {
"path": "v1/variants",
"id": "genomics.variants.create",
"request": {
"$ref": "Variant"
},
"description": "Creates a new variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "Variant"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {},
"flatPath": "v1/variants"
},
"search": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "SearchVariantsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {},
"flatPath": "v1/variants/search",
"path": "v1/variants/search",
"id": "genomics.variants.search",
"request": {
"$ref": "SearchVariantsRequest"
},
"description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126)."
},
"get": {
"response": {
"$ref": "Variant"
},
"parameterOrder": [
"variantId"
],
"httpMethod": "GET",
"parameters": {
"variantId": {
"location": "path",
"description": "The ID of the variant.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/variants/{variantId}",
"id": "genomics.variants.get",
"path": "v1/variants/{variantId}",
"description": "Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
"patch": {
"httpMethod": "PATCH",
"parameterOrder": [
"variantId"
],
"response": {
"$ref": "Variant"
},
"parameters": {
"updateMask": {
"format": "google-fieldmask",
"description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.",
"type": "string",
"location": "query"
},
"variantId": {
"description": "The ID of the variant to be updated.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/variants/{variantId}",
"path": "v1/variants/{variantId}",
"id": "genomics.variants.patch",
"description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.",
"request": {
"$ref": "Variant"
}
}
}
},
"annotationsets": {
"methods": {
"delete": {
"httpMethod": "DELETE",
"parameterOrder": [
"annotationSetId"
],
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
"annotationSetId": {
"location": "path",
"description": "The ID of the annotation set to be deleted.",
"type": "string",
"required": true
}
},
"flatPath": "v1/annotationsets/{annotationSetId}",
"path": "v1/annotationsets/{annotationSetId}",
"id": "genomics.annotationsets.delete",
"description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set."
},
"search": {
"path": "v1/annotationsets/search",
"id": "genomics.annotationsets.search",
"description": "Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets.",
"request": {
"$ref": "SearchAnnotationSetsRequest"
},
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "SearchAnnotationSetsResponse"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/annotationsets/search"
},
"get": {
"response": {
"$ref": "AnnotationSet"
},
"parameterOrder": [
"annotationSetId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {
"annotationSetId": {
"description": "The ID of the annotation set to be retrieved.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1/annotationsets/{annotationSetId}",
"id": "genomics.annotationsets.get",
"path": "v1/annotationsets/{annotationSetId}",
"description": "Gets an annotation set. Caller must have READ permission for\nthe associated dataset."
},
"update": {
"httpMethod": "PUT",
"parameterOrder": [
"annotationSetId"
],
"response": {
"$ref": "AnnotationSet"
},
"parameters": {
"annotationSetId": {
"location": "path",
"description": "The ID of the annotation set to be updated.",
"type": "string",
"required": true
},
"updateMask": {
"format": "google-fieldmask",
"description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nsource_uri, and\ninfo. If unspecified, all\nmutable fields will be updated.",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/annotationsets/{annotationSetId}",
"path": "v1/annotationsets/{annotationSetId}",
"id": "genomics.annotationsets.update",
"description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset.",
"request": {
"$ref": "AnnotationSet"
}
},
"create": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "AnnotationSet"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/annotationsets",
"path": "v1/annotationsets",
"id": "genomics.annotationsets.create",
"description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field).",
"request": {
"$ref": "AnnotationSet"
}
}
}
},
"references": {
"methods": {
"search": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "SearchReferencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {},
"flatPath": "v1/references/search",
"path": "v1/references/search",
"id": "genomics.references.search",
"request": {
"$ref": "SearchReferencesRequest"
},
"description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146)."
},
"get": {
"path": "v1/references/{referenceId}",
"id": "genomics.references.get",
"description": "Gets a reference.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).",
"httpMethod": "GET",
"response": {
"$ref": "Reference"
},
"parameterOrder": [
"referenceId"
],
"parameters": {
"referenceId": {
"description": "The ID of the reference.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/references/{referenceId}"
}
},
"resources": {
"bases": {
"methods": {
"list": {
"id": "genomics.references.bases.list",
"path": "v1/references/{referenceId}/bases",
"description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).",
"response": {
"$ref": "ListBasesResponse"
},
"parameterOrder": [
"referenceId"
],
"httpMethod": "GET",
"parameters": {
"start": {
"format": "int64",
"description": "The start position (0-based) of this query. Defaults to 0.",
"type": "string",
"location": "query"
},
"referenceId": {
"description": "The ID of the reference.",
"type": "string",
"required": true,
"location": "path"
},
"end": {
"location": "query",
"format": "int64",
"description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
"type": "string"
},
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of bases to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base\npairs).",
"type": "integer",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/references/{referenceId}/bases"
}
}
}
}
},
"datasets": {
"methods": {
"delete": {
"description": "Deletes a dataset and all of its contents (all read group sets,\nreference sets, variant sets, call sets, annotation sets, etc.)\nThis is reversible (up to one week after the deletion) via\nthe\ndatasets.undelete\noperation.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"datasetId"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
"datasetId": {
"location": "path",
"description": "The ID of the dataset to be deleted.",
"type": "string",
"required": true
}
},
"flatPath": "v1/datasets/{datasetId}",
"path": "v1/datasets/{datasetId}",
"id": "genomics.datasets.delete"
},
"list": {
"description": "Lists datasets within a project.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"response": {
"$ref": "ListDatasetsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.",
"type": "integer",
"location": "query"
},
"projectId": {
"location": "query",
"description": "Required. The Google Cloud project ID to list datasets for.",
"type": "string"
}
},
"flatPath": "v1/datasets",
"id": "genomics.datasets.list",
"path": "v1/datasets"
},
"setIamPolicy": {
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
"resource": {
"pattern": "^datasets/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
"type": "string",
"required": true
}
},
"flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
"id": "genomics.datasets.setIamPolicy",
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information."
},
"create": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "Dataset"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {},
"flatPath": "v1/datasets",
"path": "v1/datasets",
"id": "genomics.datasets.create",
"request": {
"$ref": "Dataset"
},
"description": "Creates a new dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
"getIamPolicy": {
"httpMethod": "POST",
"parameterOrder": [
"resource"
],
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
"resource": {
"pattern": "^datasets/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
"type": "string",
"required": true
}
},
"flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
"id": "genomics.datasets.getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
"get": {
"response": {
"$ref": "Dataset"
},
"parameterOrder": [
"datasetId"
],
"httpMethod": "GET",
"parameters": {
"datasetId": {
"description": "The ID of the dataset.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/datasets/{datasetId}",
"id": "genomics.datasets.get",
"path": "v1/datasets/{datasetId}",
"description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
"undelete": {
"response": {
"$ref": "Dataset"
},
"parameterOrder": [
"datasetId"
],
"httpMethod": "POST",
"parameters": {
"datasetId": {
"location": "path",
"description": "The ID of the dataset to be undeleted.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/datasets/{datasetId}:undelete",
"id": "genomics.datasets.undelete",
"path": "v1/datasets/{datasetId}:undelete",
"description": "Undeletes a dataset by restoring a dataset which was deleted via this API.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible for a week after the deletion occurred.",
"request": {
"$ref": "UndeleteDatasetRequest"
}
},
"patch": {
"id": "genomics.datasets.patch",
"path": "v1/datasets/{datasetId}",
"request": {
"$ref": "Dataset"
},
"description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
"response": {
"$ref": "Dataset"
},
"parameterOrder": [
"datasetId"
],
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
"datasetId": {
"description": "The ID of the dataset to be updated.",
"type": "string",
"required": true,
"location": "path"
},
"updateMask": {
"format": "google-fieldmask",
"description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
"type": "string",
"location": "query"
}
},
"flatPath": "v1/datasets/{datasetId}"
},
"testIamPermissions": {
"httpMethod": "POST",
"parameterOrder": [
"resource"
],
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
"resource": {
"pattern": "^datasets/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
"type": "string",
"required": true
}
},
"flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
"id": "genomics.datasets.testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"description": "Returns permissions that a caller has on the specified resource.\nSee \u003ca href=\"/iam/docs/managing-policies#testing_permissions\"\u003eTesting\nPermissions\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
}
}
},
"variantsets": {
"methods": {
"create": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "VariantSet"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/variantsets",
"path": "v1/variantsets",
"id": "genomics.variantsets.create",
"description": "Creates a new variant set.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe provided variant set must have a valid `datasetId` set - all other\nfields are optional. Note that the `id` field will be ignored, as this is\nassigned by the server.",
"request": {
"$ref": "VariantSet"
}
},
"export": {
"httpMethod": "POST",
"parameterOrder": [
"variantSetId"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"variantSetId": {
"description": "Required. The ID of the variant set that contains variant data which\nshould be exported. The caller must have READ access to this variant set.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/variantsets/{variantSetId}:export",
"path": "v1/variantsets/{variantSetId}:export",
"id": "genomics.variantsets.export",
"description": "Exports variant set data to an external destination.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"request": {
"$ref": "ExportVariantSetRequest"
}
},
"search": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "SearchVariantSetsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {},
"flatPath": "v1/variantsets/search",
"path": "v1/variantsets/search",
"id": "genomics.variantsets.search",
"request": {
"$ref": "SearchVariantSetsRequest"
},
"description": "Returns a list of all variant sets matching search criteria.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49)."
},
"get": {
"httpMethod": "GET",
"parameterOrder": [
"variantSetId"
],
"response": {
"$ref": "VariantSet"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {
"variantSetId": {
"description": "Required. The ID of the variant set.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1/variantsets/{variantSetId}",
"path": "v1/variantsets/{variantSetId}",
"id": "genomics.variantsets.get",
"description": "Gets a variant set by ID.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
"patch": {
"description": "Updates a variant set using patch semantics.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"request": {
"$ref": "VariantSet"
},
"response": {
"$ref": "VariantSet"
},
"parameterOrder": [
"variantSetId"
],
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "An optional mask specifying which fields to update. Supported fields:\n\n* metadata.\n* name.\n* description.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
"type": "string"
},
"variantSetId": {
"location": "path",
"description": "The ID of the variant to be updated (must already exist).",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/variantsets/{variantSetId}",
"id": "genomics.variantsets.patch",
"path": "v1/variantsets/{variantSetId}"
},
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"variantSetId"
],
"httpMethod": "DELETE",
"parameters": {
"variantSetId": {
"location": "path",
"description": "The ID of the variant set to be deleted.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/variantsets/{variantSetId}",
"id": "genomics.variantsets.delete",
"path": "v1/variantsets/{variantSetId}",
"description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
}
}
},
"annotations": {
"methods": {
"create": {
"path": "v1/annotations",
"id": "genomics.annotations.create",
"description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.",
"request": {
"$ref": "Annotation"
},
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "Annotation"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/annotations"
},
"batchCreate": {
"path": "v1/annotations:batchCreate",
"id": "genomics.annotations.batchCreate",
"description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.",
"request": {
"$ref": "BatchCreateAnnotationsRequest"
},
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "BatchCreateAnnotationsResponse"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/annotations:batchCreate"
},
"search": {
"description": "Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets.",
"request": {
"$ref": "SearchAnnotationsRequest"
},
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "SearchAnnotationsResponse"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/annotations/search",
"path": "v1/annotations/search",
"id": "genomics.annotations.search"
},
"get": {
"path": "v1/annotations/{annotationId}",
"id": "genomics.annotations.get",
"description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set.",
"httpMethod": "GET",
"parameterOrder": [
"annotationId"
],
"response": {
"$ref": "Annotation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {
"annotationId": {
"location": "path",
"description": "The ID of the annotation to be retrieved.",
"type": "string",
"required": true
}
},
"flatPath": "v1/annotations/{annotationId}"
},
"update": {
"request": {
"$ref": "Annotation"
},
"description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset.",
"response": {
"$ref": "Annotation"
},
"parameterOrder": [
"annotationId"
],
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
"type": "string"
},
"annotationId": {
"description": "The ID of the annotation to be updated.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1/annotations/{annotationId}",
"id": "genomics.annotations.update",
"path": "v1/annotations/{annotationId}"
},
"delete": {
"httpMethod": "DELETE",
"parameterOrder": [
"annotationId"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"annotationId": {
"location": "path",
"description": "The ID of the annotation to be deleted.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/annotations/{annotationId}",
"path": "v1/annotations/{annotationId}",
"id": "genomics.annotations.delete",
"description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set."
}
}
},
"operations": {
"methods": {
"cancel": {
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"pattern": "^operations/.+$",
"location": "path",
"description": "The name of the operation resource to be cancelled.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/operations/{operationsId}:cancel",
"path": "v1/{+name}:cancel",
"id": "genomics.operations.cancel",
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
"request": {
"$ref": "CancelOperationRequest"
}
},
"get": {
"httpMethod": "GET",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"type": "string",
"required": true,
"pattern": "^operations/.+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/operations/{operationsId}",
"path": "v1/{+name}",
"id": "genomics.operations.get",
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
},
"list": {
"description": "Lists operations that match the specified filter in the request.",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"description": "The standard list page token.",
"type": "string",
"location": "query"
},
"name": {
"pattern": "^operations$",
"location": "path",
"description": "The name of the operation's parent resource.",
"type": "string",
"required": true
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
"type": "integer"
},
"filter": {
"location": "query",
"description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1/operations",
"id": "genomics.operations.list",
"path": "v1/{+name}"
}
}
},
"referencesets": {
"methods": {
"search": {
"description": "Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)",
"request": {
"$ref": "SearchReferenceSetsRequest"
},
"response": {
"$ref": "SearchReferenceSetsResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/referencesets/search",
"id": "genomics.referencesets.search",
"path": "v1/referencesets/search"
},
"get": {
"parameterOrder": [
"referenceSetId"
],
"httpMethod": "GET",
"response": {
"$ref": "ReferenceSet"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {
"referenceSetId": {
"description": "The ID of the reference set.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1/referencesets/{referenceSetId}",
"id": "genomics.referencesets.get",
"path": "v1/referencesets/{referenceSetId}",
"description": "Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83)."
}
}
}
},
"parameters": {
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
"pp": {
"description": "Pretty-print response.",
"default": "true",
"type": "boolean",
"location": "query"
},
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
"location": "query"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string"
},
"alt": {
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json"
}
},
"schemas": {
"TestIamPermissionsRequest": {
"properties": {
"permissions": {
"description": "REQUIRED: The set of permissions to check for the 'resource'.\nPermissions with wildcards (such as '*' or 'storage.*') are not allowed.\nAllowed permissions are:\n\n* `genomics.datasets.create`\n* `genomics.datasets.delete`\n* `genomics.datasets.get`\n* `genomics.datasets.list`\n* `genomics.datasets.update`\n* `genomics.datasets.getIamPolicy`\n* `genomics.datasets.setIamPolicy`",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method.",
"type": "object"
},
"Exon": {
"type": "object",
"properties": {
"start": {
"format": "int64",
"description": "The start position of the exon on this annotation's reference sequence,\n0-based inclusive. Note that this is relative to the reference start, and\n**not** the containing annotation start.",
"type": "string"
},
"frame": {
"format": "int32",
"description": "The frame of this exon. Contains a value of 0, 1, or 2, which indicates\nthe offset of the first coding base of the exon within the reading frame\nof the coding DNA sequence, if any. This field is dependent on the\nstrandedness of this annotation (see\nAnnotation.reverse_strand).\nFor forward stranded annotations, this offset is relative to the\nexon.start. For reverse\nstrand annotations, this offset is relative to the\nexon.end `- 1`.\n\nUnset if this exon does not intersect the coding sequence. Upon creation\nof a transcript, the frame must be populated for all or none of the\ncoding exons.",
"type": "integer"
},
"end": {
"format": "int64",
"description": "The end position of the exon on this annotation's reference sequence,\n0-based exclusive. Note that this is relative to the reference start, and\n*not* the containing annotation start.",
"type": "string"
}
},
"id": "Exon"
},
"ExportReadGroupSetRequest": {
"properties": {
"referenceNames": {
"description": "The reference names to export. If this is not specified, all reference\nsequences, including unmapped reads, are exported.\nUse `*` to export only unmapped reads.",
"items": {
"type": "string"
},
"type": "array"
},
"exportUri": {
"description": "Required. A Google Cloud Storage URI for the exported BAM file.\nThe currently authenticated user must have write access to the new file.\nAn error will be returned if the URI already contains data.",
"type": "string"
},
"projectId": {
"description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
"type": "string"
}
},
"id": "ExportReadGroupSetRequest",
"description": "The read group set export request.",
"type": "object"
},
"CallSet": {
"properties": {
"variantSetIds": {
"description": "The IDs of the variant sets this call set belongs to. This field must\nhave exactly length one, as a call set belongs to a single variant set.\nThis field is repeated for compatibility with the\n[GA4GH 0.5.1\nAPI](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "The server-generated call set ID, unique across all call sets.",
"type": "string"
},
"created": {
"format": "int64",
"description": "The date this call set was created in milliseconds from the epoch.",
"type": "string"
},
"sampleId": {
"description": "The sample ID this call set corresponds to.",
"type": "string"
},
"name": {
"description": "The call set name.",
"type": "string"
},
"info": {
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
},
"description": "A map of additional call set information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object"
}
},
"id": "CallSet",
"description": "A call set is a collection of variant calls, typically for one sample. It\nbelongs to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object"
},
"SearchAnnotationSetsResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"annotationSets": {
"description": "The matching annotation sets.",
"items": {
"$ref": "AnnotationSet"
},
"type": "array"
}
},
"id": "SearchAnnotationSetsResponse"
},
"ImportVariantsRequest": {
"properties": {
"infoMergeConfig": {
"additionalProperties": {
"enum": [
"INFO_MERGE_OPERATION_UNSPECIFIED",
"IGNORE_NEW",
"MOVE_TO_CALLS"
],
"type": "string"
},
"description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
"type": "object"
},
"sourceUris": {
"description": "A list of URIs referencing variant files in Google Cloud Storage. URIs can\ninclude wildcards [as described\nhere](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).\nNote that recursive wildcards ('**') are not supported.",
"items": {
"type": "string"
},
"type": "array"
},
"variantSetId": {
"description": "Required. The variant set to which variant data should be imported.",
"type": "string"
},
"normalizeReferenceNames": {
"description": "Convert reference names to the canonical representation.\nhg19 haploytypes (those reference names containing \"_hap\")\nare not modified in any way.\nAll other reference names are modified according to the following rules:\nThe reference name is capitalized.\nThe \"chr\" prefix is dropped for all autosomes and sex chromsomes.\nFor example \"chr17\" becomes \"17\" and \"chrX\" becomes \"X\".\nAll mitochondrial chromosomes (\"chrM\", \"chrMT\", etc) become \"MT\".",
"type": "boolean"
},
"format": {
"enum": [
"FORMAT_UNSPECIFIED",
"FORMAT_VCF",
"FORMAT_COMPLETE_GENOMICS"
],
"description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.",
"type": "string",
"enumDescriptions": [
"",
"VCF (Variant Call Format). The VCF files may be gzip compressed. gVCF is\nalso supported. Disclaimer: gzip VCF imports are currently much slower\nthan equivalent uncompressed VCF imports. For this reason, uncompressed\nVCF is currently recommended for imports with more than 1GB combined\nuncompressed size, or for time sensitive imports.",
"Complete Genomics masterVarBeta format. The masterVarBeta files may\nbe bzip2 compressed."
]
}
},
"id": "ImportVariantsRequest",
"description": "The variant data import request.",
"type": "object"
},
"VariantAnnotation": {
"properties": {
"transcriptIds": {
"description": "Google annotation IDs of the transcripts affected by this variant. These\nshould be provided when the variant is created.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enumDescriptions": [
"",
"`TYPE_OTHER` should be used when no other Type will suffice.\nFurther explanation of the variant type may be included in the\ninfo field.",
"`INSERTION` indicates an insertion.",
"`DELETION` indicates a deletion.",
"`SUBSTITUTION` indicates a block substitution of\ntwo or more nucleotides.",
"`SNP` indicates a single nucleotide polymorphism.",
"`STRUCTURAL` indicates a large structural variant,\nincluding chromosomal fusions, inversions, etc.",
"`CNV` indicates a variation in copy number."
],
"enum": [
"TYPE_UNSPECIFIED",
"TYPE_OTHER",
"INSERTION",
"DELETION",
"SUBSTITUTION",
"SNP",
"STRUCTURAL",
"CNV"
],
"description": "Type has been adapted from ClinVar's list of variant types.",
"type": "string"
},
"alternateBases": {
"description": "The alternate allele for this variant. If multiple alternate alleles\nexist at this location, create a separate variant for each one, as they\nmay represent distinct conditions.",
"type": "string"
},
"geneId": {
"description": "Google annotation ID of the gene affected by this variant. This should\nbe provided when the variant is created.",
"type": "string"
},
"clinicalSignificance": {
"enumDescriptions": [
"",
"`OTHER` should be used when no other clinical significance\nvalue will suffice.",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"`MULTIPLE_REPORTED` should be used when multiple clinical\nsignficances are reported for a variant. The original clinical\nsignificance values may be provided in the `info` field."
],
"enum": [
"CLINICAL_SIGNIFICANCE_UNSPECIFIED",
"CLINICAL_SIGNIFICANCE_OTHER",
"UNCERTAIN",
"BENIGN",
"LIKELY_BENIGN",
"LIKELY_PATHOGENIC",
"PATHOGENIC",
"DRUG_RESPONSE",
"HISTOCOMPATIBILITY",
"CONFERS_SENSITIVITY",
"RISK_FACTOR",
"ASSOCIATION",
"PROTECTIVE",
"MULTIPLE_REPORTED"
],
"description": "Describes the clinical significance of a variant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignificance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/",
"type": "string"
},
"conditions": {
"description": "The set of conditions associated with this variant.\nA condition describes the way a variant influences human health.",
"items": {
"$ref": "ClinicalCondition"
},
"type": "array"
},
"effect": {
"enumDescriptions": [
"",
"`EFFECT_OTHER` should be used when no other Effect\nwill suffice.",
"`FRAMESHIFT` indicates a mutation in which the insertion or\ndeletion of nucleotides resulted in a frameshift change.",
"`FRAME_PRESERVING_INDEL` indicates a mutation in which a\nmultiple of three nucleotides has been inserted or deleted, resulting\nin no change to the reading frame of the coding sequence.",
"`SYNONYMOUS_SNP` indicates a single nucleotide polymorphism\nmutation that results in no amino acid change.",
"`NONSYNONYMOUS_SNP` indicates a single nucleotide\npolymorphism mutation that results in an amino acid change.",
"`STOP_GAIN` indicates a mutation that leads to the creation\nof a stop codon at the variant site. Frameshift mutations creating\ndownstream stop codons do not count as `STOP_GAIN`.",
"`STOP_LOSS` indicates a mutation that eliminates a\nstop codon at the variant site.",
"`SPLICE_SITE_DISRUPTION` indicates that this variant is\nfound in a splice site for the associated transcript, and alters the\nnormal splicing pattern."
],
"enum": [
"EFFECT_UNSPECIFIED",
"EFFECT_OTHER",
"FRAMESHIFT",
"FRAME_PRESERVING_INDEL",
"SYNONYMOUS_SNP",
"NONSYNONYMOUS_SNP",
"STOP_GAIN",
"STOP_LOSS",
"SPLICE_SITE_DISRUPTION"
],
"description": "Effect of the variant on the coding sequence.",
"type": "string"
}
},
"id": "VariantAnnotation",
"type": "object"
},
"ListCoverageBucketsResponse": {
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"bucketWidth": {
"format": "int64",
"description": "The length of each coverage bucket in base pairs. Note that buckets at the\nend of a reference sequence may be shorter. This value is omitted if the\nbucket width is infinity (the default behaviour, with no range or\n`targetBucketWidth`).",
"type": "string"
},
"coverageBuckets": {
"description": "The coverage buckets. The list of buckets is sparse; a bucket with 0\noverlapping reads is not returned. A bucket never crosses more than one\nreference sequence. Each bucket has width `bucketWidth`, unless\nits end is the end of the reference sequence.",
"items": {
"$ref": "CoverageBucket"
},
"type": "array"
}
},
"id": "ListCoverageBucketsResponse",
"type": "object"
},
"ExportVariantSetRequest": {
"description": "The variant data export request.",
"type": "object",
"properties": {
"bigqueryTable": {
"description": "Required. The BigQuery table to export data to.\nIf the table doesn't exist, it will be created. If it already exists, it\nwill be overwritten.",
"type": "string"
},
"bigqueryDataset": {
"description": "Required. The BigQuery dataset to export data to. This dataset must already\nexist. Note that this is distinct from the Genomics concept of \"dataset\".",
"type": "string"
},
"format": {
"enum": [
"FORMAT_UNSPECIFIED",
"FORMAT_BIGQUERY"
],
"description": "The format for the exported data.",
"type": "string",
"enumDescriptions": [
"",
"Export the data to Google BigQuery."
]
},
"projectId": {
"description": "Required. The Google Cloud project ID that owns the destination\nBigQuery dataset. The caller must have WRITE access to this project. This\nproject will also own the resulting export job.",
"type": "string"
},
"callSetIds": {
"description": "If provided, only variant call information from the specified call sets\nwill be exported. By default all variant calls are exported.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "ExportVariantSetRequest"
},
"SearchAnnotationsRequest": {
"properties": {
"referenceId": {
"description": "The ID of the reference to query.",
"type": "string"
},
"end": {
"format": "int64",
"description": "The end position of the range on the reference, 0-based exclusive. If\nreferenceId or\nreferenceName\nmust be specified, Defaults to the length of the reference.",
"type": "string"
},
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
"type": "integer"
},
"start": {
"format": "int64",
"description": "The start position of the range on the reference, 0-based inclusive. If\nspecified,\nreferenceId or\nreferenceName\nmust be specified. Defaults to 0.",
"type": "string"
},
"annotationSetIds": {
"description": "Required. The annotation sets to search within. The caller must have\n`READ` access to these annotation sets.\nAll queried annotation sets must have the same type.",
"items": {
"type": "string"
},
"type": "array"
},
"referenceName": {
"description": "The name of the reference to query, within the reference set associated\nwith this query.",
"type": "string"
}
},
"id": "SearchAnnotationsRequest",
"type": "object"
},
"OperationEvent": {
"description": "An event that occurred during an Operation.",
"type": "object",
"properties": {
"startTime": {
"format": "google-datetime",
"description": "Optional time of when event started.",
"type": "string"
},
"description": {
"description": "Required description of event.",
"type": "string"
},
"endTime": {
"format": "google-datetime",
"description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
"type": "string"
}
},
"id": "OperationEvent"
},
"CodingSequence": {
"properties": {
"start": {
"format": "int64",
"description": "The start of the coding sequence on this annotation's reference sequence,\n0-based inclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
"type": "string"
},
"end": {
"format": "int64",
"description": "The end of the coding sequence on this annotation's reference sequence,\n0-based exclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
"type": "string"
}
},
"id": "CodingSequence",
"type": "object"
},
"SearchReferencesResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"references": {
"description": "The matching references.",
"items": {
"$ref": "Reference"
},
"type": "array"
}
},
"id": "SearchReferencesResponse"
},
"GetIamPolicyRequest": {
"properties": {},
"id": "GetIamPolicyRequest",
"description": "Request message for `GetIamPolicy` method.",
"type": "object"
},
"TestIamPermissionsResponse": {
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object"
},
"SearchAnnotationSetsRequest": {
"properties": {
"datasetIds": {
"description": "Required. The dataset IDs to search within. Caller must have `READ` access\nto these datasets.",
"items": {
"type": "string"
},
"type": "array"
},
"types": {
"enumDescriptions": [
"",
"A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
"A `VARIANT` annotation type.",
"A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
"A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
],
"description": "If specified, only annotation sets that have any of these types are\nreturned.",
"items": {
"enum": [
"ANNOTATION_TYPE_UNSPECIFIED",
"GENERIC",
"VARIANT",
"GENE",
"TRANSCRIPT"
],
"type": "string"
},
"type": "array"
},
"name": {
"description": "Only return annotations sets for which a substring of the name matches this\nstring (case insensitive).",
"type": "string"
},
"referenceSetId": {
"description": "If specified, only annotation sets associated with the given reference set\nare returned.",
"type": "string"
},
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 128. The maximum value is 1024.",
"type": "integer"
}
},
"id": "SearchAnnotationSetsRequest",
"type": "object"
},
"SearchReadGroupSetsResponse": {
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"readGroupSets": {
"description": "The list of matching read group sets.",
"items": {
"$ref": "ReadGroupSet"
},
"type": "array"
}
},
"id": "SearchReadGroupSetsResponse",
"description": "The read group set search response.",
"type": "object"
},
"SearchReferencesRequest": {
"properties": {
"md5checksums": {
"description": "If present, return references for which the\nmd5checksum matches exactly.",
"items": {
"type": "string"
},
"type": "array"
},
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"accessions": {
"description": "If present, return references for which a prefix of any of\nsourceAccessions match\nany of these strings. Accession numbers typically have a main number and a\nversion, for example `GCF_000001405.26`.",
"items": {
"type": "string"
},
"type": "array"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
"type": "integer"
},
"referenceSetId": {
"description": "If present, return only references which belong to this reference set.",
"type": "string"
}
},
"id": "SearchReferencesRequest",
"type": "object"
},
"LinearAlignment": {
"properties": {
"cigar": {
"description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.",
"items": {
"$ref": "CigarUnit"
},
"type": "array"
},
"position": {
"description": "The position of this alignment.",
"$ref": "Position"
},
"mappingQuality": {
"format": "int32",
"description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
"type": "integer"
}
},
"id": "LinearAlignment",
"description": "A linear alignment can be represented by one CIGAR string. Describes the\nmapped position and local alignment of the read to the reference.",
"type": "object"
},
"Dataset": {
"description": "A Dataset is a collection of genomic data.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
"id": {
"description": "The server-generated dataset ID, unique across all datasets.",
"type": "string"
},
"createTime": {
"format": "google-datetime",
"description": "The time this dataset was created, in seconds from the epoch.",
"type": "string"
},
"name": {
"description": "The dataset name.",
"type": "string"
},
"projectId": {
"description": "The Google Cloud project ID that this dataset belongs to.",
"type": "string"
}
},
"id": "Dataset"
},
"ImportVariantsResponse": {
"description": "The variant data import response.",
"type": "object",
"properties": {
"callSetIds": {
"description": "IDs of the call sets created during the import.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "ImportVariantsResponse"
},
"ReadGroup": {
"properties": {
"datasetId": {
"description": "The dataset to which this read group belongs.",
"type": "string"
},
"experiment": {
"description": "The experiment used to generate this read group.",
"$ref": "Experiment"
},
"name": {
"description": "The read group name. This corresponds to the @RG ID field in the SAM spec.",
"type": "string"
},
"referenceSetId": {
"description": "The reference set the reads in this read group are aligned to.",
"type": "string"
},
"info": {
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
},
"description": "A map of additional read group information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object"
},
"id": {
"description": "The server-generated read group ID, unique for all read groups.\nNote: This is different than the @RG ID field in the SAM spec. For that\nvalue, see name.",
"type": "string"
},
"predictedInsertSize": {
"format": "int32",
"description": "The predicted insert size of this read group. The insert size is the length\nthe sequenced DNA fragment from end-to-end, not including the adapters.",
"type": "integer"
},
"programs": {
"description": "The programs used to generate this read group. Programs are always\nidentical for all read groups within a read group set. For this reason,\nonly the first read group in a returned set will have this field\npopulated.",
"items": {
"$ref": "Program"
},
"type": "array"
},
"description": {
"description": "A free-form text description of this read group.",
"type": "string"
},
"sampleId": {
"description": "A client-supplied sample identifier for the reads in this read group.",
"type": "string"
}
},
"id": "ReadGroup",
"description": "A read group is all the data that's processed the same way by the sequencer.",
"type": "object"
},
"ReadGroupSet": {
"description": "A read group set is a logical collection of read groups, which are\ncollections of reads produced by a sequencer. A read group set typically\nmodels reads corresponding to one sample, sequenced one way, and aligned one\nway.\n\n* A read group set belongs to one dataset.\n* A read group belongs to one read group set.\n* A read belongs to one read group.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
"datasetId": {
"description": "The dataset to which this read group set belongs.",
"type": "string"
},
"readGroups": {
"description": "The read groups in this set. There are typically 1-10 read groups in a read\ngroup set.",
"items": {
"$ref": "ReadGroup"
},
"type": "array"
},
"filename": {
"description": "The filename of the original source file for this read group set, if any.",
"type": "string"
},
"name": {
"description": "The read group set name. By default this will be initialized to the sample\nname of the sequenced data contained in this set.",
"type": "string"
},
"referenceSetId": {
"description": "The reference set to which the reads in this read group set are aligned.",
"type": "string"
},
"info": {
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
},
"description": "A map of additional read group set information.",
"type": "object"
},
"id": {
"description": "The server-generated read group set ID, unique for all read group sets.",
"type": "string"
}
},
"id": "ReadGroupSet"
},
"SearchVariantSetsResponse": {
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"variantSets": {
"description": "The variant sets belonging to the requested dataset.",
"items": {
"$ref": "VariantSet"
},
"type": "array"
}
},
"id": "SearchVariantSetsResponse",
"description": "The search variant sets response.",
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
"id": "Empty"
},
"Entry": {
"properties": {
"annotation": {
"description": "The created annotation, if creation was successful.",
"$ref": "Annotation"
},
"status": {
"$ref": "Status",
"description": "The creation status."
}
},
"id": "Entry",
"type": "object"
},
"Position": {
"properties": {
"position": {
"format": "int64",
"description": "The 0-based offset from the start of the forward strand for that reference.",
"type": "string"
},
"referenceName": {
"description": "The name of the reference in whatever reference set is being used.",
"type": "string"
},
"reverseStrand": {
"description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand.",
"type": "boolean"
}
},
"id": "Position",
"description": "An abstraction for referring to a genomic position, in relation to some\nalready known reference. For now, represents a genomic position as a\nreference name, a base number on that reference (0-based), and a\ndetermination of forward or reverse strand.",
"type": "object"
},
"SearchReferenceSetsResponse": {
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"referenceSets": {
"description": "The matching references sets.",
"items": {
"$ref": "ReferenceSet"
},
"type": "array"
}
},
"id": "SearchReferenceSetsResponse",
"type": "object"
},
"SearchCallSetsRequest": {
"description": "The call set search request.",
"type": "object",
"properties": {
"variantSetIds": {
"description": "Restrict the query to call sets within the given variant sets. At least one\nID must be provided.",
"items": {
"type": "string"
},
"type": "array"
},
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"name": {
"description": "Only return call sets for which a substring of the name matches this\nstring.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
"type": "integer"
}
},
"id": "SearchCallSetsRequest"
},
"ImportReadGroupSetsRequest": {
"properties": {
"referenceSetId": {
"description": "The reference set to which the imported read group sets are aligned to, if\nany. The reference names of this reference set must be a superset of those\nfound in the imported file headers. If no reference set id is provided, a\nbest effort is made to associate with a matching reference set.",
"type": "string"
},
"partitionStrategy": {
"enumDescriptions": [
"",
"In most cases, this strategy yields one read group set per file. This is\nthe default behavior.\n\nAllocate one read group set per file per sample. For BAM files, read\ngroups are considered to share a sample if they have identical sample\nnames. Furthermore, all reads for each file which do not belong to a read\ngroup, if any, will be grouped into a single read group set per-file.",
"Includes all read groups in all imported files into a single read group\nset. Requires that the headers for all imported files are equivalent. All\nreads which do not belong to a read group, if any, will be grouped into a\nseparate read group set."
],
"enum": [
"PARTITION_STRATEGY_UNSPECIFIED",
"PER_FILE_PER_SAMPLE",
"MERGE_ALL"
],
"description": "The partition strategy describes how read groups are partitioned into read\ngroup sets.",
"type": "string"
},
"datasetId": {
"description": "Required. The ID of the dataset these read group sets will belong to. The\ncaller must have WRITE permissions to this dataset.",
"type": "string"
},
"sourceUris": {
"description": "A list of URIs pointing at [BAM\nfiles](https://samtools.github.io/hts-specs/SAMv1.pdf)\nin Google Cloud Storage.\nThose URIs can include wildcards (*), but do not add or remove\nmatching files before import has completed.\n\nNote that Google Cloud Storage object listing is only eventually\nconsistent: files added may be not be immediately visible to\neveryone. Thus, if using a wildcard it is preferable not to start\nthe import immediately after the files are created.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "ImportReadGroupSetsRequest",
"description": "The read group set import request.",
"type": "object"
},
"Policy": {
"properties": {
"etag": {
"format": "byte",
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"type": "string"
},
"version": {
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
"type": "integer"
},
"bindings": {
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"items": {
"$ref": "Binding"
},
"type": "array"
}
},
"id": "Policy",
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object"
},
"Annotation": {
"properties": {
"start": {
"format": "int64",
"description": "The start position of the range on the reference, 0-based inclusive.",
"type": "string"
},
"annotationSetId": {
"description": "The annotation set to which this annotation belongs.",
"type": "string"
},
"name": {
"description": "The display name of this annotation.",
"type": "string"
},
"variant": {
"description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`.",
"$ref": "VariantAnnotation"
},
"referenceId": {
"description": "The ID of the Google Genomics reference associated with this range.",
"type": "string"
},
"id": {
"description": "The server-generated annotation ID, unique across all annotations.",
"type": "string"
},
"reverseStrand": {
"description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.",
"type": "boolean"
},
"referenceName": {
"description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
"type": "string"
},
"info": {
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
},
"description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object"
},
"type": {
"enumDescriptions": [
"",
"A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
"A `VARIANT` annotation type.",
"A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
"A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
],
"enum": [
"ANNOTATION_TYPE_UNSPECIFIED",
"GENERIC",
"VARIANT",
"GENE",
"TRANSCRIPT"
],
"description": "The data type for this annotation. Must match the containing annotation\nset's type.",
"type": "string"
},
"end": {
"format": "int64",
"description": "The end position of the range on the reference, 0-based exclusive.",
"type": "string"
},
"transcript": {
"description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`.",
"$ref": "Transcript"
}
},
"id": "Annotation",
"description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.",
"type": "object"
},
"CancelOperationRequest": {
"properties": {},
"id": "CancelOperationRequest",
"description": "The request message for Operations.CancelOperation.",
"type": "object"
},
"SearchReadsRequest": {
"description": "The read search request.",
"type": "object",
"properties": {
"start": {
"format": "int64",
"description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified.",
"type": "string"
},
"referenceName": {
"description": "The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to\n`*`, only unmapped reads are returned. If unspecified, all reads (mapped\nand unmapped) are returned.",
"type": "string"
},
"readGroupSetIds": {
"description": "The IDs of the read groups sets within which to search for reads. All\nspecified read group sets must be aligned against a common set of reference\nsequences; this defines the genomic coordinates for the query. Must specify\none of `readGroupSetIds` or `readGroupIds`.",
"items": {
"type": "string"
},
"type": "array"
},
"readGroupIds": {
"description": "The IDs of the read groups within which to search for reads. All specified\nread groups must belong to the same read group sets. Must specify one of\n`readGroupSetIds` or `readGroupIds`.",
"items": {
"type": "string"
},
"type": "array"
},
"end": {
"format": "int64",
"description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified.",
"type": "string"
},
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
"type": "integer"
}
},
"id": "SearchReadsRequest"
},
"RuntimeMetadata": {
"properties": {
"computeEngine": {
"$ref": "ComputeEngine",
"description": "Execution information specific to Google Compute Engine."
}
},
"id": "RuntimeMetadata",
"description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
"type": "object"
},
"Operation": {
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`",
"type": "string"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "An OperationMetadata object. This will always be returned with the Operation.",
"type": "object"
}
},
"id": "Operation",
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object"
},
"ImportReadGroupSetsResponse": {
"properties": {
"readGroupSetIds": {
"description": "IDs of the read group sets that were created.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "ImportReadGroupSetsResponse",
"description": "The read group set import response.",
"type": "object"
},
"VariantCall": {
"description": "A call represents the determination of genotype with respect to a particular\nvariant. It may include associated information such as quality and phasing.\nFor example, a call might assign a probability of 0.32 to the occurrence of\na SNP named rs1234 in a call set with the name NA12345.",
"type": "object",
"properties": {
"phaseset": {
"description": "If this field is present, this variant call's genotype ordering implies\nthe phase of the bases and is consistent with any other variant calls in\nthe same reference sequence which have the same phaseset value.\nWhen importing data from VCF, if the genotype data was phased but no\nphase set was specified this field will be set to `*`.",
"type": "string"
},
"info": {
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
},
"description": "A map of additional variant call information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object"
},
"callSetName": {
"description": "The name of the call set this variant call belongs to.",
"type": "string"
},
"genotypeLikelihood": {
"description": "The genotype likelihoods for this variant call. Each array entry\nrepresents how likely a specific genotype is for this call. The value\nordering is defined by the GL tag in the VCF spec.\nIf Phred-scaled genotype likelihood scores (PL) are available and\nlog10(P) genotype likelihood scores (GL) are not, PL scores are converted\nto GL scores. If both are available, PL scores are stored in `info`.",
"items": {
"format": "double",
"type": "number"
},
"type": "array"
},
"callSetId": {
"description": "The ID of the call set this variant call belongs to.",
"type": "string"
},
"genotype": {
"description": "The genotype of this variant call. Each value represents either the value\nof the `referenceBases` field or a 1-based index into\n`alternateBases`. If a variant had a `referenceBases`\nvalue of `T` and an `alternateBases`\nvalue of `[\"A\", \"C\"]`, and the `genotype` was\n`[2, 1]`, that would mean the call\nrepresented the heterozygous value `CA` for this variant.\nIf the `genotype` was instead `[0, 1]`, the\nrepresented value would be `TA`. Ordering of the\ngenotype values is important if the `phaseset` is present.\nIf a genotype is not called (that is, a `.` is present in the\nGT string) -1 is returned.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
}
},
"id": "VariantCall"
},
"SearchVariantsResponse": {
"description": "The variant search response.",
"type": "object",
"properties": {
"variants": {
"description": "The list of matching Variants.",
"items": {
"$ref": "Variant"
},
"type": "array"
},
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
}
},
"id": "SearchVariantsResponse"
},
"ListBasesResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"sequence": {
"description": "A substring of the bases that make up this reference.",
"type": "string"
},
"offset": {
"format": "int64",
"description": "The offset position (0-based) of the given `sequence` from the\nstart of this `Reference`. This value will differ for each page\nin a paginated request.",
"type": "string"
}
},
"id": "ListBasesResponse"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"code": {
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"id": "Status"
},
"Binding": {
"properties": {
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
},
"id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object"
},
"UndeleteDatasetRequest": {
"type": "object",
"properties": {},
"id": "UndeleteDatasetRequest"
},
"Range": {
"description": "A 0-based half-open genomic coordinate range for search requests.",
"type": "object",
"properties": {
"referenceName": {
"description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`.",
"type": "string"
},
"start": {
"format": "int64",
"description": "The start position of the range on the reference, 0-based inclusive.",
"type": "string"
},
"end": {
"format": "int64",
"description": "The end position of the range on the reference, 0-based exclusive.",
"type": "string"
}
},
"id": "Range"
},
"VariantSet": {
"description": "A variant set is a collection of call sets and variants. It contains summary\nstatistics of those contents. A variant set belongs to a dataset.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
"description": {
"description": "A textual description of this variant set.",
"type": "string"
},
"datasetId": {
"description": "The dataset to which this variant set belongs.",
"type": "string"
},
"name": {
"description": "User-specified, mutable name.",
"type": "string"
},
"referenceSetId": {
"description": "The reference set to which the variant set is mapped. The reference set\ndescribes the alignment provenance of the variant set, while the\n`referenceBounds` describe the shape of the actual variant data. The\nreference set's reference names are a superset of those found in the\n`referenceBounds`.\n\nFor example, given a variant set that is mapped to the GRCh38 reference set\nand contains a single variant on reference 'X', `referenceBounds` would\ncontain only an entry for 'X', while the associated reference set\nenumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.",
"type": "string"
},
"metadata": {
"description": "The metadata associated with this variant set.",
"items": {
"$ref": "VariantSetMetadata"
},
"type": "array"
},
"referenceBounds": {
"description": "A list of all references used by the variants in a variant set\nwith associated coordinate upper bounds for each one.",
"items": {
"$ref": "ReferenceBound"
},
"type": "array"
},
"id": {
"description": "The server-generated variant set ID, unique across all variant sets.",
"type": "string"
}
},
"id": "VariantSet"
},
"ReferenceBound": {
"description": "ReferenceBound records an upper bound for the starting coordinate of\nvariants in a particular reference.",
"type": "object",
"properties": {
"referenceName": {
"description": "The name of the reference associated with this reference bound.",
"type": "string"
},
"upperBound": {
"format": "int64",
"description": "An upper bound (inclusive) on the starting coordinate of any\nvariant in the reference sequence.",
"type": "string"
}
},
"id": "ReferenceBound"
},
"BatchCreateAnnotationsResponse": {
"type": "object",
"properties": {
"entries": {
"description": "The resulting per-annotation entries, ordered consistently with the\noriginal request.",
"items": {
"$ref": "Entry"
},
"type": "array"
}
},
"id": "BatchCreateAnnotationsResponse"
},
"SearchCallSetsResponse": {
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"callSets": {
"description": "The list of matching call sets.",
"items": {
"$ref": "CallSet"
},
"type": "array"
}
},
"id": "SearchCallSetsResponse",
"description": "The call set search response.",
"type": "object"
},
"Variant": {
"properties": {
"referenceName": {
"description": "The reference on which this variant occurs.\n(such as `chr20` or `X`)",
"type": "string"
},
"info": {
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
},
"description": "A map of additional variant information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object"
},
"referenceBases": {
"description": "The reference bases for this variant. They start at the given\nposition.",
"type": "string"
},
"names": {
"description": "Names for the variant, for example a RefSNP ID.",
"items": {
"type": "string"
},
"type": "array"
},
"alternateBases": {
"description": "The bases that appear instead of the reference bases.",
"items": {
"type": "string"
},
"type": "array"
},
"end": {
"format": "int64",
"description": "The end position (0-based) of this variant. This corresponds to the first\nbase after the last base in the reference allele. So, the length of\nthe reference allele is (end - start). This is useful for variants\nthat don't explicitly give alternate bases, for example large deletions.",
"type": "string"
},
"filter": {
"description": "A list of filters (normally quality filters) this variant has failed.\n`PASS` indicates this variant has passed all filters.",
"items": {
"type": "string"
},
"type": "array"
},
"calls": {
"description": "The variant calls for this particular variant. Each one represents the\ndetermination of genotype with respect to this variant.",
"items": {
"$ref": "VariantCall"
},
"type": "array"
},
"created": {
"format": "int64",
"description": "The date this variant was created, in milliseconds from the epoch.",
"type": "string"
},
"start": {
"format": "int64",
"description": "The position at which this variant occurs (0-based).\nThis corresponds to the first base of the string of reference bases.",
"type": "string"
},
"quality": {
"format": "double",
"description": "A measure of how likely this variant is to be real.\nA higher value is better.",
"type": "number"
},
"id": {
"description": "The server-generated variant ID, unique across all variants.",
"type": "string"
},
"variantSetId": {
"description": "The ID of the variant set this variant belongs to.",
"type": "string"
}
},
"id": "Variant",
"description": "A variant represents a change in DNA sequence relative to a reference\nsequence. For example, a variant could represent a SNP or an insertion.\nVariants belong to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach of the calls on a variant represent a determination of genotype with\nrespect to that variant. For example, a call might assign probability of 0.32\nto the occurrence of a SNP named rs1234 in a sample named NA12345. A call\nbelongs to a call set, which contains related calls typically from one\nsample.",
"type": "object"
},
"ListOperationsResponse": {
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"id": "ListOperationsResponse",
"description": "The response message for Operations.ListOperations.",
"type": "object"
},
"OperationMetadata": {
"properties": {
"runtimeMetadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Runtime metadata on this Operation.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
"type": "object"
},
"createTime": {
"format": "google-datetime",
"description": "The time at which the job was submitted to the Genomics service.",
"type": "string"
},
"projectId": {
"description": "The Google Cloud Project in which the job is scoped.",
"type": "string"
},
"clientId": {
"description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
"type": "string"
},
"events": {
"description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
"items": {
"$ref": "OperationEvent"
},
"type": "array"
},
"endTime": {
"format": "google-datetime",
"description": "The time at which the job stopped running.",
"type": "string"
},
"startTime": {
"format": "google-datetime",
"description": "The time at which the job began to run.",
"type": "string"
},
"request": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
"type": "object"
}
},
"id": "OperationMetadata",
"description": "Metadata describing an Operation.",
"type": "object"
},
"SearchVariantsRequest": {
"properties": {
"maxCalls": {
"format": "int32",
"description": "The maximum number of calls to return in a single page. Note that this\nlimit may be exceeded in the event that a matching variant contains more\ncalls than the requested maximum. If unspecified, defaults to 5000. The\nmaximum value is 10000.",
"type": "integer"
},
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of variants to return in a single page. If unspecified,\ndefaults to 5000. The maximum value is 10000.",
"type": "integer"
},
"callSetIds": {
"description": "Only return variant calls which belong to call sets with these ids.\nLeaving this blank returns all variant calls. If a variant has no\ncalls belonging to any of these call sets, it won't be returned at all.",
"items": {
"type": "string"
},
"type": "array"
},
"variantName": {
"description": "Only return variants which have exactly this name.",
"type": "string"
},
"start": {
"format": "int64",
"description": "The beginning of the window (0-based, inclusive) for which\noverlapping variants should be returned. If unspecified, defaults to 0.",
"type": "string"
},
"referenceName": {
"description": "Required. Only return variants in this reference sequence.",
"type": "string"
},
"variantSetIds": {
"description": "At most one variant set ID must be provided. Only variants from this\nvariant set will be returned. If omitted, a call set id must be included in\nthe request.",
"items": {
"type": "string"
},
"type": "array"
},
"end": {
"format": "int64",
"description": "The end of the window, 0-based exclusive. If unspecified or 0, defaults to\nthe length of the reference.",
"type": "string"
}
},
"id": "SearchVariantsRequest",
"description": "The variant search request.",
"type": "object"
},
"SearchReadGroupSetsRequest": {
"description": "The read group set search request.",
"type": "object",
"properties": {
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"name": {
"description": "Only return read group sets for which a substring of the name matches this\nstring.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 1024.",
"type": "integer"
},
"datasetIds": {
"description": "Restricts this query to read group sets within the given datasets. At least\none ID must be provided.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "SearchReadGroupSetsRequest"
},
"SearchAnnotationsResponse": {
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"annotations": {
"description": "The matching annotations.",
"items": {
"$ref": "Annotation"
},
"type": "array"
}
},
"id": "SearchAnnotationsResponse",
"type": "object"
},
"ClinicalCondition": {
"type": "object",
"properties": {
"omimId": {
"description": "The OMIM id for this condition.\nSearch for these IDs at http://omim.org/",
"type": "string"
},
"externalIds": {
"description": "The set of external IDs for this condition.",
"items": {
"$ref": "ExternalId"
},
"type": "array"
},
"conceptId": {
"description": "The MedGen concept id associated with this gene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/",
"type": "string"
},
"names": {
"description": "A set of names for the condition.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "ClinicalCondition"
},
"SearchReadsResponse": {
"description": "The read search response.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"alignments": {
"description": "The list of matching alignments sorted by mapped genomic coordinate,\nif any, ascending in position within the same reference. Unmapped reads,\nwhich have no position, are returned contiguously and are sorted in\nascending lexicographic order by fragment name.",
"items": {
"$ref": "Read"
},
"type": "array"
}
},
"id": "SearchReadsResponse"
},
"Program": {
"properties": {
"prevProgramId": {
"description": "The ID of the program run before this one.",
"type": "string"
},
"commandLine": {
"description": "The command line used to run this program.",
"type": "string"
},
"version": {
"description": "The version of the program run.",
"type": "string"
},
"id": {
"description": "The user specified locally unique ID of the program. Used along with\n`prevProgramId` to define an ordering between programs.",
"type": "string"
},
"name": {
"description": "The display name of the program. This is typically the colloquial name of\nthe tool used, for example 'bwa' or 'picard'.",
"type": "string"
}
},
"id": "Program",
"type": "object"
},
"ComputeEngine": {
"properties": {
"zone": {
"description": "The availability zone in which the instance resides.",
"type": "string"
},
"diskNames": {
"description": "The names of the disks that were created for this pipeline.",
"items": {
"type": "string"
},
"type": "array"
},
"machineType": {
"description": "The machine type of the instance.",
"type": "string"
},
"instanceName": {
"description": "The instance on which the operation is running.",
"type": "string"
}
},
"id": "ComputeEngine",
"description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
"type": "object"
},
"CoverageBucket": {
"properties": {
"meanCoverage": {
"format": "float",
"description": "The average number of reads which are aligned to each individual\nreference base in this bucket.",
"type": "number"
},
"range": {
"description": "The genomic coordinate range spanned by this bucket.",
"$ref": "Range"
}
},
"id": "CoverageBucket",
"description": "A bucket over which read coverage has been precomputed. A bucket corresponds\nto a specific range of the reference sequence.",
"type": "object"
},
"ExternalId": {
"properties": {
"id": {
"description": "The id used by the source of this data.",
"type": "string"
},
"sourceName": {
"description": "The name of the source of this data.",
"type": "string"
}
},
"id": "ExternalId",
"type": "object"
},
"SearchVariantSetsRequest": {
"properties": {
"datasetIds": {
"description": "Exactly one dataset ID must be provided here. Only variant sets which\nbelong to this dataset will be returned.",
"items": {
"type": "string"
},
"type": "array"
},
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
"type": "integer"
}
},
"id": "SearchVariantSetsRequest",
"description": "The search variant sets request.",
"type": "object"
},
"VariantSetMetadata": {
"description": "Metadata describes a single piece of variant call metadata.\nThese data include a top level key and either a single value string (value)\nor a list of key-value pairs (info.)\nValue and info are mutually exclusive.",
"type": "object",
"properties": {
"info": {
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
},
"description": "Remaining structured metadata key-value pairs. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object"
},
"type": {
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"enum": [
"TYPE_UNSPECIFIED",
"INTEGER",
"FLOAT",
"FLAG",
"CHARACTER",
"STRING"
],
"description": "The type of data. Possible types include: Integer, Float,\nFlag, Character, and String.",
"type": "string"
},
"value": {
"description": "The value field for simple metadata",
"type": "string"
},
"id": {
"description": "User-provided ID field, not enforced by this API.\nTwo or more pieces of structured metadata with identical\nid and key fields are considered equivalent.",
"type": "string"
},
"number": {
"description": "The number of values that can be included in a field described by this\nmetadata.",
"type": "string"
},
"key": {
"description": "The top-level key.",
"type": "string"
},
"description": {
"description": "A textual description of this metadata.",
"type": "string"
}
},
"id": "VariantSetMetadata"
},
"Reference": {
"properties": {
"name": {
"description": "The name of this reference, for example `22`.",
"type": "string"
},
"md5checksum": {
"description": "MD5 of the upper-case sequence excluding all whitespace characters (this\nis equivalent to SQ:M5 in SAM). This value is represented in lower case\nhexadecimal format.",
"type": "string"
},
"id": {
"description": "The server-generated reference ID, unique across all references.",
"type": "string"
},
"length": {
"format": "int64",
"description": "The length of this reference's sequence.",
"type": "string"
},
"sourceAccessions": {
"description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405.26`.",
"items": {
"type": "string"
},
"type": "array"
},
"ncbiTaxonId": {
"format": "int32",
"description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.",
"type": "integer"
},
"sourceUri": {
"description": "The URI from which the sequence was obtained. Typically specifies a FASTA\nformat file.",
"type": "string"
}
},
"id": "Reference",
"description": "A reference is a canonical assembled DNA sequence, intended to act as a\nreference coordinate space for other genomic annotations. A single reference\nmight represent the human chromosome 1 or mitochandrial DNA, for instance. A\nreference belongs to one or more reference sets.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object"
},
"SearchReferenceSetsRequest": {
"properties": {
"md5checksums": {
"description": "If present, return reference sets for which the\nmd5checksum matches exactly.",
"items": {
"type": "string"
},
"type": "array"
},
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"accessions": {
"description": "If present, return reference sets for which a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numbers typically have a main number\nand a version, for example `NC_000001.11`.",
"items": {
"type": "string"
},
"type": "array"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
"type": "integer"
},
"assemblyId": {
"description": "If present, return reference sets for which a substring of their\n`assemblyId` matches this string (case insensitive).",
"type": "string"
}
},
"id": "SearchReferenceSetsRequest",
"type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
"id": "SetIamPolicyRequest"
},
"MergeVariantsRequest": {
"type": "object",
"properties": {
"variants": {
"description": "The variants to be merged with existing variants.",
"items": {
"$ref": "Variant"
},
"type": "array"
},
"infoMergeConfig": {
"additionalProperties": {
"enum": [
"INFO_MERGE_OPERATION_UNSPECIFIED",
"IGNORE_NEW",
"MOVE_TO_CALLS"
],
"type": "string"
},
"description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them.",
"type": "object"
},
"variantSetId": {
"description": "The destination variant set.",
"type": "string"
}
},
"id": "MergeVariantsRequest"
},
"BatchCreateAnnotationsRequest": {
"type": "object",
"properties": {
"annotations": {
"description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
"items": {
"$ref": "Annotation"
},
"type": "array"
},
"requestId": {
"description": "A unique request ID which enables the server to detect duplicated requests.\nIf provided, duplicated requests will result in the same response; if not\nprovided, duplicated requests may result in duplicated data. For a given\nannotation set, callers should not reuse `request_id`s when writing\ndifferent batches of annotations - behavior in this case is undefined.\nA common approach is to use a UUID. For batch jobs where worker crashes are\na possibility, consider using some unique variant of a worker or run ID.",
"type": "string"
}
},
"id": "BatchCreateAnnotationsRequest"
},
"Read": {
"properties": {
"failedVendorQualityChecks": {
"description": "Whether this read did not pass filters, such as platform or vendor quality\ncontrols (SAM flag 0x200).",
"type": "boolean"
},
"alignedQuality": {
"description": "The quality of the read sequence contained in this alignment record\n(equivalent to QUAL in SAM).\n`alignedSequence` and `alignedQuality` may be shorter than the full read\nsequence and quality. This will occur if the alignment is part of a\nchimeric alignment, or if the read was trimmed. When this occurs, the CIGAR\nfor this read will begin/end with a hard clip operator that will indicate\nthe length of the excised sequence.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"alignment": {
"description": "The linear alignment for this alignment record. This field is null for\nunmapped reads.",
"$ref": "LinearAlignment"
},
"id": {
"description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.",
"type": "string"
},
"numberReads": {
"format": "int32",
"description": "The number of reads in the fragment (extension to SAM flag 0x1).",
"type": "integer"
},
"secondaryAlignment": {
"description": "Whether this alignment is secondary. Equivalent to SAM flag 0x100.\nA secondary alignment represents an alternative to the primary alignment\nfor this read. Aligners may return secondary alignments if a read can map\nambiguously to multiple coordinates in the genome. By convention, each read\nhas one and only one alignment where both `secondaryAlignment`\nand `supplementaryAlignment` are false.",
"type": "boolean"
},
"fragmentName": {
"description": "The fragment name. Equivalent to QNAME (query template name) in SAM.",
"type": "string"
},
"readGroupSetId": {
"description": "The ID of the read group set this read belongs to. A read belongs to\nexactly one read group set.",
"type": "string"
},
"duplicateFragment": {
"description": "The fragment is a PCR or optical duplicate (SAM flag 0x400).",
"type": "boolean"
},
"readNumber": {
"format": "int32",
"description": "The read number in sequencing. 0-based and less than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.",
"type": "integer"
},
"alignedSequence": {
"description": "The bases of the read sequence contained in this alignment record,\n**without CIGAR operations applied** (equivalent to SEQ in SAM).\n`alignedSequence` and `alignedQuality` may be\nshorter than the full read sequence and quality. This will occur if the\nalignment is part of a chimeric alignment, or if the read was trimmed. When\nthis occurs, the CIGAR for this read will begin/end with a hard clip\noperator that will indicate the length of the excised sequence.",
"type": "string"
},
"readGroupId": {
"description": "The ID of the read group this read belongs to. A read belongs to exactly\none read group. This is a server-generated ID which is distinct from SAM's\nRG tag (for that value, see\nReadGroup.name).",
"type": "string"
},
"info": {
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
},
"description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object"
},
"nextMatePosition": {
"description": "The mapping of the primary alignment of the\n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position and mate strand in SAM.",
"$ref": "Position"
},
"supplementaryAlignment": {
"description": "Whether this alignment is supplementary. Equivalent to SAM flag 0x800.\nSupplementary alignments are used in the representation of a chimeric\nalignment. In a chimeric alignment, a read is split into multiple\nlinear alignments that map to different reference contigs. The first\nlinear alignment in the read will be designated as the representative\nalignment; the remaining linear alignments will be designated as\nsupplementary alignments. These alignments may have different mapping\nquality scores. In each linear alignment in a chimeric alignment, the read\nwill be hard clipped. The `alignedSequence` and\n`alignedQuality` fields in the alignment record will only\nrepresent the bases for its respective linear alignment.",
"type": "boolean"
},
"properPlacement": {
"description": "The orientation and the distance between reads from the fragment are\nconsistent with the sequencing protocol (SAM flag 0x2).",
"type": "boolean"
},
"fragmentLength": {
"format": "int32",
"description": "The observed length of the fragment, equivalent to TLEN in SAM.",
"type": "integer"
}
},
"id": "Read",
"description": "A read alignment describes a linear alignment of a string of DNA to a\nreference sequence, in addition to metadata\nabout the fragment (the molecule of DNA sequenced) and the read (the bases\nwhich were read by the sequencer). A read is equivalent to a line in a SAM\nfile. A read belongs to exactly one read group and exactly one\nread group set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\n### Reverse-stranded reads\n\nMapped reads (reads having a non-null `alignment`) can be aligned to either\nthe forward or the reverse strand of their associated reference. Strandedness\nof a mapped read is encoded by `alignment.position.reverseStrand`.\n\nIf we consider the reference to be a forward-stranded coordinate space of\n`[0, reference.length)` with `0` as the left-most position and\n`reference.length` as the right-most position, reads are always aligned left\nto right. That is, `alignment.position.position` always refers to the\nleft-most reference coordinate and `alignment.cigar` describes the alignment\nof this read to the reference from left to right. All per-base fields such as\n`alignedSequence` and `alignedQuality` share this same left-to-right\norientation; this is true of reads which are aligned to either strand. For\nreverse-stranded reads, this means that `alignedSequence` is the reverse\ncomplement of the bases that were originally reported by the sequencing\nmachine.\n\n### Generating a reference-aligned sequence string\n\nWhen interacting with mapped reads, it's often useful to produce a string\nrepresenting the local alignment of the read to reference. The following\npseudocode demonstrates one way of doing this:\n\n out = \"\"\n offset = 0\n for c in read.alignment.cigar {\n switch c.operation {\n case \"ALIGNMENT_MATCH\", \"SEQUENCE_MATCH\", \"SEQUENCE_MISMATCH\":\n out += read.alignedSequence[offset:offset+c.operationLength]\n offset += c.operationLength\n break\n case \"CLIP_SOFT\", \"INSERT\":\n offset += c.operationLength\n break\n case \"PAD\":\n out += repeat(\"*\", c.operationLength)\n break\n case \"DELETE\":\n out += repeat(\"-\", c.operationLength)\n break\n case \"SKIP\":\n out += repeat(\" \", c.operationLength)\n break\n case \"CLIP_HARD\":\n break\n }\n }\n return out\n\n### Converting to SAM's CIGAR string\n\nThe following pseudocode generates a SAM CIGAR string from the\n`cigar` field. Note that this is a lossy conversion\n(`cigar.referenceSequence` is lost).\n\n cigarMap = {\n \"ALIGNMENT_MATCH\": \"M\",\n \"INSERT\": \"I\",\n \"DELETE\": \"D\",\n \"SKIP\": \"N\",\n \"CLIP_SOFT\": \"S\",\n \"CLIP_HARD\": \"H\",\n \"PAD\": \"P\",\n \"SEQUENCE_MATCH\": \"=\",\n \"SEQUENCE_MISMATCH\": \"X\",\n }\n cigarStr = \"\"\n for c in read.alignment.cigar {\n cigarStr += c.operationLength + cigarMap[c.operation]\n }\n return cigarStr",
"type": "object"
},
"ReferenceSet": {
"properties": {
"description": {
"description": "Free text description of this reference set.",
"type": "string"
},
"sourceAccessions": {
"description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceUri": {
"description": "The URI from which the references were obtained.",
"type": "string"
},
"ncbiTaxonId": {
"format": "int32",
"description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)\nindicating the species which this reference set is intended to model. Note\nthat contained references may specify a different `ncbiTaxonId`, as\nassemblies may contain reference sequences which do not belong to the\nmodeled species, for example EBV in a human reference genome.",
"type": "integer"
},
"referenceIds": {
"description": "The IDs of the reference objects that are part of this set.\n`Reference.md5checksum` must be unique within this set.",
"items": {
"type": "string"
},
"type": "array"
},
"md5checksum": {
"description": "Order-independent MD5 checksum which identifies this reference set. The\nchecksum is computed by sorting all lower case hexidecimal string\n`reference.md5checksum` (for all reference in this set) in\nascending lexicographic order, concatenating, and taking the MD5 of that\nvalue. The resulting value is represented in lower case hexadecimal format.",
"type": "string"
},
"assemblyId": {
"description": "Public id of this reference set, such as `GRCh37`.",
"type": "string"
},
"id": {
"description": "The server-generated reference set ID, unique across all reference sets.",
"type": "string"
}
},
"id": "ReferenceSet",
"description": "A reference set is a set of references which typically comprise a reference\nassembly for a species, such as `GRCh38` which is representative\nof the human genome. A reference set defines a common coordinate space for\ncomparing reference-aligned experimental data. A reference set contains 1 or\nmore references.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object"
},
"CigarUnit": {
"description": "A single CIGAR operation.",
"type": "object",
"properties": {
"operationLength": {
"format": "int64",
"description": "The number of genomic bases that the operation runs for. Required.",
"type": "string"
},
"operation": {
"enumDescriptions": [
"",
"An alignment match indicates that a sequence can be aligned to the\nreference without evidence of an INDEL. Unlike the\n`SEQUENCE_MATCH` and `SEQUENCE_MISMATCH` operators,\nthe `ALIGNMENT_MATCH` operator does not indicate whether the\nreference and read sequences are an exact match. This operator is\nequivalent to SAM's `M`.",
"The insert operator indicates that the read contains evidence of bases\nbeing inserted into the reference. This operator is equivalent to SAM's\n`I`.",
"The delete operator indicates that the read contains evidence of bases\nbeing deleted from the reference. This operator is equivalent to SAM's\n`D`.",
"The skip operator indicates that this read skips a long segment of the\nreference, but the bases have not been deleted. This operator is commonly\nused when working with RNA-seq data, where reads may skip long segments\nof the reference between exons. This operator is equivalent to SAM's\n`N`.",
"The soft clip operator indicates that bases at the start/end of a read\nhave not been considered during alignment. This may occur if the majority\nof a read maps, except for low quality bases at the start/end of a read.\nThis operator is equivalent to SAM's `S`. Bases that are soft\nclipped will still be stored in the read.",
"The hard clip operator indicates that bases at the start/end of a read\nhave been omitted from this alignment. This may occur if this linear\nalignment is part of a chimeric alignment, or if the read has been\ntrimmed (for example, during error correction or to trim poly-A tails for\nRNA-seq). This operator is equivalent to SAM's `H`.",
"The pad operator indicates that there is padding in an alignment. This\noperator is equivalent to SAM's `P`.",
"This operator indicates that this portion of the aligned sequence exactly\nmatches the reference. This operator is equivalent to SAM's `=`.",
"This operator indicates that this portion of the aligned sequence is an\nalignment match to the reference, but a sequence mismatch. This can\nindicate a SNP or a read error. This operator is equivalent to SAM's\n`X`."
],
"enum": [
"OPERATION_UNSPECIFIED",
"ALIGNMENT_MATCH",
"INSERT",
"DELETE",
"SKIP",
"CLIP_SOFT",
"CLIP_HARD",
"PAD",
"SEQUENCE_MATCH",
"SEQUENCE_MISMATCH"
],
"type": "string"
},
"referenceSequence": {
"description": "`referenceSequence` is only used at mismatches\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces SAM's MD tag. If the relevant information is\nnot available, this field is unset.",
"type": "string"
}
},
"id": "CigarUnit"
},
"AnnotationSet": {
"properties": {
"name": {
"description": "The display name for this annotation set.",
"type": "string"
},
"referenceSetId": {
"description": "The ID of the reference set that defines the coordinate space for this\nset's annotations.",
"type": "string"
},
"type": {
"enum": [
"ANNOTATION_TYPE_UNSPECIFIED",
"GENERIC",
"VARIANT",
"GENE",
"TRANSCRIPT"
],
"description": "The type of annotations contained within this set.",
"type": "string",
"enumDescriptions": [
"",
"A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
"A `VARIANT` annotation type.",
"A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
"A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
]
},
"info": {
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
},
"description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object"
},
"id": {
"description": "The server-generated annotation set ID, unique across all annotation sets.",
"type": "string"
},
"sourceUri": {
"description": "The source URI describing the file from which this annotation set was\ngenerated, if any.",
"type": "string"
},
"datasetId": {
"description": "The dataset to which this annotation set belongs.",
"type": "string"
}
},
"id": "AnnotationSet",
"description": "An annotation set is a logical grouping of annotations that share consistent\ntype information and provenance. Examples of annotation sets include 'all\ngenes from refseq', and 'all variant annotations from ClinVar'.",
"type": "object"
},
"Transcript": {
"properties": {
"codingSequence": {
"$ref": "CodingSequence",
"description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA."
},
"geneId": {
"description": "The annotation ID of the gene from which this transcript is transcribed.",
"type": "string"
},
"exons": {
"description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
"items": {
"$ref": "Exon"
},
"type": "array"
}
},
"id": "Transcript",
"description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
"type": "object"
},
"Experiment": {
"properties": {
"sequencingCenter": {
"description": "The sequencing center used as part of this experiment.",
"type": "string"
},
"platformUnit": {
"description": "The platform unit used as part of this experiment, for example\nflowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the\n@RG PU field in the SAM spec.",
"type": "string"
},
"instrumentModel": {
"description": "The instrument model used as part of this experiment. This maps to\nsequencing technology in the SAM spec.",
"type": "string"
},
"libraryId": {
"description": "A client-supplied library identifier; a library is a collection of DNA\nfragments which have been prepared for sequencing from a sample. This\nfield is important for quality control as error or bias can be introduced\nduring sample preparation.",
"type": "string"
}
},
"id": "Experiment",
"type": "object"
},
"ListDatasetsResponse": {
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
"datasets": {
"description": "The list of matching Datasets.",
"items": {
"$ref": "Dataset"
},
"type": "array"
}
},
"id": "ListDatasetsResponse",
"description": "The dataset list response.",
"type": "object"
}
},
"protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"version": "v1",
"baseUrl": "https://genomics.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/genomics.readonly": {
"description": "View Genomics data"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/genomics": {
"description": "View and manage Genomics data"
},
"https://www.googleapis.com/auth/devstorage.read_write": {
"description": "Manage your data in Google Cloud Storage"
},
"https://www.googleapis.com/auth/bigquery": {
"description": "View and manage your data in Google BigQuery"
}
}
}
},
"kind": "discovery#restDescription",
"description": "Upload, process, query, and search Genomics data in the cloud.",
"servicePath": ""
}
View Git Blame Copy Permalink