mirror of
https://github.com/rclone/rclone.git
synced 2024-12-04 14:26:42 +01:00
439 lines
18 KiB
JSON
439 lines
18 KiB
JSON
{
|
|
"batchPath": "batch",
|
|
"revision": "20180114",
|
|
"documentationLink": "https://cloud.google.com/genomics",
|
|
"id": "genomics:v1",
|
|
"title": "Genomics API",
|
|
"discoveryVersion": "v1",
|
|
"ownerName": "Google",
|
|
"resources": {
|
|
"operations": {
|
|
"methods": {
|
|
"cancel": {
|
|
"request": {
|
|
"$ref": "CancelOperationRequest"
|
|
},
|
|
"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.",
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The name of the operation resource to be cancelled.",
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^operations/.+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/genomics"
|
|
],
|
|
"flatPath": "v1/operations/{operationsId}:cancel",
|
|
"id": "genomics.operations.cancel",
|
|
"path": "v1/{+name}:cancel"
|
|
},
|
|
"list": {
|
|
"response": {
|
|
"$ref": "ListOperationsResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "GET",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/genomics"
|
|
],
|
|
"parameters": {
|
|
"filter": {
|
|
"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",
|
|
"location": "query"
|
|
},
|
|
"name": {
|
|
"description": "The name of the operation's parent resource.",
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^operations$",
|
|
"location": "path"
|
|
},
|
|
"pageToken": {
|
|
"description": "The standard list page token.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"pageSize": {
|
|
"description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
|
|
"format": "int32",
|
|
"type": "integer",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"flatPath": "v1/operations",
|
|
"path": "v1/{+name}",
|
|
"id": "genomics.operations.list",
|
|
"description": "Lists operations that match the specified filter in the request."
|
|
},
|
|
"get": {
|
|
"response": {
|
|
"$ref": "Operation"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "GET",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/genomics"
|
|
],
|
|
"parameters": {
|
|
"name": {
|
|
"location": "path",
|
|
"description": "The name of the operation resource.",
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^operations/.+$"
|
|
}
|
|
},
|
|
"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."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": {
|
|
"upload_protocol": {
|
|
"location": "query",
|
|
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
|
"type": "string"
|
|
},
|
|
"prettyPrint": {
|
|
"description": "Returns response with indentations and line breaks.",
|
|
"type": "boolean",
|
|
"default": "true",
|
|
"location": "query"
|
|
},
|
|
"fields": {
|
|
"description": "Selector specifying which fields to include in a partial response.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"uploadType": {
|
|
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"callback": {
|
|
"location": "query",
|
|
"description": "JSONP",
|
|
"type": "string"
|
|
},
|
|
"$.xgafv": {
|
|
"description": "V1 error format.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"v1 error format",
|
|
"v2 error format"
|
|
],
|
|
"location": "query",
|
|
"enum": [
|
|
"1",
|
|
"2"
|
|
]
|
|
},
|
|
"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"
|
|
},
|
|
"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"
|
|
},
|
|
"access_token": {
|
|
"description": "OAuth access 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.",
|
|
"type": "boolean",
|
|
"default": "true",
|
|
"location": "query"
|
|
},
|
|
"bearer_token": {
|
|
"location": "query",
|
|
"description": "OAuth bearer token.",
|
|
"type": "string"
|
|
},
|
|
"oauth_token": {
|
|
"location": "query",
|
|
"description": "OAuth 2.0 token for the current user.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"schemas": {
|
|
"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": {
|
|
"code": {
|
|
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
|
"format": "int32",
|
|
"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"
|
|
},
|
|
"details": {
|
|
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
|
|
"type": "array",
|
|
"items": {
|
|
"additionalProperties": {
|
|
"description": "Properties of the object. Contains field @type with type URL.",
|
|
"type": "any"
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"id": "Status"
|
|
},
|
|
"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"
|
|
},
|
|
"OperationEvent": {
|
|
"description": "An event that occurred during an Operation.",
|
|
"type": "object",
|
|
"properties": {
|
|
"endTime": {
|
|
"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.",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"startTime": {
|
|
"description": "Optional time of when event started.",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Required description of event.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "OperationEvent"
|
|
},
|
|
"CancelOperationRequest": {
|
|
"description": "The request message for Operations.CancelOperation.",
|
|
"type": "object",
|
|
"properties": {},
|
|
"id": "CancelOperationRequest"
|
|
},
|
|
"ComputeEngine": {
|
|
"description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
|
|
"type": "object",
|
|
"properties": {
|
|
"instanceName": {
|
|
"description": "The instance on which the operation is running.",
|
|
"type": "string"
|
|
},
|
|
"zone": {
|
|
"description": "The availability zone in which the instance resides.",
|
|
"type": "string"
|
|
},
|
|
"machineType": {
|
|
"description": "The machine type of the instance.",
|
|
"type": "string"
|
|
},
|
|
"diskNames": {
|
|
"description": "The names of the disks that were created for this pipeline.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"id": "ComputeEngine"
|
|
},
|
|
"Operation": {
|
|
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
|
|
"type": "object",
|
|
"properties": {
|
|
"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"
|
|
},
|
|
"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": {
|
|
"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",
|
|
"additionalProperties": {
|
|
"description": "Properties of the object. Contains field @type with type URL.",
|
|
"type": "any"
|
|
}
|
|
},
|
|
"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"
|
|
}
|
|
},
|
|
"id": "Operation"
|
|
},
|
|
"ListOperationsResponse": {
|
|
"description": "The response message for Operations.ListOperations.",
|
|
"type": "object",
|
|
"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.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "Operation"
|
|
}
|
|
}
|
|
},
|
|
"id": "ListOperationsResponse"
|
|
},
|
|
"RuntimeMetadata": {
|
|
"description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
|
|
"type": "object",
|
|
"properties": {
|
|
"computeEngine": {
|
|
"description": "Execution information specific to Google Compute Engine.",
|
|
"$ref": "ComputeEngine"
|
|
}
|
|
},
|
|
"id": "RuntimeMetadata"
|
|
},
|
|
"OperationMetadata": {
|
|
"description": "Metadata describing an Operation.",
|
|
"type": "object",
|
|
"properties": {
|
|
"createTime": {
|
|
"description": "The time at which the job was submitted to the Genomics service.",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"labels": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
|
|
"type": "object"
|
|
},
|
|
"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.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "OperationEvent"
|
|
}
|
|
},
|
|
"endTime": {
|
|
"description": "The time at which the job stopped running.",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"startTime": {
|
|
"description": "The time at which the job began to run.",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"request": {
|
|
"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",
|
|
"additionalProperties": {
|
|
"description": "Properties of the object. Contains field @type with type URL.",
|
|
"type": "any"
|
|
}
|
|
},
|
|
"runtimeMetadata": {
|
|
"description": "Runtime metadata on this Operation.",
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"description": "Properties of the object. Contains field @type with type URL.",
|
|
"type": "any"
|
|
}
|
|
}
|
|
},
|
|
"id": "OperationMetadata"
|
|
}
|
|
},
|
|
"protocol": "rest",
|
|
"icons": {
|
|
"x32": "http://www.google.com/images/icons/product/search-32.gif",
|
|
"x16": "http://www.google.com/images/icons/product/search-16.gif"
|
|
},
|
|
"version": "v1",
|
|
"baseUrl": "https://genomics.googleapis.com/",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"kind": "discovery#restDescription",
|
|
"description": "Upload, process, query, and search Genomics data in the cloud.",
|
|
"servicePath": "",
|
|
"rootUrl": "https://genomics.googleapis.com/",
|
|
"basePath": "",
|
|
"ownerDomain": "google.com",
|
|
"name": "genomics"
|
|
}
|