- 3.18.0 (latest)
- 3.17.0
- 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 abstract class JobServiceClient
JobService client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Remarks
A service for creating and managing Vertex AI's jobs.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the JobService service, which is a host of "aiplatform.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
String |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default JobService scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyList<String> |
The default JobService scopes are:
DeleteBatchPredictionJobOperationsClient
public virtual OperationsClient DeleteBatchPredictionJobOperationsClient { get; }
The long-running operations client for DeleteBatchPredictionJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteCustomJobOperationsClient
public virtual OperationsClient DeleteCustomJobOperationsClient { get; }
The long-running operations client for DeleteCustomJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteDataLabelingJobOperationsClient
public virtual OperationsClient DeleteDataLabelingJobOperationsClient { get; }
The long-running operations client for DeleteDataLabelingJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteHyperparameterTuningJobOperationsClient
public virtual OperationsClient DeleteHyperparameterTuningJobOperationsClient { get; }
The long-running operations client for DeleteHyperparameterTuningJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteModelDeploymentMonitoringJobOperationsClient
public virtual OperationsClient DeleteModelDeploymentMonitoringJobOperationsClient { get; }
The long-running operations client for DeleteModelDeploymentMonitoringJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public virtual JobService.JobServiceClient GrpcClient { get; }
The underlying gRPC JobService client
Property Value | |
---|---|
Type | Description |
JobService.JobServiceClient |
UpdateModelDeploymentMonitoringJobOperationsClient
public virtual OperationsClient UpdateModelDeploymentMonitoringJobOperationsClient { get; }
The long-running operations client for UpdateModelDeploymentMonitoringJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
CancelBatchPredictionJob(BatchPredictionJobName, CallSettings)
public virtual void CancelBatchPredictionJob(BatchPredictionJobName name, 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 |
name | BatchPredictionJobName Required. The name of the BatchPredictionJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
BatchPredictionJobName name = BatchPredictionJobName.FromProjectLocationBatchPredictionJob("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]");
// Make the request
jobServiceClient.CancelBatchPredictionJob(name);
CancelBatchPredictionJob(CancelBatchPredictionJobRequest, CallSettings)
public virtual 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. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
CancelBatchPredictionJobRequest request = new CancelBatchPredictionJobRequest
{
BatchPredictionJobName = BatchPredictionJobName.FromProjectLocationBatchPredictionJob("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]"),
};
// Make the request
jobServiceClient.CancelBatchPredictionJob(request);
CancelBatchPredictionJob(String, CallSettings)
public virtual void CancelBatchPredictionJob(string name, 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 |
name | String Required. The name of the BatchPredictionJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/batchPredictionJobs/[BATCH_PREDICTION_JOB]";
// Make the request
jobServiceClient.CancelBatchPredictionJob(name);
CancelBatchPredictionJobAsync(BatchPredictionJobName, CallSettings)
public virtual Task CancelBatchPredictionJobAsync(BatchPredictionJobName name, 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 |
name | BatchPredictionJobName Required. The name of the BatchPredictionJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
BatchPredictionJobName name = BatchPredictionJobName.FromProjectLocationBatchPredictionJob("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]");
// Make the request
await jobServiceClient.CancelBatchPredictionJobAsync(name);
CancelBatchPredictionJobAsync(BatchPredictionJobName, CancellationToken)
public virtual Task CancelBatchPredictionJobAsync(BatchPredictionJobName name, CancellationToken cancellationToken)
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 |
name | BatchPredictionJobName Required. The name of the BatchPredictionJob to cancel.
Format:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
BatchPredictionJobName name = BatchPredictionJobName.FromProjectLocationBatchPredictionJob("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]");
// Make the request
await jobServiceClient.CancelBatchPredictionJobAsync(name);
CancelBatchPredictionJobAsync(CancelBatchPredictionJobRequest, CallSettings)
public virtual 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. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
CancelBatchPredictionJobRequest request = new CancelBatchPredictionJobRequest
{
BatchPredictionJobName = BatchPredictionJobName.FromProjectLocationBatchPredictionJob("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]"),
};
// Make the request
await jobServiceClient.CancelBatchPredictionJobAsync(request);
CancelBatchPredictionJobAsync(CancelBatchPredictionJobRequest, CancellationToken)
public virtual Task CancelBatchPredictionJobAsync(CancelBatchPredictionJobRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
CancelBatchPredictionJobRequest request = new CancelBatchPredictionJobRequest
{
BatchPredictionJobName = BatchPredictionJobName.FromProjectLocationBatchPredictionJob("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]"),
};
// Make the request
await jobServiceClient.CancelBatchPredictionJobAsync(request);
CancelBatchPredictionJobAsync(String, CallSettings)
public virtual Task CancelBatchPredictionJobAsync(string name, 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 |
name | String Required. The name of the BatchPredictionJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/batchPredictionJobs/[BATCH_PREDICTION_JOB]";
// Make the request
await jobServiceClient.CancelBatchPredictionJobAsync(name);
CancelBatchPredictionJobAsync(String, CancellationToken)
public virtual Task CancelBatchPredictionJobAsync(string name, CancellationToken cancellationToken)
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 |
name | String Required. The name of the BatchPredictionJob to cancel.
Format:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/batchPredictionJobs/[BATCH_PREDICTION_JOB]";
// Make the request
await jobServiceClient.CancelBatchPredictionJobAsync(name);
CancelCustomJob(CancelCustomJobRequest, CallSettings)
public virtual 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. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
CancelCustomJobRequest request = new CancelCustomJobRequest
{
CustomJobName = CustomJobName.FromProjectLocationCustomJob("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]"),
};
// Make the request
jobServiceClient.CancelCustomJob(request);
CancelCustomJob(CustomJobName, CallSettings)
public virtual void CancelCustomJob(CustomJobName name, 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 |
name | CustomJobName Required. The name of the CustomJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
CustomJobName name = CustomJobName.FromProjectLocationCustomJob("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]");
// Make the request
jobServiceClient.CancelCustomJob(name);
CancelCustomJob(String, CallSettings)
public virtual void CancelCustomJob(string name, 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 |
name | String Required. The name of the CustomJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/customJobs/[CUSTOM_JOB]";
// Make the request
jobServiceClient.CancelCustomJob(name);
CancelCustomJobAsync(CancelCustomJobRequest, CallSettings)
public virtual 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. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
CancelCustomJobRequest request = new CancelCustomJobRequest
{
CustomJobName = CustomJobName.FromProjectLocationCustomJob("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]"),
};
// Make the request
await jobServiceClient.CancelCustomJobAsync(request);
CancelCustomJobAsync(CancelCustomJobRequest, CancellationToken)
public virtual Task CancelCustomJobAsync(CancelCustomJobRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
CancelCustomJobRequest request = new CancelCustomJobRequest
{
CustomJobName = CustomJobName.FromProjectLocationCustomJob("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]"),
};
// Make the request
await jobServiceClient.CancelCustomJobAsync(request);
CancelCustomJobAsync(CustomJobName, CallSettings)
public virtual Task CancelCustomJobAsync(CustomJobName name, 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 |
name | CustomJobName Required. The name of the CustomJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
CustomJobName name = CustomJobName.FromProjectLocationCustomJob("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]");
// Make the request
await jobServiceClient.CancelCustomJobAsync(name);
CancelCustomJobAsync(CustomJobName, CancellationToken)
public virtual Task CancelCustomJobAsync(CustomJobName name, CancellationToken cancellationToken)
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 |
name | CustomJobName Required. The name of the CustomJob to cancel.
Format:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
CustomJobName name = CustomJobName.FromProjectLocationCustomJob("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]");
// Make the request
await jobServiceClient.CancelCustomJobAsync(name);
CancelCustomJobAsync(String, CallSettings)
public virtual Task CancelCustomJobAsync(string name, 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 |
name | String Required. The name of the CustomJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/customJobs/[CUSTOM_JOB]";
// Make the request
await jobServiceClient.CancelCustomJobAsync(name);
CancelCustomJobAsync(String, CancellationToken)
public virtual Task CancelCustomJobAsync(string name, CancellationToken cancellationToken)
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 |
name | String Required. The name of the CustomJob to cancel.
Format:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/customJobs/[CUSTOM_JOB]";
// Make the request
await jobServiceClient.CancelCustomJobAsync(name);
CancelDataLabelingJob(CancelDataLabelingJobRequest, CallSettings)
public virtual 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. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
CancelDataLabelingJobRequest request = new CancelDataLabelingJobRequest
{
DataLabelingJobName = DataLabelingJobName.FromProjectLocationDataLabelingJob("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]"),
};
// Make the request
jobServiceClient.CancelDataLabelingJob(request);
CancelDataLabelingJob(DataLabelingJobName, CallSettings)
public virtual void CancelDataLabelingJob(DataLabelingJobName name, CallSettings callSettings = null)
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Parameters | |
---|---|
Name | Description |
name | DataLabelingJobName Required. The name of the DataLabelingJob.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
DataLabelingJobName name = DataLabelingJobName.FromProjectLocationDataLabelingJob("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]");
// Make the request
jobServiceClient.CancelDataLabelingJob(name);
CancelDataLabelingJob(String, CallSettings)
public virtual void CancelDataLabelingJob(string name, CallSettings callSettings = null)
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Parameters | |
---|---|
Name | Description |
name | String Required. The name of the DataLabelingJob.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataLabelingJobs/[DATA_LABELING_JOB]";
// Make the request
jobServiceClient.CancelDataLabelingJob(name);
CancelDataLabelingJobAsync(CancelDataLabelingJobRequest, CallSettings)
public virtual 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. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
CancelDataLabelingJobRequest request = new CancelDataLabelingJobRequest
{
DataLabelingJobName = DataLabelingJobName.FromProjectLocationDataLabelingJob("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]"),
};
// Make the request
await jobServiceClient.CancelDataLabelingJobAsync(request);
CancelDataLabelingJobAsync(CancelDataLabelingJobRequest, CancellationToken)
public virtual Task CancelDataLabelingJobAsync(CancelDataLabelingJobRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
CancelDataLabelingJobRequest request = new CancelDataLabelingJobRequest
{
DataLabelingJobName = DataLabelingJobName.FromProjectLocationDataLabelingJob("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]"),
};
// Make the request
await jobServiceClient.CancelDataLabelingJobAsync(request);
CancelDataLabelingJobAsync(DataLabelingJobName, CallSettings)
public virtual Task CancelDataLabelingJobAsync(DataLabelingJobName name, CallSettings callSettings = null)
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Parameters | |
---|---|
Name | Description |
name | DataLabelingJobName Required. The name of the DataLabelingJob.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
DataLabelingJobName name = DataLabelingJobName.FromProjectLocationDataLabelingJob("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]");
// Make the request
await jobServiceClient.CancelDataLabelingJobAsync(name);
CancelDataLabelingJobAsync(DataLabelingJobName, CancellationToken)
public virtual Task CancelDataLabelingJobAsync(DataLabelingJobName name, CancellationToken cancellationToken)
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Parameters | |
---|---|
Name | Description |
name | DataLabelingJobName Required. The name of the DataLabelingJob.
Format:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
DataLabelingJobName name = DataLabelingJobName.FromProjectLocationDataLabelingJob("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]");
// Make the request
await jobServiceClient.CancelDataLabelingJobAsync(name);
CancelDataLabelingJobAsync(String, CallSettings)
public virtual Task CancelDataLabelingJobAsync(string name, CallSettings callSettings = null)
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Parameters | |
---|---|
Name | Description |
name | String Required. The name of the DataLabelingJob.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataLabelingJobs/[DATA_LABELING_JOB]";
// Make the request
await jobServiceClient.CancelDataLabelingJobAsync(name);
CancelDataLabelingJobAsync(String, CancellationToken)
public virtual Task CancelDataLabelingJobAsync(string name, CancellationToken cancellationToken)
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Parameters | |
---|---|
Name | Description |
name | String Required. The name of the DataLabelingJob.
Format:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataLabelingJobs/[DATA_LABELING_JOB]";
// Make the request
await jobServiceClient.CancelDataLabelingJobAsync(name);
CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest, CallSettings)
public virtual 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. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
CancelHyperparameterTuningJobRequest request = new CancelHyperparameterTuningJobRequest
{
HyperparameterTuningJobName = HyperparameterTuningJobName.FromProjectLocationHyperparameterTuningJob("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]"),
};
// Make the request
jobServiceClient.CancelHyperparameterTuningJob(request);
CancelHyperparameterTuningJob(HyperparameterTuningJobName, CallSettings)
public virtual void CancelHyperparameterTuningJob(HyperparameterTuningJobName name, 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 |
name | HyperparameterTuningJobName Required. The name of the HyperparameterTuningJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
HyperparameterTuningJobName name = HyperparameterTuningJobName.FromProjectLocationHyperparameterTuningJob("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]");
// Make the request
jobServiceClient.CancelHyperparameterTuningJob(name);
CancelHyperparameterTuningJob(String, CallSettings)
public virtual void CancelHyperparameterTuningJob(string name, 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 |
name | String Required. The name of the HyperparameterTuningJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/hyperparameterTuningJobs/[HYPERPARAMETER_TUNING_JOB]";
// Make the request
jobServiceClient.CancelHyperparameterTuningJob(name);
CancelHyperparameterTuningJobAsync(CancelHyperparameterTuningJobRequest, CallSettings)
public virtual 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. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
CancelHyperparameterTuningJobRequest request = new CancelHyperparameterTuningJobRequest
{
HyperparameterTuningJobName = HyperparameterTuningJobName.FromProjectLocationHyperparameterTuningJob("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]"),
};
// Make the request
await jobServiceClient.CancelHyperparameterTuningJobAsync(request);
CancelHyperparameterTuningJobAsync(CancelHyperparameterTuningJobRequest, CancellationToken)
public virtual Task CancelHyperparameterTuningJobAsync(CancelHyperparameterTuningJobRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
CancelHyperparameterTuningJobRequest request = new CancelHyperparameterTuningJobRequest
{
HyperparameterTuningJobName = HyperparameterTuningJobName.FromProjectLocationHyperparameterTuningJob("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]"),
};
// Make the request
await jobServiceClient.CancelHyperparameterTuningJobAsync(request);
CancelHyperparameterTuningJobAsync(HyperparameterTuningJobName, CallSettings)
public virtual Task CancelHyperparameterTuningJobAsync(HyperparameterTuningJobName name, 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 |
name | HyperparameterTuningJobName Required. The name of the HyperparameterTuningJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
HyperparameterTuningJobName name = HyperparameterTuningJobName.FromProjectLocationHyperparameterTuningJob("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]");
// Make the request
await jobServiceClient.CancelHyperparameterTuningJobAsync(name);
CancelHyperparameterTuningJobAsync(HyperparameterTuningJobName, CancellationToken)
public virtual Task CancelHyperparameterTuningJobAsync(HyperparameterTuningJobName name, CancellationToken cancellationToken)
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 |
name | HyperparameterTuningJobName Required. The name of the HyperparameterTuningJob to cancel.
Format:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
HyperparameterTuningJobName name = HyperparameterTuningJobName.FromProjectLocationHyperparameterTuningJob("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]");
// Make the request
await jobServiceClient.CancelHyperparameterTuningJobAsync(name);
CancelHyperparameterTuningJobAsync(String, CallSettings)
public virtual Task CancelHyperparameterTuningJobAsync(string name, 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 |
name | String Required. The name of the HyperparameterTuningJob to cancel.
Format:
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/hyperparameterTuningJobs/[HYPERPARAMETER_TUNING_JOB]";
// Make the request
await jobServiceClient.CancelHyperparameterTuningJobAsync(name);
CancelHyperparameterTuningJobAsync(String, CancellationToken)
public virtual Task CancelHyperparameterTuningJobAsync(string name, CancellationToken cancellationToken)
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 |
name | String Required. The name of the HyperparameterTuningJob to cancel.
Format:
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/hyperparameterTuningJobs/[HYPERPARAMETER_TUNING_JOB]";
// Make the request
await jobServiceClient.CancelHyperparameterTuningJobAsync(name);
Create()
public static JobServiceClient Create()
Synchronously creates a JobServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use JobServiceClientBuilder.
Returns | |
---|---|
Type | Description |
JobServiceClient | The created JobServiceClient. |
CreateAsync(CancellationToken)
public static Task<JobServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a JobServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use JobServiceClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
Task<JobServiceClient> | The task representing the created JobServiceClient. |
CreateBatchPredictionJob(LocationName, BatchPredictionJob, CallSettings)
public virtual BatchPredictionJob CreateBatchPredictionJob(LocationName parent, BatchPredictionJob batchPredictionJob, CallSettings callSettings = null)
Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the BatchPredictionJob in.
Format: |
batchPredictionJob | BatchPredictionJob Required. The BatchPredictionJob to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
BatchPredictionJob | The RPC response. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
BatchPredictionJob batchPredictionJob = new BatchPredictionJob();
// Make the request
BatchPredictionJob response = jobServiceClient.CreateBatchPredictionJob(parent, batchPredictionJob);
CreateBatchPredictionJob(CreateBatchPredictionJobRequest, CallSettings)
public virtual 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. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
CreateBatchPredictionJobRequest request = new CreateBatchPredictionJobRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
BatchPredictionJob = new BatchPredictionJob(),
};
// Make the request
BatchPredictionJob response = jobServiceClient.CreateBatchPredictionJob(request);
CreateBatchPredictionJob(String, BatchPredictionJob, CallSettings)
public virtual BatchPredictionJob CreateBatchPredictionJob(string parent, BatchPredictionJob batchPredictionJob, CallSettings callSettings = null)
Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
Parameters | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to create the BatchPredictionJob in.
Format: |
batchPredictionJob | BatchPredictionJob Required. The BatchPredictionJob to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
BatchPredictionJob | The RPC response. |
// Create client
JobServiceClient jobServiceClient = JobServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
BatchPredictionJob batchPredictionJob = new BatchPredictionJob();
// Make the request
BatchPredictionJob response = jobServiceClient.CreateBatchPredictionJob(parent, batchPredictionJob);
CreateBatchPredictionJobAsync(LocationName, BatchPredictionJob, CallSettings)
public virtual Task<BatchPredictionJob> CreateBatchPredictionJobAsync(LocationName parent, BatchPredictionJob batchPredictionJob, CallSettings callSettings = null)
Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the BatchPredictionJob in.
Format: |
batchPredictionJob | BatchPredictionJob Required. The BatchPredictionJob to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<BatchPredictionJob> | A Task containing the RPC response. |
// Create client
JobServiceClient jobServiceClient = await JobServiceClient.CreateAsync();
// Initialize request argum