Cloud Life Sciences v2beta API - Class WorkflowsServiceV2Beta.WorkflowsServiceV2BetaClient (2.0.0-beta05)

public class WorkflowsServiceV2Beta.WorkflowsServiceV2BetaClient : ClientBase<WorkflowsServiceV2Beta.WorkflowsServiceV2BetaClient>

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

Client for WorkflowsServiceV2Beta

Inheritance

object > ClientBase > ClientBaseWorkflowsServiceV2BetaWorkflowsServiceV2BetaClient > WorkflowsServiceV2Beta.WorkflowsServiceV2BetaClient

Namespace

Google.Cloud.LifeSciences.V2Beta

Assembly

Google.Cloud.LifeSciences.V2Beta.dll

Constructors

WorkflowsServiceV2BetaClient()

protected WorkflowsServiceV2BetaClient()

Protected parameterless constructor to allow creation of test doubles.

WorkflowsServiceV2BetaClient(CallInvoker)

public WorkflowsServiceV2BetaClient(CallInvoker callInvoker)

Creates a new client for WorkflowsServiceV2Beta that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

WorkflowsServiceV2BetaClient(ChannelBase)

public WorkflowsServiceV2BetaClient(ChannelBase channel)

Creates a new client for WorkflowsServiceV2Beta

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

WorkflowsServiceV2BetaClient(ClientBaseConfiguration)

protected WorkflowsServiceV2BetaClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

NewInstance(ClientBaseConfiguration)

protected override WorkflowsServiceV2Beta.WorkflowsServiceV2BetaClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
WorkflowsServiceV2BetaWorkflowsServiceV2BetaClient
Overrides

RunPipeline(RunPipelineRequest, CallOptions)

public virtual Operation RunPipeline(RunPipelineRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

RunPipeline(RunPipelineRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RunPipeline(RunPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

RunPipelineAsync(RunPipelineRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RunPipelineAsync(RunPipelineRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

RunPipelineAsync(RunPipelineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RunPipelineAsync(RunPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.