Cloud AI Platform v1 API - Class PipelineService.PipelineServiceClient (2.5.0) 

public class PipelineServiceClient : ClientBase<PipelineService.PipelineServiceClient>

Reference documentation and code samples for the Cloud AI Platform v1 API class PipelineService.PipelineServiceClient.

Client for PipelineService

Inheritance

Object > ClientBase > ClientBase<PipelineService.PipelineServiceClient> > PipelineService.PipelineServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

PipelineServiceClient()

protected PipelineServiceClient()

Protected parameterless constructor to allow creation of test doubles.

PipelineServiceClient(CallInvoker)

public PipelineServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

PipelineServiceClient(ChannelBase)

public PipelineServiceClient(ChannelBase channel)

Creates a new client for PipelineService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

PipelineServiceClient(ClientBase.ClientBaseConfiguration)

protected PipelineServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration

The client configuration.

Methods

CancelPipelineJob(CancelPipelineJobRequest, CallOptions)

public virtual Empty CancelPipelineJob(CancelPipelineJobRequest request, CallOptions options)

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to CANCELLED.

Parameters
Name Description
request CancelPipelineJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Empty

The response received from the server.

CancelPipelineJob(CancelPipelineJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty CancelPipelineJob(CancelPipelineJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to CANCELLED.

Parameters
Name Description
request CancelPipelineJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
Empty

The response received from the server.

CancelPipelineJobAsync(CancelPipelineJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> CancelPipelineJobAsync(CancelPipelineJobRequest request, CallOptions options)

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to CANCELLED.

Parameters
Name Description
request CancelPipelineJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

CancelPipelineJobAsync(CancelPipelineJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> CancelPipelineJobAsync(CancelPipelineJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to CANCELLED.

Parameters
Name Description
request CancelPipelineJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
AsyncUnaryCall<Empty>

The call object.

CancelTrainingPipeline(CancelTrainingPipelineRequest, CallOptions)

public virtual Empty CancelTrainingPipeline(CancelTrainingPipelineRequest request, CallOptions options)

Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to CANCELLED.

Parameters
Name Description
request CancelTrainingPipelineRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Empty

The response received from the server.

CancelTrainingPipeline(CancelTrainingPipelineRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty CancelTrainingPipeline(CancelTrainingPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to CANCELLED.

Parameters
Name Description
request CancelTrainingPipelineRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
Empty

The response received from the server.

CancelTrainingPipelineAsync(CancelTrainingPipelineRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> CancelTrainingPipelineAsync(CancelTrainingPipelineRequest request, CallOptions options)

Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to CANCELLED.

Parameters
Name Description
request CancelTrainingPipelineRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

CancelTrainingPipelineAsync(CancelTrainingPipelineRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> CancelTrainingPipelineAsync(CancelTrainingPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to CANCELLED.

Parameters
Name Description
request CancelTrainingPipelineRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
AsyncUnaryCall<Empty>

The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicy.IAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

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

Returns
Type Description
Locations.LocationsClient

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
Operations.OperationsClient

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

CreatePipelineJob(CreatePipelineJobRequest, CallOptions)

public virtual PipelineJob CreatePipelineJob(CreatePipelineJobRequest request, CallOptions options)

Creates a PipelineJob. A PipelineJob will run immediately when created.

Parameters
Name Description
request CreatePipelineJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
PipelineJob

The response received from the server.

CreatePipelineJob(CreatePipelineJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual PipelineJob CreatePipelineJob(CreatePipelineJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a PipelineJob. A PipelineJob will run immediately when created.

Parameters
Name Description
request CreatePipelineJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
PipelineJob

The response received from the server.

CreatePipelineJobAsync(CreatePipelineJobRequest, CallOptions)

public virtual AsyncUnaryCall<PipelineJob> CreatePipelineJobAsync(CreatePipelineJobRequest request, CallOptions options)

Creates a PipelineJob. A PipelineJob will run immediately when created.

Parameters
Name Description
request CreatePipelineJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<PipelineJob>

The call object.

CreatePipelineJobAsync(CreatePipelineJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<PipelineJob> CreatePipelineJobAsync(CreatePipelineJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a PipelineJob. A PipelineJob will run immediately when created.

Parameters
Name Description
request CreatePipelineJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
AsyncUnaryCall<PipelineJob>

The call object.

CreateTrainingPipeline(CreateTrainingPipelineRequest, CallOptions)

public virtual TrainingPipeline CreateTrainingPipeline(CreateTrainingPipelineRequest request, CallOptions options)

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Parameters
Name Description
request CreateTrainingPipelineRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
TrainingPipeline

The response received from the server.

CreateTrainingPipeline(CreateTrainingPipelineRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual TrainingPipeline CreateTrainingPipeline(CreateTrainingPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Parameters
Name Description
request CreateTrainingPipelineRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
TrainingPipeline

The response received from the server.

CreateTrainingPipelineAsync(CreateTrainingPipelineRequest, CallOptions)

public virtual AsyncUnaryCall<TrainingPipeline> CreateTrainingPipelineAsync(CreateTrainingPipelineRequest request, CallOptions options)

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Parameters
Name Description
request CreateTrainingPipelineRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<TrainingPipeline>

The call object.

CreateTrainingPipelineAsync(CreateTrainingPipelineRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<TrainingPipeline> CreateTrainingPipelineAsync(CreateTrainingPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Parameters
Name Description
request CreateTrainingPipelineRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
AsyncUnaryCall<TrainingPipeline>

The call object.

DeletePipelineJob(DeletePipelineJobRequest, CallOptions)

public virtual Operation DeletePipelineJob(DeletePipelineJobRequest request, CallOptions options)

Deletes a PipelineJob.

Parameters
Name Description
request DeletePipelineJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeletePipelineJob(DeletePipelineJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a PipelineJob.

Parameters
Name Description
request DeletePipelineJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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.

DeletePipelineJobAsync(DeletePipelineJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeletePipelineJobAsync(DeletePipelineJobRequest request, CallOptions options)

Deletes a PipelineJob.

Parameters
Name Description
request DeletePipelineJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

DeletePipelineJobAsync(DeletePipelineJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a PipelineJob.

Parameters
Name Description
request DeletePipelineJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
AsyncUnaryCall<Operation>

The call object.

DeleteTrainingPipeline(DeleteTrainingPipelineRequest, CallOptions)

public virtual Operation DeleteTrainingPipeline(DeleteTrainingPipelineRequest request, CallOptions options)

Deletes a TrainingPipeline.

Parameters
Name Description
request DeleteTrainingPipelineRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteTrainingPipeline(DeleteTrainingPipelineRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a TrainingPipeline.

Parameters
Name Description
request DeleteTrainingPipelineRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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.

DeleteTrainingPipelineAsync(DeleteTrainingPipelineRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteTrainingPipelineAsync(DeleteTrainingPipelineRequest request, CallOptions options)

Deletes a TrainingPipeline.

Parameters
Name Description
request DeleteTrainingPipelineRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

DeleteTrainingPipelineAsync(DeleteTrainingPipelineRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a TrainingPipeline.

Parameters
Name Description
request DeleteTrainingPipelineRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
AsyncUnaryCall<Operation>

The call object.

GetPipelineJob(GetPipelineJobRequest, CallOptions)

public virtual PipelineJob GetPipelineJob(GetPipelineJobRequest request, CallOptions options)

Gets a PipelineJob.

Parameters
Name Description
request GetPipelineJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
PipelineJob

The response received from the server.

GetPipelineJob(GetPipelineJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual PipelineJob GetPipelineJob(GetPipelineJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a PipelineJob.

Parameters
Name Description
request GetPipelineJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
PipelineJob

The response received from the server.

GetPipelineJobAsync(GetPipelineJobRequest, CallOptions)

public virtual AsyncUnaryCall<PipelineJob> GetPipelineJobAsync(GetPipelineJobRequest request, CallOptions options)

Gets a PipelineJob.

Parameters
Name Description
request GetPipelineJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<PipelineJob>

The call object.

GetPipelineJobAsync(GetPipelineJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<PipelineJob> GetPipelineJobAsync(GetPipelineJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a PipelineJob.

Parameters
Name Description
request GetPipelineJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
AsyncUnaryCall<PipelineJob>

The call object.

GetTrainingPipeline(GetTrainingPipelineRequest, CallOptions)

public virtual TrainingPipeline GetTrainingPipeline(GetTrainingPipelineRequest request, CallOptions options)

Gets a TrainingPipeline.

Parameters
Name Description
request GetTrainingPipelineRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
TrainingPipeline

The response received from the server.

GetTrainingPipeline(GetTrainingPipelineRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual TrainingPipeline GetTrainingPipeline(GetTrainingPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a TrainingPipeline.

Parameters
Name Description
request GetTrainingPipelineRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
TrainingPipeline

The response received from the server.

GetTrainingPipelineAsync(GetTrainingPipelineRequest, CallOptions)

public virtual AsyncUnaryCall<TrainingPipeline> GetTrainingPipelineAsync(GetTrainingPipelineRequest request, CallOptions options)

Gets a TrainingPipeline.

Parameters
Name Description
request GetTrainingPipelineRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<TrainingPipeline>

The call object.

GetTrainingPipelineAsync(GetTrainingPipelineRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<TrainingPipeline> GetTrainingPipelineAsync(GetTrainingPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a TrainingPipeline.

Parameters
Name Description
request GetTrainingPipelineRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
AsyncUnaryCall<TrainingPipeline>

The call object.

ListPipelineJobs(ListPipelineJobsRequest, CallOptions)

public virtual ListPipelineJobsResponse ListPipelineJobs(ListPipelineJobsRequest request, CallOptions options)

Lists PipelineJobs in a Location.

Parameters
Name Description
request ListPipelineJobsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListPipelineJobsResponse

The response received from the server.

ListPipelineJobs(ListPipelineJobsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListPipelineJobsResponse ListPipelineJobs(ListPipelineJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists PipelineJobs in a Location.

Parameters
Name Description
request ListPipelineJobsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
ListPipelineJobsResponse

The response received from the server.

ListPipelineJobsAsync(ListPipelineJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListPipelineJobsResponse> ListPipelineJobsAsync(ListPipelineJobsRequest request, CallOptions options)

Lists PipelineJobs in a Location.

Parameters
Name Description
request ListPipelineJobsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<ListPipelineJobsResponse>

The call object.

ListPipelineJobsAsync(ListPipelineJobsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListPipelineJobsResponse> ListPipelineJobsAsync(ListPipelineJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists PipelineJobs in a Location.

Parameters
Name Description
request ListPipelineJobsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
AsyncUnaryCall<ListPipelineJobsResponse>

The call object.

ListTrainingPipelines(ListTrainingPipelinesRequest, CallOptions)

public virtual ListTrainingPipelinesResponse ListTrainingPipelines(ListTrainingPipelinesRequest request, CallOptions options)

Lists TrainingPipelines in a Location.

Parameters
Name Description
request ListTrainingPipelinesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListTrainingPipelinesResponse

The response received from the server.

ListTrainingPipelines(ListTrainingPipelinesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListTrainingPipelinesResponse ListTrainingPipelines(ListTrainingPipelinesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists TrainingPipelines in a Location.

Parameters
Name Description
request ListTrainingPipelinesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
ListTrainingPipelinesResponse

The response received from the server.

ListTrainingPipelinesAsync(ListTrainingPipelinesRequest, CallOptions)

public virtual AsyncUnaryCall<ListTrainingPipelinesResponse> ListTrainingPipelinesAsync(ListTrainingPipelinesRequest request, CallOptions options)

Lists TrainingPipelines in a Location.

Parameters
Name Description
request ListTrainingPipelinesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<ListTrainingPipelinesResponse>

The call object.

ListTrainingPipelinesAsync(ListTrainingPipelinesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListTrainingPipelinesResponse> ListTrainingPipelinesAsync(ListTrainingPipelinesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists TrainingPipelines in a Location.

Parameters
Name Description
request ListTrainingPipelinesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<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
AsyncUnaryCall<ListTrainingPipelinesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override PipelineService.PipelineServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration
Returns
Type Description
PipelineService.PipelineServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1.PipelineService.PipelineServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)