2023-06-24
▼ ▲ genomics.pipelines.run
Path: v2alpha1/pipelines:run
Scopes:
Flat Path: v2alpha1/pipelines:run
Description: Runs a pipeline. The returned Operation's metadata field will contain a google.genomics.v2alpha1.Metadata object describing the status of the pipeline execution. The [response] field will contain a google.genomics.v2alpha1.RunPipelineResponse object if the pipeline completes successfully. **Note:** Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following [Google IAM](https://cloud.google.com/iam/) permission: * `genomics.operations.create` [1]: /genomics/gsa
HTTP Method: POST
▼ ▲ genomics.projects.operations.list
Parameter Order: name
Path: v2alpha1/{+name}
Scopes:
Parameters:
name
Type: string
Description: The name of the operation's parent resource.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/operations$
filter
Type: string
Location: query
Description: A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`
pageToken
Location: query
Description: The standard list page token.
Type: string
pageSize
Format: int32
Location: query
Type: integer
Description: The maximum number of results to return. The maximum value is 256.
Flat Path: v2alpha1/projects/{projectsId}/operations
Description: Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list`
HTTP Method: GET
▼ ▲ genomics.projects.operations.cancel
Parameters:
name
Type: string
Required: Yes
Description: The name of the operation resource to be cancelled.
Location: path
Pattern: ^projects/[^/]+/operations/[^/]+$
Scopes:
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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel`
Path: v2alpha1/{+name}:cancel
Parameter Order: name
HTTP Method: POST
Flat Path: v2alpha1/projects/{projectsId}/operations/{operationsId}:cancel
▼ ▲ genomics.projects.operations.get
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource.
Location: path
HTTP Method: GET
Parameter Order: name
Flat Path: v2alpha1/projects/{projectsId}/operations/{operationsId}
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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get`
Path: v2alpha1/{+name}
Scopes:
▼ ▲ genomics.projects.workers.checkIn
Path: v2alpha1/{+id}:checkIn
Description: The worker uses this method to retrieve the assigned operation and provide periodic status updates.
Parameter Order: id
Flat Path: v2alpha1/projects/{projectsId}/workers/{workersId}:checkIn
Scopes:
HTTP Method: POST
Parameters:
id
Required: Yes
Pattern: ^projects/[^/]+/workers/[^/]+$
Location: path
Type: string
Description: The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
▼ ▲ genomics.workers.checkIn
Parameters:
id
Description: The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
Required: Yes
Type: string
Location: path
Parameter Order: id
Path: v2alpha1/workers/{id}:checkIn
Flat Path: v2alpha1/workers/{id}:checkIn
Description: The worker uses this method to retrieve the assigned operation and provide periodic status updates.
HTTP Method: POST
Scopes: