Class JobServiceClient (2.23.0-rc)

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: `projects/{project}/locations/{location}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateCustomJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

GetCustomJob(std::string const &, Options)

Gets a CustomJob.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetCustomJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.CustomJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListCustomJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::CustomJob >

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: `projects/{project}/locations/{location}/customJobs/{custom_job}`
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteCustomJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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: `projects/{project}/locations/{location}/customJobs/{custom_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CancelCustomJob(google::cloud::aiplatform::v1::CancelCustomJobRequest const &, Options)

Cancels a CustomJob.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::CancelCustomJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CancelCustomJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

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: `projects/{project}/locations/{location}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateDataLabelingJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

GetDataLabelingJob(std::string const &, Options)

Gets a DataLabelingJob.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetDataLabelingJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

ListDataLabelingJobs(std::string const &, Options)

Lists DataLabelingJobs in a Location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.DataLabelingJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListDataLabelingJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.DataLabelingJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteDataLabelingJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CancelDataLabelingJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

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: `projects/{project}/locations/{location}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateHyperparameterTuningJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

GetHyperparameterTuningJob(std::string const &, Options)

Gets a HyperparameterTuningJob.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetHyperparameterTuningJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.HyperparameterTuningJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListHyperparameterTuningJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.HyperparameterTuningJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteHyperparameterTuningJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CancelHyperparameterTuningJob(google::cloud::aiplatform::v1::CancelHyperparameterTuningJobRequest const &, Options)

Cancels a HyperparameterTuningJob.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::CancelHyperparameterTuningJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CancelHyperparameterTuningJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

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: `projects/{project}/locations/{location}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateNasJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

GetNasJob(std::string const &, Options)

Gets a NasJob.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetNasJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.NasJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListNasJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.NasJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteNasJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CancelNasJob(google::cloud::aiplatform::v1::CancelNasJobRequest const &, Options)

Cancels a NasJob.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::CancelNasJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CancelNasJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

GetNasTrialDetail(std::string const &, Options)

Gets a NasTrialDetail.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetNasTrialDetailRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.NasTrialDetail, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListNasTrialDetailsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.NasTrialDetail, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: `projects/{project}/locations/{location}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateBatchPredictionJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

GetBatchPredictionJob(std::string const &, Options)

Gets a BatchPredictionJob.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetBatchPredictionJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.BatchPredictionJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListBatchPredictionJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.BatchPredictionJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteBatchPredictionJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CancelBatchPredictionJob(google::cloud::aiplatform::v1::CancelBatchPredictionJobRequest const &, Options)

Cancels a BatchPredictionJob.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::CancelBatchPredictionJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CancelBatchPredictionJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

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: `projects/{project}/locations/{location}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateModelDeploymentMonitoringJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetModelDeploymentMonitoringJob(std::string const &, Options)

Gets a ModelDeploymentMonitoringJob.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetModelDeploymentMonitoringJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

ListModelDeploymentMonitoringJobs(std::string const &, Options)

Lists ModelDeploymentMonitoringJobs in a Location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListModelDeploymentMonitoringJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. For more information, see UpdateModelDeploymentMonitoringJobRequest.
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateModelDeploymentMonitoringJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteModelDeploymentMonitoringJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

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: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.PauseModelDeploymentMonitoringJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

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: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ResumeModelDeploymentMonitoringJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.