| { |
| "kind": "discovery#restDescription", |
| "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/6mSsI0xI9yn9ZnlRcN8kSTObcGc\"", |
| "discoveryVersion": "v1", |
| "id": "genomics:v1alpha2", |
| "name": "genomics", |
| "version": "v1alpha2", |
| "revision": "20160202", |
| "title": "Genomics API", |
| "description": "An API to store, process, explore, and share genomic data. It supports reference-based alignments, genetic variants, and reference genomes. This API provides an implementation of the Global Alliance for Genomics and Health (GA4GH) v0.5.1 API as well as several extensions.", |
| "ownerDomain": "google.com", |
| "ownerName": "Google", |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "documentationLink": "", |
| "protocol": "rest", |
| "baseUrl": "https://genomics.googleapis.com/", |
| "basePath": "", |
| "rootUrl": "https://genomics.googleapis.com/", |
| "servicePath": "", |
| "batchPath": "batch", |
| "parameters": { |
| "access_token": { |
| "type": "string", |
| "description": "OAuth access token.", |
| "location": "query" |
| }, |
| "alt": { |
| "type": "string", |
| "description": "Data format for response.", |
| "default": "json", |
| "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" |
| }, |
| "bearer_token": { |
| "type": "string", |
| "description": "OAuth bearer token.", |
| "location": "query" |
| }, |
| "callback": { |
| "type": "string", |
| "description": "JSONP", |
| "location": "query" |
| }, |
| "fields": { |
| "type": "string", |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query" |
| }, |
| "key": { |
| "type": "string", |
| "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.", |
| "location": "query" |
| }, |
| "oauth_token": { |
| "type": "string", |
| "description": "OAuth 2.0 token for the current user.", |
| "location": "query" |
| }, |
| "pp": { |
| "type": "boolean", |
| "description": "Pretty-print response.", |
| "default": "true", |
| "location": "query" |
| }, |
| "prettyPrint": { |
| "type": "boolean", |
| "description": "Returns response with indentations and line breaks.", |
| "default": "true", |
| "location": "query" |
| }, |
| "quotaUser": { |
| "type": "string", |
| "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.", |
| "location": "query" |
| }, |
| "upload_protocol": { |
| "type": "string", |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "location": "query" |
| }, |
| "uploadType": { |
| "type": "string", |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "location": "query" |
| }, |
| "$.xgafv": { |
| "type": "string", |
| "description": "V1 error format.", |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query" |
| } |
| }, |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "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" |
| } |
| } |
| } |
| }, |
| "schemas": { |
| "Operation": { |
| "id": "Operation", |
| "type": "object", |
| "description": "This resource represents a long-running operation that is the result of a network API call.", |
| "properties": { |
| "name": { |
| "type": "string", |
| "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`" |
| }, |
| "metadata": { |
| "type": "object", |
| "description": "An OperationMetadata object. This will always be returned with the Operation.", |
| "additionalProperties": { |
| "type": "any", |
| "description": "Properties of the object. Contains field @ype with type URL." |
| } |
| }, |
| "done": { |
| "type": "boolean", |
| "description": "If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available." |
| }, |
| "error": { |
| "$ref": "Status", |
| "description": "The error result of the operation in case of failure." |
| }, |
| "response": { |
| "type": "object", |
| "description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.", |
| "additionalProperties": { |
| "type": "any", |
| "description": "Properties of the object. Contains field @ype with type URL." |
| } |
| } |
| } |
| }, |
| "Status": { |
| "id": "Status", |
| "type": "object", |
| "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.", |
| "properties": { |
| "code": { |
| "type": "integer", |
| "description": "The status code, which should be an enum value of google.rpc.Code.", |
| "format": "int32" |
| }, |
| "message": { |
| "type": "string", |
| "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." |
| }, |
| "details": { |
| "type": "array", |
| "description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.", |
| "items": { |
| "type": "object", |
| "additionalProperties": { |
| "type": "any", |
| "description": "Properties of the object. Contains field @ype with type URL." |
| } |
| } |
| } |
| } |
| }, |
| "ListOperationsResponse": { |
| "id": "ListOperationsResponse", |
| "type": "object", |
| "description": "The response message for Operations.ListOperations.", |
| "properties": { |
| "operations": { |
| "type": "array", |
| "description": "A list of operations that matches the specified filter in the request.", |
| "items": { |
| "$ref": "Operation" |
| } |
| }, |
| "nextPageToken": { |
| "type": "string", |
| "description": "The standard List next-page token." |
| } |
| } |
| }, |
| "CancelOperationRequest": { |
| "id": "CancelOperationRequest", |
| "type": "object", |
| "description": "The request message for Operations.CancelOperation." |
| }, |
| "Empty": { |
| "id": "Empty", |
| "type": "object", |
| "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`." |
| }, |
| "ImportReadGroupSetsResponse": { |
| "id": "ImportReadGroupSetsResponse", |
| "type": "object", |
| "description": "The read group set import response.", |
| "properties": { |
| "readGroupSetIds": { |
| "type": "array", |
| "description": "IDs of the read group sets that were created.", |
| "items": { |
| "type": "string" |
| } |
| } |
| } |
| }, |
| "ImportVariantsResponse": { |
| "id": "ImportVariantsResponse", |
| "type": "object", |
| "description": "The variant data import response.", |
| "properties": { |
| "callSetIds": { |
| "type": "array", |
| "description": "IDs of the call sets created during the import.", |
| "items": { |
| "type": "string" |
| } |
| } |
| } |
| }, |
| "OperationMetadata": { |
| "id": "OperationMetadata", |
| "type": "object", |
| "description": "Metadata describing an Operation.", |
| "properties": { |
| "projectId": { |
| "type": "string", |
| "description": "The Google Cloud Project in which the job is scoped." |
| }, |
| "createTime": { |
| "type": "string", |
| "description": "The time at which the job was submitted to the Genomics service." |
| }, |
| "request": { |
| "type": "object", |
| "description": "The original request that started the operation. Note that this will be in current version of the API. If the operation was started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request will be returned.", |
| "additionalProperties": { |
| "type": "any", |
| "description": "Properties of the object. Contains field @ype with type URL." |
| } |
| }, |
| "events": { |
| "type": "array", |
| "description": "Optional event messages that were generated during the job's execution. This also contains any warnings that were generated during import or export.", |
| "items": { |
| "$ref": "OperationEvent" |
| } |
| } |
| } |
| }, |
| "OperationEvent": { |
| "id": "OperationEvent", |
| "type": "object", |
| "description": "An event that occurred during an Operation.", |
| "properties": { |
| "description": { |
| "type": "string", |
| "description": "Required description of event." |
| } |
| } |
| } |
| }, |
| "resources": { |
| "operations": { |
| "methods": { |
| "get": { |
| "id": "genomics.operations.get", |
| "path": "v1alpha2/{+name}", |
| "httpMethod": "GET", |
| "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", |
| "parameters": { |
| "name": { |
| "type": "string", |
| "description": "The name of the operation resource.", |
| "required": true, |
| "pattern": "^operations/.*$", |
| "location": "path" |
| } |
| }, |
| "parameterOrder": [ |
| "name" |
| ], |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform", |
| "https://www.googleapis.com/auth/genomics" |
| ] |
| }, |
| "list": { |
| "id": "genomics.operations.list", |
| "path": "v1alpha2/{+name}", |
| "httpMethod": "GET", |
| "description": "Lists operations that match the specified filter in the request.", |
| "parameters": { |
| "name": { |
| "type": "string", |
| "description": "The name of the operation collection.", |
| "required": true, |
| "pattern": "^operations$", |
| "location": "path" |
| }, |
| "filter": { |
| "type": "string", |
| "description": "A string for filtering Operations. The following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `= 1432140000` * `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`", |
| "location": "query" |
| }, |
| "pageSize": { |
| "type": "integer", |
| "description": "The maximum number of results to return. If unspecified, defaults to 256. The maximum value is 2048.", |
| "format": "int32", |
| "location": "query" |
| }, |
| "pageToken": { |
| "type": "string", |
| "description": "The standard list page token.", |
| "location": "query" |
| } |
| }, |
| "parameterOrder": [ |
| "name" |
| ], |
| "response": { |
| "$ref": "ListOperationsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform", |
| "https://www.googleapis.com/auth/genomics" |
| ] |
| }, |
| "cancel": { |
| "id": "genomics.operations.cancel", |
| "path": "v1alpha2/{+name}:cancel", |
| "httpMethod": "POST", |
| "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.", |
| "parameters": { |
| "name": { |
| "type": "string", |
| "description": "The name of the operation resource to be cancelled.", |
| "required": true, |
| "pattern": "^operations/.*$", |
| "location": "path" |
| } |
| }, |
| "parameterOrder": [ |
| "name" |
| ], |
| "request": { |
| "$ref": "CancelOperationRequest" |
| }, |
| "response": { |
| "$ref": "Empty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform", |
| "https://www.googleapis.com/auth/genomics" |
| ] |
| } |
| } |
| } |
| } |
| } |
