- 3.17.0 (latest)
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 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
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.
Namespace
Google.Cloud.AIPlatform.V1Assembly
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 | |
---|---|
Name | Description |
grpcClient | JobService.JobServiceClient 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 |
DeleteCustomJobOperationsClient
public override OperationsClient DeleteCustomJobOperationsClient { get; }
The long-running operations client for DeleteCustomJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteDataLabelingJobOperationsClient
public override OperationsClient DeleteDataLabelingJobOperationsClient { get; }
The long-running operations client for DeleteDataLabelingJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteHyperparameterTuningJobOperationsClient
public override OperationsClient DeleteHyperparameterTuningJobOperationsClient { get; }
The long-running operations client for DeleteHyperparameterTuningJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteModelDeploymentMonitoringJobOperationsClient
public override OperationsClient DeleteModelDeploymentMonitoringJobOperationsClient { get; }
The long-running operations client for DeleteModelDeploymentMonitoringJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override JobService.JobServiceClient GrpcClient { get; }
The underlying gRPC JobService client
Property Value | |
---|---|
Type | Description |
JobService.JobServiceClient |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }
The IAMPolicyClient associated with this client.
Property Value | |
---|---|
Type | Description |
IAMPolicyClient |
LocationsClient
public override LocationsClient LocationsClient { get; }
The LocationsClient associated with this client.
Property Value | |
---|---|
Type | Description |
LocationsClient |
UpdateModelDeploymentMonitoringJobOperationsClient
public override OperationsClient UpdateModelDeploymentMonitoringJobOperationsClient { get; }
The long-running operations client for UpdateModelDeploymentMonitoringJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |