mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-04 10:32:16 +01:00
761 lines
29 KiB
JSON
761 lines
29 KiB
JSON
{
|
||
"kind": "discovery#restDescription",
|
||
"etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/ta1I7zV4LB0PTeBNdEf_KiUs1io\"",
|
||
"discoveryVersion": "v1",
|
||
"id": "genomics:v1alpha2",
|
||
"name": "genomics",
|
||
"version": "v1alpha2",
|
||
"revision": "20160124",
|
||
"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 `{}`."
|
||
},
|
||
"Pipeline": {
|
||
"id": "Pipeline",
|
||
"type": "object",
|
||
"description": "The pipeline object.",
|
||
"properties": {
|
||
"projectId": {
|
||
"type": "string",
|
||
"description": "Required. The project in which to create the pipeline. The caller must have WRITE access."
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "Required. User-specified pipeline name. Note this does not have to be unique."
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"description": "Optional user-specified description."
|
||
},
|
||
"parameters": {
|
||
"type": "array",
|
||
"description": "Parameters that pipeline uses to run.",
|
||
"items": {
|
||
"$ref": "PipelineParameter"
|
||
}
|
||
},
|
||
"docker": {
|
||
"$ref": "DockerExecutor"
|
||
},
|
||
"resources": {
|
||
"$ref": "PipelineResources",
|
||
"description": "Required. Specifies resource requirements for the pipeline run. Minimally CPU and RAM must be specified."
|
||
},
|
||
"pipelineId": {
|
||
"type": "string",
|
||
"description": "Unique pipeline id that is generated by the service when CreatePipeline is called."
|
||
}
|
||
}
|
||
},
|
||
"PipelineParameter": {
|
||
"id": "PipelineParameter",
|
||
"type": "object",
|
||
"description": "Parameters facilitate setting and delivering data into the pipeline’s execution environment. They are specified as either inputs or outputs to the pipeline when it is run. A parameter can be defined either as a literal or a reference type. A literal parameter is one whose value, either the default provided at creation time or provided by the user at runtime, is passed as-is into the pipeline. A reference parameter is one whose value is interpreted as a data source or sink. Reference parameters are almost always required to be provided by the user at runtime. The following types of reference parameters are supported: GCS objects ========== value = “gs://bucket/[path]” If the parameter is a pipeline input, the value is interpreted as a data source and the object(s) described by the GCS path will be copied into the pipeline. Likewise, if the parameter is a pipeline output, it is interpreted as a data source, and the applicable contents will be copied to the GCS path indicated. GCE disks ================= value = “disk://disk_name/[path]” Indicates that a persistent disk should be mounted into the pipeline’s execution environment. The disk_name refers to Disk entry in the PipelineResources.Disks field of the RunPipelineRequest.",
|
||
"properties": {
|
||
"name": {
|
||
"type": "string",
|
||
"description": "Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline. It is also used for passing the parameter into execution environments, e.g. the Docker executor uppercases the name and uses it as ab environment variable. Some execution environments may restrict the allowed characters."
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"description": "Optional human-readable description, for eventual use in friendly documentation and error messages."
|
||
},
|
||
"value": {
|
||
"type": "string",
|
||
"description": "Value of the parameter. If this is a LITERAL parameter, this field is treated as a default value to be passed to the pipeline in the absence of the runner providing a value for it. If this is a REFERENCE parameter, this field is required as it is considered the target of the reference provided by the pipeline runner."
|
||
},
|
||
"type": {
|
||
"type": "string",
|
||
"description": "The type of the parameter indicates how it should be interpreted.",
|
||
"enum": [
|
||
"TYPE_UNSPECIFIED",
|
||
"LITERAL",
|
||
"REFERENCE"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"DockerExecutor": {
|
||
"id": "DockerExecutor",
|
||
"type": "object",
|
||
"description": "The Docker execuctor specification.",
|
||
"properties": {
|
||
"imageName": {
|
||
"type": "string",
|
||
"description": "Image name from either Docker Hub or Google Container Repository. Users that run pipelines must have READ access to the image."
|
||
},
|
||
"cmd": {
|
||
"type": "string",
|
||
"description": "The command string to run."
|
||
}
|
||
}
|
||
},
|
||
"PipelineResources": {
|
||
"id": "PipelineResources",
|
||
"type": "object",
|
||
"description": "The system resources for the pipeline run.",
|
||
"properties": {
|
||
"minimumCpuCores": {
|
||
"type": "string",
|
||
"description": "The minimum number of cores to use.",
|
||
"format": "int64"
|
||
},
|
||
"preemptible": {
|
||
"type": "boolean",
|
||
"description": "If applicable, preemptible machines may be used for the run."
|
||
},
|
||
"minimumRamGb": {
|
||
"type": "number",
|
||
"description": "The minimum amount of RAM to use.",
|
||
"format": "double"
|
||
},
|
||
"disks": {
|
||
"type": "array",
|
||
"description": "Disks to attach.",
|
||
"items": {
|
||
"$ref": "Disk"
|
||
}
|
||
},
|
||
"zones": {
|
||
"type": "array",
|
||
"description": "List of Google Compute Engine availability zones to which resource creation will restricted.",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"Disk": {
|
||
"id": "Disk",
|
||
"type": "object",
|
||
"description": "A Google Compute Engine disk resource specification.",
|
||
"properties": {
|
||
"name": {
|
||
"type": "string",
|
||
"description": "Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?"
|
||
},
|
||
"type": {
|
||
"type": "string",
|
||
"description": "The type of the disk to create, if applicable.",
|
||
"enum": [
|
||
"TYPE_UNSPECIFIED",
|
||
"PERSISTENT_HDD",
|
||
"PERSISTENT_SSD",
|
||
"LOCAL_SSD"
|
||
]
|
||
},
|
||
"sizeGb": {
|
||
"type": "string",
|
||
"description": "The size of the disk. This field is not applicable for local SSD.",
|
||
"format": "int64"
|
||
},
|
||
"source": {
|
||
"type": "string",
|
||
"description": "The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details."
|
||
},
|
||
"autoDelete": {
|
||
"type": "boolean",
|
||
"description": "Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details."
|
||
},
|
||
"readOnly": {
|
||
"type": "boolean",
|
||
"description": "Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details."
|
||
}
|
||
}
|
||
},
|
||
"RunPipelineRequest": {
|
||
"id": "RunPipelineRequest",
|
||
"type": "object",
|
||
"description": "The request to run a pipeline. If pipeline_id is specified, it refers to a saved pipeline created with CreatePipeline and set as the pipeline_id of the returned Pipeline object. If a pipeline object is specified, that pipeline is run once with the given args and then deleted. It is an error to specify both pipeline_id and pipeline. RunPipelineArgs must be specified.",
|
||
"properties": {
|
||
"pipelineId": {
|
||
"type": "string",
|
||
"description": "The already created pipeline to run."
|
||
},
|
||
"ephemeralPipeline": {
|
||
"$ref": "Pipeline",
|
||
"description": "A new pipeline object to run once and then delete."
|
||
},
|
||
"pipelineArgs": {
|
||
"$ref": "RunPipelineArgs",
|
||
"description": "The arguments to use when running this pipeline."
|
||
}
|
||
}
|
||
},
|
||
"RunPipelineArgs": {
|
||
"id": "RunPipelineArgs",
|
||
"type": "object",
|
||
"description": "The pipeline run arguments.",
|
||
"properties": {
|
||
"projectId": {
|
||
"type": "string",
|
||
"description": "Required. The project in which to run the pipeline. The caller must have WRITER access to all Google Cloud services and resources (e.g. Google Compute Engine) will be used."
|
||
},
|
||
"inputs": {
|
||
"type": "object",
|
||
"description": "Pipeline input arguments; keys are defined in the pipeline documentation.",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"outputs": {
|
||
"type": "object",
|
||
"description": "Pipeline output arguments; keys are defined in the pipeline documentation.",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"serviceAccount": {
|
||
"$ref": "ServiceAccount",
|
||
"description": "Required. The Google Cloud Service Account that will be used to access data and services."
|
||
},
|
||
"clientId": {
|
||
"type": "string",
|
||
"description": "Optional for callers to use in filtering operations returned by this request."
|
||
},
|
||
"resources": {
|
||
"$ref": "PipelineResources",
|
||
"description": "Specifies resource requirements/overrides for the pipeline run."
|
||
},
|
||
"logging": {
|
||
"$ref": "LoggingOptions",
|
||
"description": "Required. Logging options. Used by the service to communicate results to the user."
|
||
}
|
||
}
|
||
},
|
||
"ServiceAccount": {
|
||
"id": "ServiceAccount",
|
||
"type": "object",
|
||
"description": "A Google Cloud Service Account.",
|
||
"properties": {
|
||
"email": {
|
||
"type": "string",
|
||
"description": "Required. Email address of the service account."
|
||
},
|
||
"scopes": {
|
||
"type": "array",
|
||
"description": "Required. List of scopes to be made available for this service account.",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"LoggingOptions": {
|
||
"id": "LoggingOptions",
|
||
"type": "object",
|
||
"description": "The logging options for the pipeline run.",
|
||
"properties": {
|
||
"gcsPath": {
|
||
"type": "string",
|
||
"description": "The location in Google Cloud Storage to which the pipeline logs will be copied. Can be specified as a fully qualified directory path, in which case logs will be output with a unique identifier as the filename in that directory, or as a fully specified path, which must end in \".log\", in which case that path will be used, and the user must ensure that logs are not overwritten. Stdout and stderr logs from the run are also generated and output as \"-stdout.log\" and \"-stderr.log\"."
|
||
}
|
||
}
|
||
},
|
||
"ListPipelinesRequest": {
|
||
"id": "ListPipelinesRequest",
|
||
"type": "object",
|
||
"description": "A request to list pipelines in a given project. Pipelines can be filtered by name using name_prefix: all pipelines with names that begin with name_prefix will be returned. Uses standard pagination: page_size indicates how many pipelines to return, and page_token comes from a previous ListPipelinesResponse to indicate offset.",
|
||
"properties": {
|
||
"projectId": {
|
||
"type": "string",
|
||
"description": "Required. The name of the project to search for pipelines. Caller must have READ access to this project."
|
||
},
|
||
"namePrefix": {
|
||
"type": "string",
|
||
"description": "Pipelines with names that match this prefix should be returned."
|
||
},
|
||
"pageSize": {
|
||
"type": "integer",
|
||
"description": "Number of pipelines to return at once.",
|
||
"format": "int32"
|
||
},
|
||
"pageToken": {
|
||
"type": "string",
|
||
"description": "Token to use to indicate where to start getting results."
|
||
}
|
||
}
|
||
},
|
||
"ListPipelinesResponse": {
|
||
"id": "ListPipelinesResponse",
|
||
"type": "object",
|
||
"description": "The response of ListPipelines. Contains at most page_size pipelines. If it contains page_size pipelines, and more pipelines exist, then next_page_token will be populated.",
|
||
"properties": {
|
||
"pipelines": {
|
||
"type": "array",
|
||
"description": "The matched pipelines.",
|
||
"items": {
|
||
"$ref": "Pipeline"
|
||
}
|
||
},
|
||
"nextPageToken": {
|
||
"type": "string",
|
||
"description": "The token to use to get the next page of results."
|
||
}
|
||
}
|
||
},
|
||
"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"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"pipelines": {
|
||
"methods": {
|
||
"create": {
|
||
"id": "genomics.pipelines.create",
|
||
"path": "v1alpha2/pipelines",
|
||
"httpMethod": "POST",
|
||
"description": "Creates a pipeline that can be later run. Caller must have WRITE permission to the project.",
|
||
"request": {
|
||
"$ref": "Pipeline"
|
||
},
|
||
"response": {
|
||
"$ref": "Pipeline"
|
||
},
|
||
"scopes": [
|
||
"https://www.googleapis.com/auth/cloud-platform",
|
||
"https://www.googleapis.com/auth/genomics"
|
||
]
|
||
},
|
||
"run": {
|
||
"id": "genomics.pipelines.run",
|
||
"path": "v1alpha2/pipelines:run",
|
||
"httpMethod": "POST",
|
||
"description": "Runs a pipeline. If pipeline_id is specified in the request, then run a saved pipeline. If a pipeline object is specified, then run that pipeline once and then delete it. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used.",
|
||
"request": {
|
||
"$ref": "RunPipelineRequest"
|
||
},
|
||
"response": {
|
||
"$ref": "Operation"
|
||
},
|
||
"scopes": [
|
||
"https://www.googleapis.com/auth/cloud-platform",
|
||
"https://www.googleapis.com/auth/genomics"
|
||
]
|
||
},
|
||
"get": {
|
||
"id": "genomics.pipelines.get",
|
||
"path": "v1alpha2/pipelines/{pipelineId}",
|
||
"httpMethod": "GET",
|
||
"description": "Retrieves a pipeline based on ID. Caller must have READ permission to the project.",
|
||
"parameters": {
|
||
"pipelineId": {
|
||
"type": "string",
|
||
"description": "Caller must have READ access to the project in which this pipeline is defined.",
|
||
"required": true,
|
||
"location": "path"
|
||
}
|
||
},
|
||
"parameterOrder": [
|
||
"pipelineId"
|
||
],
|
||
"response": {
|
||
"$ref": "Pipeline"
|
||
},
|
||
"scopes": [
|
||
"https://www.googleapis.com/auth/cloud-platform",
|
||
"https://www.googleapis.com/auth/genomics"
|
||
]
|
||
},
|
||
"list": {
|
||
"id": "genomics.pipelines.list",
|
||
"path": "v1alpha2/pipelines:list",
|
||
"httpMethod": "POST",
|
||
"description": "Lists pipelines. Caller must have READ permission to the project.",
|
||
"request": {
|
||
"$ref": "ListPipelinesRequest"
|
||
},
|
||
"response": {
|
||
"$ref": "ListPipelinesResponse"
|
||
},
|
||
"scopes": [
|
||
"https://www.googleapis.com/auth/cloud-platform",
|
||
"https://www.googleapis.com/auth/genomics"
|
||
]
|
||
},
|
||
"delete": {
|
||
"id": "genomics.pipelines.delete",
|
||
"path": "v1alpha2/pipelines/{pipelineId}",
|
||
"httpMethod": "DELETE",
|
||
"description": "Deletes pipeline based on ID. Caller must have WRITE permission to the project.",
|
||
"parameters": {
|
||
"pipelineId": {
|
||
"type": "string",
|
||
"description": "Caller must have WRITE access to the project in which this pipeline is defined.",
|
||
"required": true,
|
||
"location": "path"
|
||
}
|
||
},
|
||
"parameterOrder": [
|
||
"pipelineId"
|
||
],
|
||
"response": {
|
||
"$ref": "Empty"
|
||
},
|
||
"scopes": [
|
||
"https://www.googleapis.com/auth/cloud-platform",
|
||
"https://www.googleapis.com/auth/genomics"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|