Class PipelineService.PipelineServiceBase (1.1.0)

[BindServiceMethod(typeof(PipelineService), "BindService")]
public abstract class PipelineServiceBase

Base class for server-side implementations of PipelineService

Inheritance

Object > PipelineService.PipelineServiceBase

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Methods

CancelPipelineJob(CancelPipelineJobRequest, ServerCallContext)

public virtual Task<Empty> CancelPipelineJob(CancelPipelineJobRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Empty>`	The response to send back to the client (wrapped by a task).

CancelTrainingPipeline(CancelTrainingPipelineRequest, ServerCallContext)

public virtual Task<Empty> CancelTrainingPipeline(CancelTrainingPipelineRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Empty>`	The response to send back to the client (wrapped by a task).

CreatePipelineJob(CreatePipelineJobRequest, ServerCallContext)

public virtual Task<PipelineJob> CreatePipelineJob(CreatePipelineJobRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`CreatePipelineJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<PipelineJob>`	The response to send back to the client (wrapped by a task).

CreateTrainingPipeline(CreateTrainingPipelineRequest, ServerCallContext)

public virtual Task<TrainingPipeline> CreateTrainingPipeline(CreateTrainingPipelineRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`CreateTrainingPipelineRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<TrainingPipeline>`	The response to send back to the client (wrapped by a task).

DeletePipelineJob(DeletePipelineJobRequest, ServerCallContext)

public virtual Task<Operation> DeletePipelineJob(DeletePipelineJobRequest request, ServerCallContext context)

Deletes a PipelineJob.

Parameters
Name	Description
`request`	`DeletePipelineJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

DeleteTrainingPipeline(DeleteTrainingPipelineRequest, ServerCallContext)

public virtual Task<Operation> DeleteTrainingPipeline(DeleteTrainingPipelineRequest request, ServerCallContext context)

Deletes a TrainingPipeline.

Parameters
Name	Description
`request`	`DeleteTrainingPipelineRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

GetPipelineJob(GetPipelineJobRequest, ServerCallContext)

public virtual Task<PipelineJob> GetPipelineJob(GetPipelineJobRequest request, ServerCallContext context)

Gets a PipelineJob.

Parameters
Name	Description
`request`	`GetPipelineJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<PipelineJob>`	The response to send back to the client (wrapped by a task).

GetTrainingPipeline(GetTrainingPipelineRequest, ServerCallContext)

public virtual Task<TrainingPipeline> GetTrainingPipeline(GetTrainingPipelineRequest request, ServerCallContext context)

Gets a TrainingPipeline.

Parameters
Name	Description
`request`	`GetTrainingPipelineRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<TrainingPipeline>`	The response to send back to the client (wrapped by a task).

ListPipelineJobs(ListPipelineJobsRequest, ServerCallContext)

public virtual Task<ListPipelineJobsResponse> ListPipelineJobs(ListPipelineJobsRequest request, ServerCallContext context)

Lists PipelineJobs in a Location.

Parameters
Name	Description
`request`	`ListPipelineJobsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ListPipelineJobsResponse>`	The response to send back to the client (wrapped by a task).

ListTrainingPipelines(ListTrainingPipelinesRequest, ServerCallContext)

public virtual Task<ListTrainingPipelinesResponse> ListTrainingPipelines(ListTrainingPipelinesRequest request, ServerCallContext context)

Lists TrainingPipelines in a Location.

Parameters
Name	Description
`request`	`ListTrainingPipelinesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ListTrainingPipelinesResponse>`	The response to send back to the client (wrapped by a task).