Cloud AI Platform v1beta1 API - Class PipelineService.PipelineServiceBase (1.0.0-beta01)

Version 1.0.0-beta01

• 1.0.0-beta11 (latest)
• 1.0.0-beta10

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

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class PipelineService.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.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Methods

BatchCancelPipelineJobs(BatchCancelPipelineJobsRequest, ServerCallContext)

public virtual Task<Operation> BatchCancelPipelineJobs(BatchCancelPipelineJobsRequest request, ServerCallContext context)

Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

BatchDeletePipelineJobs(BatchDeletePipelineJobsRequest, ServerCallContext)

public virtual Task<Operation> BatchDeletePipelineJobs(BatchDeletePipelineJobsRequest request, ServerCallContext context)

Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

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.v1beta1.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.v1beta1.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.v1beta1.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
TaskEmpty	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.v1beta1.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.v1beta1.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.v1beta1.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
TaskEmpty	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
TaskPipelineJob	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
TaskTrainingPipeline	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
TaskOperation	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
TaskOperation	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
TaskPipelineJob	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
TaskTrainingPipeline	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
TaskListPipelineJobsResponse	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
TaskListTrainingPipelinesResponse	The response to send back to the client (wrapped by a task).