A service for creating and managing Vertex AI's jobs.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
JobServiceClient(JobServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
JobServiceClient const &
|
JobServiceClient(JobServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
JobServiceClient &&
|
JobServiceClient(std::shared_ptr< JobServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< JobServiceConnection >
|
opts |
Options
|
Operators
operator=(JobServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
JobServiceClient const &
|
Returns | |
---|---|
Type | Description |
JobServiceClient & |
operator=(JobServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
JobServiceClient &&
|
Returns | |
---|---|
Type | Description |
JobServiceClient & |
Functions
CreateCustomJob(std::string const &, google::cloud::aiplatform::v1::CustomJob const &, Options)
Creates a CustomJob.
A created CustomJob right away will be attempted to be run.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create the CustomJob in. Format: |
custom_job |
google::cloud::aiplatform::v1::CustomJob const &
Required. The CustomJob to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::CustomJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.CustomJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateCustomJob(google::cloud::aiplatform::v1::CreateCustomJobRequest const &, Options)
Creates a CustomJob.
A created CustomJob right away will be attempted to be run.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateCustomJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::CustomJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.CustomJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCustomJob(std::string const &, Options)
Gets a CustomJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the CustomJob resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::CustomJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.CustomJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCustomJob(google::cloud::aiplatform::v1::GetCustomJobRequest const &, Options)
Gets a CustomJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetCustomJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::CustomJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.CustomJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListCustomJobs(std::string const &, Options)
Lists CustomJobs in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list the CustomJobs from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::CustomJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCustomJobs(google::cloud::aiplatform::v1::ListCustomJobsRequest, Options)
Lists CustomJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListCustomJobsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::CustomJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteCustomJob(std::string const &, Options)
Deletes a CustomJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the CustomJob resource to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteCustomJob(google::cloud::aiplatform::v1::DeleteCustomJobRequest const &, Options)
Deletes a CustomJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteCustomJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
CancelCustomJob(std::string const &, Options)
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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and CustomJob.state is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the CustomJob to cancel. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelCustomJob(google::cloud::aiplatform::v1::CancelCustomJobRequest const &, Options)
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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and CustomJob.state is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CancelCustomJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CreateDataLabelingJob(std::string const &, google::cloud::aiplatform::v1::DataLabelingJob const &, Options)
Creates a DataLabelingJob.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent of the DataLabelingJob. Format: |
data_labeling_job |
google::cloud::aiplatform::v1::DataLabelingJob const &
Required. The DataLabelingJob to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::DataLabelingJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.DataLabelingJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateDataLabelingJob(google::cloud::aiplatform::v1::CreateDataLabelingJobRequest const &, Options)
Creates a DataLabelingJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateDataLabelingJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::DataLabelingJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.DataLabelingJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDataLabelingJob(std::string const &, Options)
Gets a DataLabelingJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the DataLabelingJob. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::DataLabelingJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.DataLabelingJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDataLabelingJob(google::cloud::aiplatform::v1::GetDataLabelingJobRequest const &, Options)
Gets a DataLabelingJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetDataLabelingJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::DataLabelingJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.DataLabelingJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListDataLabelingJobs(std::string const &, Options)
Lists DataLabelingJobs in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent of the DataLabelingJob. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::DataLabelingJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDataLabelingJobs(google::cloud::aiplatform::v1::ListDataLabelingJobsRequest, Options)
Lists DataLabelingJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListDataLabelingJobsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::DataLabelingJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteDataLabelingJob(std::string const &, Options)
Deletes a DataLabelingJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the DataLabelingJob to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteDataLabelingJob(google::cloud::aiplatform::v1::DeleteDataLabelingJobRequest const &, Options)
Deletes a DataLabelingJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteDataLabelingJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
CancelDataLabelingJob(std::string const &, Options)
Cancels a DataLabelingJob.
Success of cancellation is not guaranteed.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the DataLabelingJob. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelDataLabelingJob(google::cloud::aiplatform::v1::CancelDataLabelingJobRequest const &, Options)
Cancels a DataLabelingJob.
Success of cancellation is not guaranteed.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CancelDataLabelingJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CreateHyperparameterTuningJob(std::string const &, google::cloud::aiplatform::v1::HyperparameterTuningJob const &, Options)
Creates a HyperparameterTuningJob.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: |
hyperparameter_tuning_job |
google::cloud::aiplatform::v1::HyperparameterTuningJob const &
Required. The HyperparameterTuningJob to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::HyperparameterTuningJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.HyperparameterTuningJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateHyperparameterTuningJob(google::cloud::aiplatform::v1::CreateHyperparameterTuningJobRequest const &, Options)
Creates a HyperparameterTuningJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateHyperparameterTuningJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::HyperparameterTuningJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.HyperparameterTuningJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetHyperparameterTuningJob(std::string const &, Options)
Gets a HyperparameterTuningJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the HyperparameterTuningJob resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::HyperparameterTuningJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.HyperparameterTuningJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetHyperparameterTuningJob(google::cloud::aiplatform::v1::GetHyperparameterTuningJobRequest const &, Options)
Gets a HyperparameterTuningJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetHyperparameterTuningJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::HyperparameterTuningJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.HyperparameterTuningJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListHyperparameterTuningJobs(std::string const &, Options)
Lists HyperparameterTuningJobs in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::HyperparameterTuningJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListHyperparameterTuningJobs(google::cloud::aiplatform::v1::ListHyperparameterTuningJobsRequest, Options)
Lists HyperparameterTuningJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListHyperparameterTuningJobsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::HyperparameterTuningJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteHyperparameterTuningJob(std::string const &, Options)
Deletes a HyperparameterTuningJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the HyperparameterTuningJob resource to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteHyperparameterTuningJob(google::cloud::aiplatform::v1::DeleteHyperparameterTuningJobRequest const &, Options)
Deletes a HyperparameterTuningJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteHyperparameterTuningJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
CancelHyperparameterTuningJob(std::string const &, Options)
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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and HyperparameterTuningJob.state is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the HyperparameterTuningJob to cancel. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelHyperparameterTuningJob(google::cloud::aiplatform::v1::CancelHyperparameterTuningJobRequest const &, Options)
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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and HyperparameterTuningJob.state is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CancelHyperparameterTuningJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CreateNasJob(std::string const &, google::cloud::aiplatform::v1::NasJob const &, Options)
Creates a NasJob.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create the NasJob in. Format: |
nas_job |
google::cloud::aiplatform::v1::NasJob const &
Required. The NasJob to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::NasJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.NasJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateNasJob(google::cloud::aiplatform::v1::CreateNasJobRequest const &, Options)
Creates a NasJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateNasJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::NasJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.NasJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetNasJob(std::string const &, Options)
Gets a NasJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the NasJob resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::NasJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.NasJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetNasJob(google::cloud::aiplatform::v1::GetNasJobRequest const &, Options)
Gets a NasJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetNasJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::NasJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.NasJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListNasJobs(std::string const &, Options)
Lists NasJobs in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list the NasJobs from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::NasJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListNasJobs(google::cloud::aiplatform::v1::ListNasJobsRequest, Options)
Lists NasJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListNasJobsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::NasJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteNasJob(std::string const &, Options)
Deletes a NasJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the NasJob resource to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteNasJob(google::cloud::aiplatform::v1::DeleteNasJobRequest const &, Options)
Deletes a NasJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteNasJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
CancelNasJob(std::string const &, Options)
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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and NasJob.state is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the NasJob to cancel. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelNasJob(google::cloud::aiplatform::v1::CancelNasJobRequest const &, Options)
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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and NasJob.state is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CancelNasJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
GetNasTrialDetail(std::string const &, Options)
Gets a NasTrialDetail.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the NasTrialDetail resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::NasTrialDetail > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.NasTrialDetail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetNasTrialDetail(google::cloud::aiplatform::v1::GetNasTrialDetailRequest const &, Options)
Gets a NasTrialDetail.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetNasTrialDetailRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::NasTrialDetail > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.NasTrialDetail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListNasTrialDetails(std::string const &, Options)
List top NasTrialDetails of a NasJob.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of the NasJob resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::NasTrialDetail > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListNasTrialDetails(google::cloud::aiplatform::v1::ListNasTrialDetailsRequest, Options)
List top NasTrialDetails of a NasJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListNasTrialDetailsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::NasTrialDetail > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateBatchPredictionJob(std::string const &, google::cloud::aiplatform::v1::BatchPredictionJob const &, Options)
Creates a BatchPredictionJob.
A BatchPredictionJob once created will right away be attempted to start.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create the BatchPredictionJob in. Format: |
batch_prediction_job |
google::cloud::aiplatform::v1::BatchPredictionJob const &
Required. The BatchPredictionJob to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::BatchPredictionJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.BatchPredictionJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateBatchPredictionJob(google::cloud::aiplatform::v1::CreateBatchPredictionJobRequest const &, Options)
Creates a BatchPredictionJob.
A BatchPredictionJob once created will right away be attempted to start.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateBatchPredictionJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::BatchPredictionJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.BatchPredictionJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBatchPredictionJob(std::string const &, Options)
Gets a BatchPredictionJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the BatchPredictionJob resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::BatchPredictionJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.BatchPredictionJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBatchPredictionJob(google::cloud::aiplatform::v1::GetBatchPredictionJobRequest const &, Options)
Gets a BatchPredictionJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetBatchPredictionJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::BatchPredictionJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.BatchPredictionJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListBatchPredictionJobs(std::string const &, Options)
Lists BatchPredictionJobs in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list the BatchPredictionJobs from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::BatchPredictionJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBatchPredictionJobs(google::cloud::aiplatform::v1::ListBatchPredictionJobsRequest, Options)
Lists BatchPredictionJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListBatchPredictionJobsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::BatchPredictionJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteBatchPredictionJob(std::string const &, Options)
Deletes a BatchPredictionJob.
Can only be called on jobs that already finished.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the BatchPredictionJob resource to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteBatchPredictionJob(google::cloud::aiplatform::v1::DeleteBatchPredictionJobRequest const &, Options)
Deletes a BatchPredictionJob.
Can only be called on jobs that already finished.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteBatchPredictionJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
CancelBatchPredictionJob(std::string const &, Options)
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 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 is set to CANCELLED
. Any files already outputted by the job are not deleted.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the BatchPredictionJob to cancel. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelBatchPredictionJob(google::cloud::aiplatform::v1::CancelBatchPredictionJobRequest const &, Options)
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 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 is set to CANCELLED
. Any files already outputted by the job are not deleted.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CancelBatchPredictionJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CreateModelDeploymentMonitoringJob(std::string const &, google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob const &, Options)
Creates a ModelDeploymentMonitoringJob.
It will run periodically on a configured interval.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent of the ModelDeploymentMonitoringJob. Format: |
model_deployment_monitoring_job |
google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob const &
Required. The ModelDeploymentMonitoringJob to create |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateModelDeploymentMonitoringJob(google::cloud::aiplatform::v1::CreateModelDeploymentMonitoringJobRequest const &, Options)
Creates a ModelDeploymentMonitoringJob.
It will run periodically on a configured interval.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateModelDeploymentMonitoringJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SearchModelDeploymentMonitoringStatsAnomalies(std::string const &, std::string const &, Options)
Searches Model Monitoring Statistics generated within a given time window.
Parameters | |
---|---|
Name | Description |
model_deployment_monitoring_job |
std::string const &
Required. ModelDeploymentMonitoring Job resource name. Format: |
deployed_model_id |
std::string const &
Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::ModelMonitoringStatsAnomalies > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchModelDeploymentMonitoringStatsAnomalies(google::cloud::aiplatform::v1::SearchModelDeploymentMonitoringStatsAnomaliesRequest, Options)
Searches Model Monitoring Statistics generated within a given time window.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::SearchModelDeploymentMonitoringStatsAnomaliesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::ModelMonitoringStatsAnomalies > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetModelDeploymentMonitoringJob(std::string const &, Options)
Gets a ModelDeploymentMonitoringJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the ModelDeploymentMonitoringJob. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetModelDeploymentMonitoringJob(google::cloud::aiplatform::v1::GetModelDeploymentMonitoringJobRequest const &, Options)
Gets a ModelDeploymentMonitoringJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetModelDeploymentMonitoringJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListModelDeploymentMonitoringJobs(std::string const &, Options)
Lists ModelDeploymentMonitoringJobs in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent of the ModelDeploymentMonitoringJob. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListModelDeploymentMonitoringJobs(google::cloud::aiplatform::v1::ListModelDeploymentMonitoringJobsRequest, Options)
Lists ModelDeploymentMonitoringJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListModelDeploymentMonitoringJobsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateModelDeploymentMonitoringJob(google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob const &, google::protobuf::FieldMask const &, Options)
Updates a ModelDeploymentMonitoringJob.
Parameters | |
---|---|
Name | Description |
model_deployment_monitoring_job |
google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob const &
Required. The model monitoring configuration which replaces the resource on the server. |
update_mask |
google::protobuf::FieldMask const &
Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob > > |
A |
UpdateModelDeploymentMonitoringJob(google::cloud::aiplatform::v1::UpdateModelDeploymentMonitoringJobRequest const &, Options)
Updates a ModelDeploymentMonitoringJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UpdateModelDeploymentMonitoringJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::ModelDeploymentMonitoringJob > > |
A |
DeleteModelDeploymentMonitoringJob(std::string const &, Options)
Deletes a ModelDeploymentMonitoringJob.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the model monitoring job to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteModelDeploymentMonitoringJob(google::cloud::aiplatform::v1::DeleteModelDeploymentMonitoringJobRequest const &, Options)
Deletes a ModelDeploymentMonitoringJob.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteModelDeploymentMonitoringJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
PauseModelDeploymentMonitoringJob(std::string const &, Options)
Pauses a ModelDeploymentMonitoringJob.
If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
PauseModelDeploymentMonitoringJob(google::cloud::aiplatform::v1::PauseModelDeploymentMonitoringJobRequest const &, Options)
Pauses a ModelDeploymentMonitoringJob.
If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::PauseModelDeploymentMonitoringJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
ResumeModelDeploymentMonitoringJob(std::string const &, Options)
Resumes a paused ModelDeploymentMonitoringJob.
It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
ResumeModelDeploymentMonitoringJob(google::cloud::aiplatform::v1::ResumeModelDeploymentMonitoringJobRequest const &, Options)
Resumes a paused ModelDeploymentMonitoringJob.
It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ResumeModelDeploymentMonitoringJobRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |