- 3.10.0 (latest)
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
[BindServiceMethod(typeof(JobService), "BindService")]
public abstract class JobService.JobServiceBase
Reference documentation and code samples for the Cloud AI Platform v1 API class JobService.JobServiceBase.
Base class for server-side implementations of JobService
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Methods
CancelBatchPredictionJob(CancelBatchPredictionJobRequest, ServerCallContext)
public virtual Task<Empty> CancelBatchPredictionJob(CancelBatchPredictionJobRequest request, ServerCallContext context)
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 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). |
CancelCustomJob(CancelCustomJobRequest, ServerCallContext)
public virtual Task<Empty> CancelCustomJob(CancelCustomJobRequest request, ServerCallContext context)
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 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). |
CancelDataLabelingJob(CancelDataLabelingJobRequest, ServerCallContext)
public virtual Task<Empty> CancelDataLabelingJob(CancelDataLabelingJobRequest request, ServerCallContext context)
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Parameters | |
---|---|
Name | Description |
request |
CancelDataLabelingJobRequest 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). |
CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest, ServerCallContext)
public virtual Task<Empty> CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request, ServerCallContext context)
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 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). |
CancelNasJob(CancelNasJobRequest, ServerCallContext)
public virtual Task<Empty> CancelNasJob(CancelNasJobRequest request, ServerCallContext context)
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 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). |
CreateBatchPredictionJob(CreateBatchPredictionJobRequest, ServerCallContext)
public virtual Task<BatchPredictionJob> CreateBatchPredictionJob(CreateBatchPredictionJobRequest request, ServerCallContext context)
Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
Parameters | |
---|---|
Name | Description |
request |
CreateBatchPredictionJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskBatchPredictionJob |
The response to send back to the client (wrapped by a task). |
CreateCustomJob(CreateCustomJobRequest, ServerCallContext)
public virtual Task<CustomJob> CreateCustomJob(CreateCustomJobRequest request, ServerCallContext context)
Creates a CustomJob. A created CustomJob right away will be attempted to be run.
Parameters | |
---|---|
Name | Description |
request |
CreateCustomJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskCustomJob |
The response to send back to the client (wrapped by a task). |
CreateDataLabelingJob(CreateDataLabelingJobRequest, ServerCallContext)
public virtual Task<DataLabelingJob> CreateDataLabelingJob(CreateDataLabelingJobRequest request, ServerCallContext context)
Creates a DataLabelingJob.
Parameters | |
---|---|
Name | Description |
request |
CreateDataLabelingJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskDataLabelingJob |
The response to send back to the client (wrapped by a task). |
CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest, ServerCallContext)
public virtual Task<HyperparameterTuningJob> CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request, ServerCallContext context)
Creates a HyperparameterTuningJob
Parameters | |
---|---|
Name | Description |
request |
CreateHyperparameterTuningJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskHyperparameterTuningJob |
The response to send back to the client (wrapped by a task). |
CreateModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest, ServerCallContext)
public virtual Task<ModelDeploymentMonitoringJob> CreateModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request, ServerCallContext context)
Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.
Parameters | |
---|---|
Name | Description |
request |
CreateModelDeploymentMonitoringJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskModelDeploymentMonitoringJob |
The response to send back to the client (wrapped by a task). |
CreateNasJob(CreateNasJobRequest, ServerCallContext)
public virtual Task<NasJob> CreateNasJob(CreateNasJobRequest request, ServerCallContext context)
Creates a NasJob
Parameters | |
---|---|
Name | Description |
request |
CreateNasJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskNasJob |
The response to send back to the client (wrapped by a task). |
DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest, ServerCallContext)
public virtual Task<Operation> DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest request, ServerCallContext context)
Deletes a BatchPredictionJob. Can only be called on jobs that already finished.
Parameters | |
---|---|
Name | Description |
request |
DeleteBatchPredictionJobRequest 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). |
DeleteCustomJob(DeleteCustomJobRequest, ServerCallContext)
public virtual Task<Operation> DeleteCustomJob(DeleteCustomJobRequest request, ServerCallContext context)
Deletes a CustomJob.
Parameters | |
---|---|
Name | Description |
request |
DeleteCustomJobRequest 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). |
DeleteDataLabelingJob(DeleteDataLabelingJobRequest, ServerCallContext)
public virtual Task<Operation> DeleteDataLabelingJob(DeleteDataLabelingJobRequest request, ServerCallContext context)
Deletes a DataLabelingJob.
Parameters | |
---|---|
Name | Description |
request |
DeleteDataLabelingJobRequest 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). |
DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest, ServerCallContext)
public virtual Task<Operation> DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request, ServerCallContext context)
Deletes a HyperparameterTuningJob.
Parameters | |
---|---|
Name | Description |
request |
DeleteHyperparameterTuningJobRequest 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). |
DeleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest, ServerCallContext)
public virtual Task<Operation> DeleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request, ServerCallContext context)
Deletes a ModelDeploymentMonitoringJob.
Parameters | |
---|---|
Name | Description |
request |
DeleteModelDeploymentMonitoringJobRequest 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). |
DeleteNasJob(DeleteNasJobRequest, ServerCallContext)
public virtual Task<Operation> DeleteNasJob(DeleteNasJobRequest request, ServerCallContext context)
Deletes a NasJob.
Parameters | |
---|---|
Name | Description |
request |
DeleteNasJobRequest 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). |
GetBatchPredictionJob(GetBatchPredictionJobRequest, ServerCallContext)
public virtual Task<BatchPredictionJob> GetBatchPredictionJob(GetBatchPredictionJobRequest request, ServerCallContext context)
Gets a BatchPredictionJob
Parameters | |
---|---|
Name | Description |
request |
GetBatchPredictionJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskBatchPredictionJob |
The response to send back to the client (wrapped by a task). |
GetCustomJob(GetCustomJobRequest, ServerCallContext)
public virtual Task<CustomJob> GetCustomJob(GetCustomJobRequest request, ServerCallContext context)
Gets a CustomJob.
Parameters | |
---|---|
Name | Description |
request |
GetCustomJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskCustomJob |
The response to send back to the client (wrapped by a task). |
GetDataLabelingJob(GetDataLabelingJobRequest, ServerCallContext)
public virtual Task<DataLabelingJob> GetDataLabelingJob(GetDataLabelingJobRequest request, ServerCallContext context)
Gets a DataLabelingJob.
Parameters | |
---|---|
Name | Description |
request |
GetDataLabelingJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskDataLabelingJob |
The response to send back to the client (wrapped by a task). |
GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest, ServerCallContext)
public virtual Task<HyperparameterTuningJob> GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest request, ServerCallContext context)
Gets a HyperparameterTuningJob
Parameters | |
---|---|
Name | Description |
request |
GetHyperparameterTuningJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskHyperparameterTuningJob |
The response to send back to the client (wrapped by a task). |
GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest, ServerCallContext)
public virtual Task<ModelDeploymentMonitoringJob> GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request, ServerCallContext context)
Gets a ModelDeploymentMonitoringJob.
Parameters | |
---|---|
Name | Description |
request |
GetModelDeploymentMonitoringJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskModelDeploymentMonitoringJob |
The response to send back to the client (wrapped by a task). |
GetNasJob(GetNasJobRequest, ServerCallContext)
public virtual Task<NasJob> GetNasJob(GetNasJobRequest request, ServerCallContext context)
Gets a NasJob
Parameters | |
---|---|
Name | Description |
request |
GetNasJobRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskNasJob |
The response to send back to the client (wrapped by a task). |
GetNasTrialDetail(GetNasTrialDetailRequest, ServerCallContext)
public virtual Task<NasTrialDetail> GetNasTrialDetail(GetNasTrialDetailRequest request, ServerCallContext context)
Gets a NasTrialDetail.
Parameters | |
---|---|
Name | Description |
request |
GetNasTrialDetailRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskNasTrialDetail |
The response to send back to the client (wrapped by a task). |
ListBatchPredictionJobs(ListBatchPredictionJobsRequest, ServerCallContext)
public virtual Task<ListBatchPredictionJobsResponse> ListBatchPredictionJobs(ListBatchPredictionJobsRequest request, ServerCallContext context)
Lists BatchPredictionJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
ListBatchPredictionJobsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListBatchPredictionJobsResponse |
The response to send back to the client (wrapped by a task). |
ListCustomJobs(ListCustomJobsRequest, ServerCallContext)
public virtual Task<ListCustomJobsResponse> ListCustomJobs(ListCustomJobsRequest request, ServerCallContext context)
Lists CustomJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
ListCustomJobsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListCustomJobsResponse |
The response to send back to the client (wrapped by a task). |
ListDataLabelingJobs(ListDataLabelingJobsRequest, ServerCallContext)
public virtual Task<ListDataLabelingJobsResponse> ListDataLabelingJobs(ListDataLabelingJobsRequest request, ServerCallContext context)
Lists DataLabelingJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
ListDataLabelingJobsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListDataLabelingJobsResponse |
The response to send back to the client (wrapped by a task). |
ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest, ServerCallContext)
public virtual Task<ListHyperparameterTuningJobsResponse> ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request, ServerCallContext context)
Lists HyperparameterTuningJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
ListHyperparameterTuningJobsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListHyperparameterTuningJobsResponse |
The response to send back to the client (wrapped by a task). |
ListModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest, ServerCallContext)
public virtual Task<ListModelDeploymentMonitoringJobsResponse> ListModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request, ServerCallContext context)
Lists ModelDeploymentMonitoringJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
ListModelDeploymentMonitoringJobsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListModelDeploymentMonitoringJobsResponse |
The response to send back to the client (wrapped by a task). |
ListNasJobs(ListNasJobsRequest, ServerCallContext)
public virtual Task<ListNasJobsResponse> ListNasJobs(ListNasJobsRequest request, ServerCallContext context)
Lists NasJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
ListNasJobsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListNasJobsResponse |
The response to send back to the client (wrapped by a task). |
ListNasTrialDetails(ListNasTrialDetailsRequest, ServerCallContext)
public virtual Task<ListNasTrialDetailsResponse> ListNasTrialDetails(ListNasTrialDetailsRequest request, ServerCallContext context)
List top NasTrialDetails of a NasJob.
Parameters | |
---|---|
Name | Description |
request |
ListNasTrialDetailsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListNasTrialDetailsResponse |
The response to send back to the client (wrapped by a task). |
PauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest, ServerCallContext)
public virtual Task<Empty> PauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request, ServerCallContext context)
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 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). |
ResumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest, ServerCallContext)
public virtual Task<Empty> ResumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request, ServerCallContext context)
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 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). |
SearchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest, ServerCallContext)
public virtual Task<SearchModelDeploymentMonitoringStatsAnomaliesResponse> SearchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request, ServerCallContext context)
Searches Model Monitoring Statistics generated within a given time window.
Parameters | |
---|---|
Name | Description |
request |
SearchModelDeploymentMonitoringStatsAnomaliesRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskSearchModelDeploymentMonitoringStatsAnomaliesResponse |
The response to send back to the client (wrapped by a task). |
UpdateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest, ServerCallContext)
public virtual Task<Operation> UpdateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request, ServerCallContext context)
Updates a ModelDeploymentMonitoringJob.
Parameters | |
---|---|
Name | Description |
request |
UpdateModelDeploymentMonitoringJobRequest 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). |