Cloud AI Platform v1 API - Class JobServiceClientImpl (2.4.0) 

public sealed class JobServiceClientImpl : JobServiceClient

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

JobService client wrapper implementation, for convenient use.

Inheritance

Object > JobServiceClient > JobServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for creating and managing Vertex AI's jobs.

Constructors

JobServiceClientImpl(JobService.JobServiceClient, JobServiceSettings, ILogger)

public JobServiceClientImpl(JobService.JobServiceClient grpcClient, JobServiceSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientJobService.JobServiceClient

The underlying gRPC client.

settingsJobServiceSettings

The base JobServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

DeleteBatchPredictionJobOperationsClient

public override OperationsClient DeleteBatchPredictionJobOperationsClient { get; }

The long-running operations client for DeleteBatchPredictionJob.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteCustomJobOperationsClient

public override OperationsClient DeleteCustomJobOperationsClient { get; }

The long-running operations client for DeleteCustomJob.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteDataLabelingJobOperationsClient

public override OperationsClient DeleteDataLabelingJobOperationsClient { get; }

The long-running operations client for DeleteDataLabelingJob.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteHyperparameterTuningJobOperationsClient

public override OperationsClient DeleteHyperparameterTuningJobOperationsClient { get; }

The long-running operations client for DeleteHyperparameterTuningJob.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteModelDeploymentMonitoringJobOperationsClient

public override OperationsClient DeleteModelDeploymentMonitoringJobOperationsClient { get; }

The long-running operations client for DeleteModelDeploymentMonitoringJob.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override JobService.JobServiceClient GrpcClient { get; }

The underlying gRPC JobService client

Property Value
TypeDescription
JobService.JobServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

UpdateModelDeploymentMonitoringJobOperationsClient

public override OperationsClient UpdateModelDeploymentMonitoringJobOperationsClient { get; }

The long-running operations client for UpdateModelDeploymentMonitoringJob.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CancelBatchPredictionJob(CancelBatchPredictionJobRequest, CallSettings)

public override void CancelBatchPredictionJob(CancelBatchPredictionJobRequest request, CallSettings callSettings = null)

Cancels a BatchPredictionJob.

Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to CANCELLED. Any files already outputted by the job are not deleted.

Parameters
NameDescription
requestCancelBatchPredictionJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

CancelBatchPredictionJobAsync(CancelBatchPredictionJobRequest, CallSettings)

public override Task CancelBatchPredictionJobAsync(CancelBatchPredictionJobRequest request, CallSettings callSettings = null)

Cancels a BatchPredictionJob.

Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to CANCELLED. Any files already outputted by the job are not deleted.

Parameters
NameDescription
requestCancelBatchPredictionJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

CancelCustomJob(CancelCustomJobRequest, CallSettings)

public override void CancelCustomJob(CancelCustomJobRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCancelCustomJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

CancelCustomJobAsync(CancelCustomJobRequest, CallSettings)

public override Task CancelCustomJobAsync(CancelCustomJobRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCancelCustomJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

CancelDataLabelingJob(CancelDataLabelingJobRequest, CallSettings)

public override void CancelDataLabelingJob(CancelDataLabelingJobRequest request, CallSettings callSettings = null)

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

Parameters
NameDescription
requestCancelDataLabelingJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

CancelDataLabelingJobAsync(CancelDataLabelingJobRequest, CallSettings)

public override Task CancelDataLabelingJobAsync(CancelDataLabelingJobRequest request, CallSettings callSettings = null)

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

Parameters
NameDescription
requestCancelDataLabelingJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest, CallSettings)

public override void CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCancelHyperparameterTuningJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

CancelHyperparameterTuningJobAsync(CancelHyperparameterTuningJobRequest, CallSettings)

public override Task CancelHyperparameterTuningJobAsync(CancelHyperparameterTuningJobRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCancelHyperparameterTuningJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

CreateBatchPredictionJob(CreateBatchPredictionJobRequest, CallSettings)

public override BatchPredictionJob CreateBatchPredictionJob(CreateBatchPredictionJobRequest request, CallSettings callSettings = null)

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

Parameters
NameDescription
requestCreateBatchPredictionJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.