Cloud Life Sciences v2beta API - Class WorkflowsServiceV2BetaClientImpl (2.0.0-beta05)

Version latest

• 2.0.0-beta05 (latest)
• 2.0.0-beta04
• 1.0.0-beta02

public sealed class WorkflowsServiceV2BetaClientImpl : WorkflowsServiceV2BetaClient

Reference documentation and code samples for the Cloud Life Sciences v2beta API class WorkflowsServiceV2BetaClientImpl.

WorkflowsServiceV2Beta client wrapper implementation, for convenient use.

Inheritance

object > WorkflowsServiceV2BetaClient > WorkflowsServiceV2BetaClientImpl

Inherited Members

WorkflowsServiceV2BetaClient.DefaultEndpoint

WorkflowsServiceV2BetaClient.DefaultScopes

WorkflowsServiceV2BetaClient.ServiceMetadata

WorkflowsServiceV2BetaClient.CreateAsync(CancellationToken)

WorkflowsServiceV2BetaClient.Create()

WorkflowsServiceV2BetaClient.ShutdownDefaultChannelsAsync()

WorkflowsServiceV2BetaClient.RunPipelineAsync(RunPipelineRequest, CancellationToken)

WorkflowsServiceV2BetaClient.PollOnceRunPipeline(string, CallSettings)

WorkflowsServiceV2BetaClient.PollOnceRunPipelineAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.LifeSciences.V2Beta

Assembly

Google.Cloud.LifeSciences.V2Beta.dll

Remarks

A service for running workflows, such as pipelines consisting of Docker containers.

Constructors

WorkflowsServiceV2BetaClientImpl(WorkflowsServiceV2BetaClient, WorkflowsServiceV2BetaSettings, ILogger)

public WorkflowsServiceV2BetaClientImpl(WorkflowsServiceV2Beta.WorkflowsServiceV2BetaClient grpcClient, WorkflowsServiceV2BetaSettings settings, ILogger logger)

Constructs a client wrapper for the WorkflowsServiceV2Beta service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	WorkflowsServiceV2BetaWorkflowsServiceV2BetaClient The underlying gRPC client.
settings	WorkflowsServiceV2BetaSettings The base WorkflowsServiceV2BetaSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override WorkflowsServiceV2Beta.WorkflowsServiceV2BetaClient GrpcClient { get; }

The underlying gRPC WorkflowsServiceV2Beta client

Property Value
Type	Description
WorkflowsServiceV2BetaWorkflowsServiceV2BetaClient

Overrides

WorkflowsServiceV2BetaClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

WorkflowsServiceV2BetaClient.LocationsClient

RunPipelineOperationsClient

public override OperationsClient RunPipelineOperationsClient { get; }

The long-running operations client for RunPipeline.

Property Value
Type	Description
OperationsClient

Overrides

WorkflowsServiceV2BetaClient.RunPipelineOperationsClient

Methods

RunPipeline(RunPipelineRequest, CallSettings)

public override Operation<RunPipelineResponse, Metadata> RunPipeline(RunPipelineRequest request, CallSettings callSettings = null)

Runs a pipeline. The returned Operation's [metadata] [google.longrunning.Operation.metadata] field will contain a [google.cloud.lifesciences.v2beta.Metadata][google.cloud.lifesciences.v2beta.Metadata] object describing the status of the pipeline execution. The [response][google.longrunning.Operation.response] field will contain a [google.cloud.lifesciences.v2beta.RunPipelineResponse][google.cloud.lifesciences.v2beta.RunPipelineResponse] object if the pipeline completes successfully.

Note: Before you can use this method, the Life Sciences Service Agent must have access to your project. This is done automatically when the Cloud Life Sciences API is first enabled, but if you delete this permission you must disable and re-enable the API to grant the Life Sciences Service Agent the required permissions. Authorization requires the following Google IAM permission:

• lifesciences.workflows.run

Parameters
Name	Description
request	RunPipelineRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationRunPipelineResponseMetadata	The RPC response.

Overrides

WorkflowsServiceV2BetaClient.RunPipeline(RunPipelineRequest, CallSettings)

RunPipelineAsync(RunPipelineRequest, CallSettings)

public override Task<Operation<RunPipelineResponse, Metadata>> RunPipelineAsync(RunPipelineRequest request, CallSettings callSettings = null)

Runs a pipeline. The returned Operation's [metadata] [google.longrunning.Operation.metadata] field will contain a [google.cloud.lifesciences.v2beta.Metadata][google.cloud.lifesciences.v2beta.Metadata] object describing the status of the pipeline execution. The [response][google.longrunning.Operation.response] field will contain a [google.cloud.lifesciences.v2beta.RunPipelineResponse][google.cloud.lifesciences.v2beta.RunPipelineResponse] object if the pipeline completes successfully.

Note: Before you can use this method, the Life Sciences Service Agent must have access to your project. This is done automatically when the Cloud Life Sciences API is first enabled, but if you delete this permission you must disable and re-enable the API to grant the Life Sciences Service Agent the required permissions. Authorization requires the following Google IAM permission:

• lifesciences.workflows.run

Parameters
Name	Description
request	RunPipelineRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationRunPipelineResponseMetadata	A Task containing the RPC response.

Overrides

WorkflowsServiceV2BetaClient.RunPipelineAsync(RunPipelineRequest, CallSettings)