Cloud AI Platform v1 API - Class JobServiceClientImpl (3.11.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(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
Name Description
grpcClient JobServiceJobServiceClient

The underlying gRPC client.
settings JobServiceSettings

The base JobServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

DeleteBatchPredictionJobOperationsClient

public override OperationsClient DeleteBatchPredictionJobOperationsClient { get; }

The long-running operations client for DeleteBatchPredictionJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteCustomJobOperationsClient

public override OperationsClient DeleteCustomJobOperationsClient { get; }

The long-running operations client for DeleteCustomJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteDataLabelingJobOperationsClient

public override OperationsClient DeleteDataLabelingJobOperationsClient { get; }

The long-running operations client for DeleteDataLabelingJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteHyperparameterTuningJobOperationsClient

public override OperationsClient DeleteHyperparameterTuningJobOperationsClient { get; }

The long-running operations client for DeleteHyperparameterTuningJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteModelDeploymentMonitoringJobOperationsClient

public override OperationsClient DeleteModelDeploymentMonitoringJobOperationsClient { get; }

The long-running operations client for DeleteModelDeploymentMonitoringJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteNasJobOperationsClient

public override OperationsClient DeleteNasJobOperationsClient { get; }

The long-running operations client for DeleteNasJob.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override JobService.JobServiceClient GrpcClient { get; }

The underlying gRPC JobService client

Property Value
Type Description
JobServiceJobServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateModelDeploymentMonitoringJobOperationsClient

public override OperationsClient UpdateModelDeploymentMonitoringJobOperationsClient { get; }

The long-running operations client for UpdateModelDeploymentMonitoringJob.

Property Value
Type Description
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
Name Description
request CancelBatchPredictionJobRequest

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

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
Name Description
request CancelBatchPredictionJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request CancelCustomJobRequest

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

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
Name Description
request CancelCustomJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request CancelDataLabelingJobRequest

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

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
Name Description
request CancelDataLabelingJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request CancelHyperparameterTuningJobRequest

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

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
Name Description
request CancelHyperparameterTuningJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

CancelNasJob(CancelNasJobRequest, CallSettings)

public override void CancelNasJob(CancelNasJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CancelNasJobRequest

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

If not null, applies overrides to this RPC call.
Overrides

CancelNasJobAsync(CancelNasJobRequest, CallSettings)

public override Task CancelNasJobAsync(CancelNasJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CancelNasJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request CreateBatchPredictionJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchPredictionJob

The RPC response.
Overrides

CreateBatchPredictionJobAsync(CreateBatchPredictionJobRequest, CallSettings)

public override Task<BatchPredictionJob> CreateBatchPredictionJobAsync(CreateBatchPredictionJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateBatchPredictionJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskBatchPredictionJob

A Task containing the RPC response.
Overrides

CreateCustomJob(CreateCustomJobRequest, CallSettings)

public override CustomJob CreateCustomJob(CreateCustomJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateCustomJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
CustomJob

The RPC response.
Overrides

CreateCustomJobAsync(CreateCustomJobRequest, CallSettings)

public override Task<CustomJob> CreateCustomJobAsync(CreateCustomJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateCustomJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCustomJob

A Task containing the RPC response.
Overrides

CreateDataLabelingJob(CreateDataLabelingJobRequest, CallSettings)

public override DataLabelingJob CreateDataLabelingJob(CreateDataLabelingJobRequest request, CallSettings callSettings = null)

Creates a DataLabelingJob.

Parameters
Name Description
request CreateDataLabelingJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
DataLabelingJob

The RPC response.
Overrides

CreateDataLabelingJobAsync(CreateDataLabelingJobRequest, CallSettings)

public override Task<DataLabelingJob> CreateDataLabelingJobAsync(CreateDataLabelingJobRequest request, CallSettings callSettings = null)

Creates a DataLabelingJob.

Parameters
Name Description
request CreateDataLabelingJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataLabelingJob

A Task containing the RPC response.
Overrides

CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest, CallSettings)

public override HyperparameterTuningJob CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request, CallSettings callSettings = null)

Creates a HyperparameterTuningJob

Parameters
Name Description
request CreateHyperparameterTuningJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
HyperparameterTuningJob

The RPC response.
Overrides

CreateHyperparameterTuningJobAsync(CreateHyperparameterTuningJobRequest, CallSettings)

public override Task<HyperparameterTuningJob> CreateHyperparameterTuningJobAsync(CreateHyperparameterTuningJobRequest request, CallSettings callSettings = null)

Creates a HyperparameterTuningJob

Parameters
Name Description
request CreateHyperparameterTuningJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskHyperparameterTuningJob

A Task containing the RPC response.
Overrides

CreateModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest, CallSettings)

public override ModelDeploymentMonitoringJob CreateModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

Parameters
Name Description
request CreateModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
ModelDeploymentMonitoringJob

The RPC response.
Overrides

CreateModelDeploymentMonitoringJobAsync(CreateModelDeploymentMonitoringJobRequest, CallSettings)

public override Task<ModelDeploymentMonitoringJob> CreateModelDeploymentMonitoringJobAsync(CreateModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

Parameters
Name Description
request CreateModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskModelDeploymentMonitoringJob

A Task containing the RPC response.
Overrides

CreateNasJob(CreateNasJobRequest, CallSettings)

public override NasJob CreateNasJob(CreateNasJobRequest request, CallSettings callSettings = null)

Creates a NasJob

Parameters
Name Description
request CreateNasJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
NasJob

The RPC response.
Overrides

CreateNasJobAsync(CreateNasJobRequest, CallSettings)

public override Task<NasJob> CreateNasJobAsync(CreateNasJobRequest request, CallSettings callSettings = null)

Creates a NasJob

Parameters
Name Description
request CreateNasJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskNasJob

A Task containing the RPC response.
Overrides

DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest request, CallSettings callSettings = null)

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

Parameters
Name Description
request DeleteBatchPredictionJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteBatchPredictionJobAsync(DeleteBatchPredictionJobRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteBatchPredictionJobAsync(DeleteBatchPredictionJobRequest request, CallSettings callSettings = null)

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

Parameters
Name Description
request DeleteBatchPredictionJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteCustomJob(DeleteCustomJobRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteCustomJob(DeleteCustomJobRequest request, CallSettings callSettings = null)

Deletes a CustomJob.

Parameters
Name Description
request DeleteCustomJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteCustomJobAsync(DeleteCustomJobRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteCustomJobAsync(DeleteCustomJobRequest request, CallSettings callSettings = null)

Deletes a CustomJob.

Parameters
Name Description
request DeleteCustomJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteDataLabelingJob(DeleteDataLabelingJobRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteDataLabelingJob(DeleteDataLabelingJobRequest request, CallSettings callSettings = null)

Deletes a DataLabelingJob.

Parameters
Name Description
request DeleteDataLabelingJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteDataLabelingJobAsync(DeleteDataLabelingJobRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteDataLabelingJobAsync(DeleteDataLabelingJobRequest request, CallSettings callSettings = null)

Deletes a DataLabelingJob.

Parameters
Name Description
request DeleteDataLabelingJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request, CallSettings callSettings = null)

Deletes a HyperparameterTuningJob.

Parameters
Name Description
request DeleteHyperparameterTuningJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest request, CallSettings callSettings = null)

Deletes a HyperparameterTuningJob.

Parameters
Name Description
request DeleteHyperparameterTuningJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Deletes a ModelDeploymentMonitoringJob.

Parameters
Name Description
request DeleteModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Deletes a ModelDeploymentMonitoringJob.

Parameters
Name Description
request DeleteModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteNasJob(DeleteNasJobRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteNasJob(DeleteNasJobRequest request, CallSettings callSettings = null)

Deletes a NasJob.

Parameters
Name Description
request DeleteNasJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteNasJobAsync(DeleteNasJobRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteNasJobAsync(DeleteNasJobRequest request, CallSettings callSettings = null)

Deletes a NasJob.

Parameters
Name Description
request DeleteNasJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

GetBatchPredictionJob(GetBatchPredictionJobRequest, CallSettings)

public override BatchPredictionJob GetBatchPredictionJob(GetBatchPredictionJobRequest request, CallSettings callSettings = null)

Gets a BatchPredictionJob

Parameters
Name Description
request GetBatchPredictionJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchPredictionJob

The RPC response.
Overrides

GetBatchPredictionJobAsync(GetBatchPredictionJobRequest, CallSettings)

public override Task<BatchPredictionJob> GetBatchPredictionJobAsync(GetBatchPredictionJobRequest request, CallSettings callSettings = null)

Gets a BatchPredictionJob

Parameters
Name Description
request GetBatchPredictionJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskBatchPredictionJob

A Task containing the RPC response.
Overrides

GetCustomJob(GetCustomJobRequest, CallSettings)

public override CustomJob GetCustomJob(GetCustomJobRequest request, CallSettings callSettings = null)

Gets a CustomJob.

Parameters
Name Description
request GetCustomJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
CustomJob

The RPC response.
Overrides

GetCustomJobAsync(GetCustomJobRequest, CallSettings)

public override Task<CustomJob> GetCustomJobAsync(GetCustomJobRequest request, CallSettings callSettings = null)

Gets a CustomJob.

Parameters
Name Description
request GetCustomJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCustomJob

A Task containing the RPC response.
Overrides

GetDataLabelingJob(GetDataLabelingJobRequest, CallSettings)

public override DataLabelingJob GetDataLabelingJob(GetDataLabelingJobRequest request, CallSettings callSettings = null)

Gets a DataLabelingJob.

Parameters
Name Description
request GetDataLabelingJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
DataLabelingJob

The RPC response.
Overrides

GetDataLabelingJobAsync(GetDataLabelingJobRequest, CallSettings)

public override Task<DataLabelingJob> GetDataLabelingJobAsync(GetDataLabelingJobRequest request, CallSettings callSettings = null)

Gets a DataLabelingJob.

Parameters
Name Description
request GetDataLabelingJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataLabelingJob

A Task containing the RPC response.
Overrides

GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest, CallSettings)

public override HyperparameterTuningJob GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest request, CallSettings callSettings = null)

Gets a HyperparameterTuningJob

Parameters
Name Description
request GetHyperparameterTuningJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
HyperparameterTuningJob

The RPC response.
Overrides

GetHyperparameterTuningJobAsync(GetHyperparameterTuningJobRequest, CallSettings)

public override Task<HyperparameterTuningJob> GetHyperparameterTuningJobAsync(GetHyperparameterTuningJobRequest request, CallSettings callSettings = null)

Gets a HyperparameterTuningJob

Parameters
Name Description
request GetHyperparameterTuningJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskHyperparameterTuningJob

A Task containing the RPC response.
Overrides

GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest, CallSettings)

public override ModelDeploymentMonitoringJob GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Gets a ModelDeploymentMonitoringJob.

Parameters
Name Description
request GetModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
ModelDeploymentMonitoringJob

The RPC response.
Overrides

GetModelDeploymentMonitoringJobAsync(GetModelDeploymentMonitoringJobRequest, CallSettings)

public override Task<ModelDeploymentMonitoringJob> GetModelDeploymentMonitoringJobAsync(GetModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Gets a ModelDeploymentMonitoringJob.

Parameters
Name Description
request GetModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskModelDeploymentMonitoringJob

A Task containing the RPC response.
Overrides

GetNasJob(GetNasJobRequest, CallSettings)

public override NasJob GetNasJob(GetNasJobRequest request, CallSettings callSettings = null)

Gets a NasJob

Parameters
Name Description
request GetNasJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
NasJob

The RPC response.
Overrides

GetNasJobAsync(GetNasJobRequest, CallSettings)

public override Task<NasJob> GetNasJobAsync(GetNasJobRequest request, CallSettings callSettings = null)

Gets a NasJob

Parameters
Name Description
request GetNasJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskNasJob

A Task containing the RPC response.
Overrides

GetNasTrialDetail(GetNasTrialDetailRequest, CallSettings)

public override NasTrialDetail GetNasTrialDetail(GetNasTrialDetailRequest request, CallSettings callSettings = null)

Gets a NasTrialDetail.

Parameters
Name Description
request GetNasTrialDetailRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
NasTrialDetail

The RPC response.
Overrides

GetNasTrialDetailAsync(GetNasTrialDetailRequest, CallSettings)

public override Task<NasTrialDetail> GetNasTrialDetailAsync(GetNasTrialDetailRequest request, CallSettings callSettings = null)

Gets a NasTrialDetail.

Parameters
Name Description
request GetNasTrialDetailRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskNasTrialDetail

A Task containing the RPC response.
Overrides

ListBatchPredictionJobs(ListBatchPredictionJobsRequest, CallSettings)

public override PagedEnumerable<ListBatchPredictionJobsResponse, BatchPredictionJob> ListBatchPredictionJobs(ListBatchPredictionJobsRequest request, CallSettings callSettings = null)

Lists BatchPredictionJobs in a Location.

Parameters
Name Description
request ListBatchPredictionJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListBatchPredictionJobsResponseBatchPredictionJob

A pageable sequence of BatchPredictionJob resources.
Overrides

ListBatchPredictionJobsAsync(ListBatchPredictionJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListBatchPredictionJobsResponse, BatchPredictionJob> ListBatchPredictionJobsAsync(ListBatchPredictionJobsRequest request, CallSettings callSettings = null)

Lists BatchPredictionJobs in a Location.

Parameters
Name Description
request ListBatchPredictionJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListBatchPredictionJobsResponseBatchPredictionJob

A pageable asynchronous sequence of BatchPredictionJob resources.
Overrides

ListCustomJobs(ListCustomJobsRequest, CallSettings)

public override PagedEnumerable<ListCustomJobsResponse, CustomJob> ListCustomJobs(ListCustomJobsRequest request, CallSettings callSettings = null)

Lists CustomJobs in a Location.

Parameters
Name Description
request ListCustomJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListCustomJobsResponseCustomJob

A pageable sequence of CustomJob resources.
Overrides

ListCustomJobsAsync(ListCustomJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListCustomJobsResponse, CustomJob> ListCustomJobsAsync(ListCustomJobsRequest request, CallSettings callSettings = null)

Lists CustomJobs in a Location.

Parameters
Name Description
request ListCustomJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListCustomJobsResponseCustomJob

A pageable asynchronous sequence of CustomJob resources.
Overrides

ListDataLabelingJobs(ListDataLabelingJobsRequest, CallSettings)

public override PagedEnumerable<ListDataLabelingJobsResponse, DataLabelingJob> ListDataLabelingJobs(ListDataLabelingJobsRequest request, CallSettings callSettings = null)

Lists DataLabelingJobs in a Location.

Parameters
Name Description
request ListDataLabelingJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListDataLabelingJobsResponseDataLabelingJob

A pageable sequence of DataLabelingJob resources.
Overrides

ListDataLabelingJobsAsync(ListDataLabelingJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataLabelingJobsResponse, DataLabelingJob> ListDataLabelingJobsAsync(ListDataLabelingJobsRequest request, CallSettings callSettings = null)

Lists DataLabelingJobs in a Location.

Parameters
Name Description
request ListDataLabelingJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListDataLabelingJobsResponseDataLabelingJob

A pageable asynchronous sequence of DataLabelingJob resources.
Overrides

ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest, CallSettings)

public override PagedEnumerable<ListHyperparameterTuningJobsResponse, HyperparameterTuningJob> ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request, CallSettings callSettings = null)

Lists HyperparameterTuningJobs in a Location.

Parameters
Name Description
request ListHyperparameterTuningJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListHyperparameterTuningJobsResponseHyperparameterTuningJob

A pageable sequence of HyperparameterTuningJob resources.
Overrides

ListHyperparameterTuningJobsAsync(ListHyperparameterTuningJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListHyperparameterTuningJobsResponse, HyperparameterTuningJob> ListHyperparameterTuningJobsAsync(ListHyperparameterTuningJobsRequest request, CallSettings callSettings = null)

Lists HyperparameterTuningJobs in a Location.

Parameters
Name Description
request ListHyperparameterTuningJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListHyperparameterTuningJobsResponseHyperparameterTuningJob

A pageable asynchronous sequence of HyperparameterTuningJob resources.
Overrides

ListModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest, CallSettings)

public override PagedEnumerable<ListModelDeploymentMonitoringJobsResponse, ModelDeploymentMonitoringJob> ListModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request, CallSettings callSettings = null)

Lists ModelDeploymentMonitoringJobs in a Location.

Parameters
Name Description
request ListModelDeploymentMonitoringJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListModelDeploymentMonitoringJobsResponseModelDeploymentMonitoringJob

A pageable sequence of ModelDeploymentMonitoringJob resources.
Overrides

ListModelDeploymentMonitoringJobsAsync(ListModelDeploymentMonitoringJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListModelDeploymentMonitoringJobsResponse, ModelDeploymentMonitoringJob> ListModelDeploymentMonitoringJobsAsync(ListModelDeploymentMonitoringJobsRequest request, CallSettings callSettings = null)

Lists ModelDeploymentMonitoringJobs in a Location.

Parameters
Name Description
request ListModelDeploymentMonitoringJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListModelDeploymentMonitoringJobsResponseModelDeploymentMonitoringJob

A pageable asynchronous sequence of ModelDeploymentMonitoringJob resources.
Overrides

ListNasJobs(ListNasJobsRequest, CallSettings)

public override PagedEnumerable<ListNasJobsResponse, NasJob> ListNasJobs(ListNasJobsRequest request, CallSettings callSettings = null)

Lists NasJobs in a Location.

Parameters
Name Description
request ListNasJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListNasJobsResponseNasJob

A pageable sequence of NasJob resources.
Overrides

ListNasJobsAsync(ListNasJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListNasJobsResponse, NasJob> ListNasJobsAsync(ListNasJobsRequest request, CallSettings callSettings = null)

Lists NasJobs in a Location.

Parameters
Name Description
request ListNasJobsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListNasJobsResponseNasJob

A pageable asynchronous sequence of NasJob resources.
Overrides

ListNasTrialDetails(ListNasTrialDetailsRequest, CallSettings)

public override PagedEnumerable<ListNasTrialDetailsResponse, NasTrialDetail> ListNasTrialDetails(ListNasTrialDetailsRequest request, CallSettings callSettings = null)

List top NasTrialDetails of a NasJob.

Parameters
Name Description
request ListNasTrialDetailsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListNasTrialDetailsResponseNasTrialDetail

A pageable sequence of NasTrialDetail resources.
Overrides

ListNasTrialDetailsAsync(ListNasTrialDetailsRequest, CallSettings)

public override PagedAsyncEnumerable<ListNasTrialDetailsResponse, NasTrialDetail> ListNasTrialDetailsAsync(ListNasTrialDetailsRequest request, CallSettings callSettings = null)

List top NasTrialDetails of a NasJob.

Parameters
Name Description
request ListNasTrialDetailsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListNasTrialDetailsResponseNasTrialDetail

A pageable asynchronous sequence of NasTrialDetail resources.
Overrides

PauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest, CallSettings)

public override void PauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.

Parameters
Name Description
request PauseModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Overrides

PauseModelDeploymentMonitoringJobAsync(PauseModelDeploymentMonitoringJobRequest, CallSettings)

public override Task PauseModelDeploymentMonitoringJobAsync(PauseModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.

Parameters
Name Description
request PauseModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

ResumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest, CallSettings)

public override void ResumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

Parameters
Name Description
request ResumeModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Overrides

ResumeModelDeploymentMonitoringJobAsync(ResumeModelDeploymentMonitoringJobRequest, CallSettings)

public override Task ResumeModelDeploymentMonitoringJobAsync(ResumeModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

Parameters
Name Description
request ResumeModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

SearchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest, CallSettings)

public override PagedEnumerable<SearchModelDeploymentMonitoringStatsAnomaliesResponse, ModelMonitoringStatsAnomalies> SearchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request, CallSettings callSettings = null)

Searches Model Monitoring Statistics generated within a given time window.

Parameters
Name Description
request SearchModelDeploymentMonitoringStatsAnomaliesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchModelDeploymentMonitoringStatsAnomaliesResponseModelMonitoringStatsAnomalies

A pageable sequence of ModelMonitoringStatsAnomalies resources.
Overrides

SearchModelDeploymentMonitoringStatsAnomaliesAsync(SearchModelDeploymentMonitoringStatsAnomaliesRequest, CallSettings)

public override PagedAsyncEnumerable<SearchModelDeploymentMonitoringStatsAnomaliesResponse, ModelMonitoringStatsAnomalies> SearchModelDeploymentMonitoringStatsAnomaliesAsync(SearchModelDeploymentMonitoringStatsAnomaliesRequest request, CallSettings callSettings = null)

Searches Model Monitoring Statistics generated within a given time window.

Parameters
Name Description
request SearchModelDeploymentMonitoringStatsAnomaliesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchModelDeploymentMonitoringStatsAnomaliesResponseModelMonitoringStatsAnomalies

A pageable asynchronous sequence of ModelMonitoringStatsAnomalies resources.
Overrides

UpdateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest, CallSettings)

public override Operation<ModelDeploymentMonitoringJob, UpdateModelDeploymentMonitoringJobOperationMetadata> UpdateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Updates a ModelDeploymentMonitoringJob.

Parameters
Name Description
request UpdateModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationModelDeploymentMonitoringJobUpdateModelDeploymentMonitoringJobOperationMetadata

The RPC response.
Overrides

UpdateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest, CallSettings)

public override Task<Operation<ModelDeploymentMonitoringJob, UpdateModelDeploymentMonitoringJobOperationMetadata>> UpdateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest request, CallSettings callSettings = null)

Updates a ModelDeploymentMonitoringJob.

Parameters
Name Description
request UpdateModelDeploymentMonitoringJobRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationModelDeploymentMonitoringJobUpdateModelDeploymentMonitoringJobOperationMetadata

A Task containing the RPC response.
Overrides