blob: 43920b0ef2da879a597c3c32edfff86c19098a9e [file] [log] [blame]
{
"clientLibrary": {
"name": "cloud.google.com/go/lifesciences/apiv2beta",
"version": "0.9.7",
"language": "GO",
"apis": [
{
"id": "google.cloud.lifesciences.v2beta",
"version": "v2beta"
}
]
},
"snippets": [
{
"regionTag": "lifesciences_v2beta_generated_WorkflowsServiceV2Beta_CancelOperation_sync",
"title": "lifesciences CancelOperation Sample",
"description": "CancelOperation starts asynchronous cancellation on a long-running operation. The\nserver makes a best effort to cancel the operation, but success is\nnot guaranteed. Clients may use\n[Operations.GetOperation][google.longrunning.Operations.GetOperation] or\n[Operations.ListOperations][google.longrunning.Operations.ListOperations] to\ncheck whether the cancellation succeeded or the operation completed\ndespite cancellation.\nAuthorization requires the following [Google\nIAM](https: //cloud.google.com/iam) permission:\n\n* `lifesciences.operations.cancel`",
"file": "WorkflowsServiceV2BetaClient/CancelOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CancelOperation",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient.CancelOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.CancelOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "WorkflowsServiceV2BetaClient",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient"
},
"method": {
"shortName": "CancelOperation",
"fullName": "google.longrunning.Operations.CancelOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 51,
"type": "FULL"
}
]
},
{
"regionTag": "lifesciences_v2beta_generated_WorkflowsServiceV2Beta_GetLocation_sync",
"title": "lifesciences GetLocation Sample",
"description": "GetLocation gets information about a location.",
"file": "WorkflowsServiceV2BetaClient/GetLocation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetLocation",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient.GetLocation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "locationpb.GetLocationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*locationpb.Location",
"client": {
"shortName": "WorkflowsServiceV2BetaClient",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient"
},
"method": {
"shortName": "GetLocation",
"fullName": "google.cloud.location.Locations.GetLocation",
"service": {
"shortName": "Locations",
"fullName": "google.cloud.location.Locations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "lifesciences_v2beta_generated_WorkflowsServiceV2Beta_GetOperation_sync",
"title": "lifesciences GetOperation Sample",
"description": "GetOperation 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\nAPI service.\nAuthorization requires the following [Google\nIAM](https: //cloud.google.com/iam) permission:\n\n* `lifesciences.operations.get`",
"file": "WorkflowsServiceV2BetaClient/GetOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetOperation",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient.GetOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.GetOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*longrunningpb.Operation",
"client": {
"shortName": "WorkflowsServiceV2BetaClient",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient"
},
"method": {
"shortName": "GetOperation",
"fullName": "google.longrunning.Operations.GetOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "lifesciences_v2beta_generated_WorkflowsServiceV2Beta_ListLocations_sync",
"title": "lifesciences ListLocations Sample",
"description": "ListLocations lists information about the supported locations for this service.",
"file": "WorkflowsServiceV2BetaClient/ListLocations/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListLocations",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient.ListLocations",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "locationpb.ListLocationsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "LocationIterator",
"client": {
"shortName": "WorkflowsServiceV2BetaClient",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient"
},
"method": {
"shortName": "ListLocations",
"fullName": "google.cloud.location.Locations.ListLocations",
"service": {
"shortName": "Locations",
"fullName": "google.cloud.location.Locations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 66,
"type": "FULL"
}
]
},
{
"regionTag": "lifesciences_v2beta_generated_WorkflowsServiceV2Beta_ListOperations_sync",
"title": "lifesciences ListOperations Sample",
"description": "ListOperations lists operations that match the specified filter in the\nrequest. Authorization requires the following [Google\nIAM](https: //cloud.google.com/iam) permission:\n\n* `lifesciences.operations.list`",
"file": "WorkflowsServiceV2BetaClient/ListOperations/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListOperations",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient.ListOperations",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.ListOperationsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "OperationIterator",
"client": {
"shortName": "WorkflowsServiceV2BetaClient",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient"
},
"method": {
"shortName": "ListOperations",
"fullName": "google.longrunning.Operations.ListOperations",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 66,
"type": "FULL"
}
]
},
{
"regionTag": "lifesciences_v2beta_generated_WorkflowsServiceV2Beta_RunPipeline_sync",
"title": "lifesciences RunPipeline Sample",
"description": "RunPipeline runs a pipeline. The returned Operation's [metadata]\n[google.longrunning.Operation.metadata] field will contain a\n[google.cloud.lifesciences.v2beta.Metadata][google.cloud.lifesciences.v2beta.Metadata]\nobject describing the status of the pipeline execution. The\n[response][google.longrunning.Operation.response] field will contain a\n[google.cloud.lifesciences.v2beta.RunPipelineResponse][google.cloud.lifesciences.v2beta.RunPipelineResponse]\nobject if the pipeline completes successfully.\n\n**Note: ** Before you can use this method, the *Life Sciences Service Agent*\nmust have access to your project. This is done automatically when the\nCloud Life Sciences API is first enabled, but if you delete this permission\nyou must disable and re-enable the API to grant the Life Sciences\nService Agent the required permissions.\nAuthorization requires the following [Google\nIAM](https: //cloud.google.com/iam/) permission: \n\n* `lifesciences.workflows.run`",
"file": "WorkflowsServiceV2BetaClient/RunPipeline/main.go",
"language": "GO",
"clientMethod": {
"shortName": "RunPipeline",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient.RunPipeline",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "lifesciencespb.RunPipelineRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "RunPipelineOperation",
"client": {
"shortName": "WorkflowsServiceV2BetaClient",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient"
},
"method": {
"shortName": "RunPipeline",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2Beta.RunPipeline",
"service": {
"shortName": "WorkflowsServiceV2Beta",
"fullName": "google.cloud.lifesciences.v2beta.WorkflowsServiceV2Beta"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
}
]
}