Class GenAiTuningServiceClient (2.26.0)

Version 2.26.0

• 2.27.0-rc (latest)
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0

A service for creating and managing GenAI Tuning 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

GenAiTuningServiceClient(GenAiTuningServiceClient const &)

Copy and move support

Parameter
Name	Description
	GenAiTuningServiceClient const &

GenAiTuningServiceClient(GenAiTuningServiceClient &&)

Copy and move support

Parameter
Name	Description
	GenAiTuningServiceClient &&

GenAiTuningServiceClient(std::shared_ptr< GenAiTuningServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< GenAiTuningServiceConnection >
opts	Options

Operators

operator=(GenAiTuningServiceClient const &)

Copy and move support

Parameter
Name	Description
	GenAiTuningServiceClient const &

Returns
Type	Description
GenAiTuningServiceClient &

operator=(GenAiTuningServiceClient &&)

Copy and move support

Parameter
Name	Description
	GenAiTuningServiceClient &&

Returns
Type	Description
GenAiTuningServiceClient &

Functions

CreateTuningJob(std::string const &, google::cloud::aiplatform::v1::TuningJob const &, Options)

Creates a TuningJob.

A created TuningJob 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 TuningJob in. Format: projects/{project}/locations/{location}
tuning_job	google::cloud::aiplatform::v1::TuningJob const & Required. The TuningJob to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::TuningJob >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.TuningJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateTuningJob(google::cloud::aiplatform::v1::CreateTuningJobRequest const &, Options)

Creates a TuningJob.

A created TuningJob right away will be attempted to be run.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::CreateTuningJobRequest 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.CreateTuningJobRequest. 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::TuningJob >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.TuningJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetTuningJob(std::string const &, Options)

Gets a TuningJob.

Parameters
Name	Description
name	std::string const & Required. The name of the TuningJob resource. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::TuningJob >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.TuningJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetTuningJob(google::cloud::aiplatform::v1::GetTuningJobRequest const &, Options)

Gets a TuningJob.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::GetTuningJobRequest 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.GetTuningJobRequest. 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::TuningJob >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.TuningJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListTuningJobs(std::string const &, Options)

Lists TuningJobs in a Location.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the Location to list the TuningJobs 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::TuningJob >	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.TuningJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTuningJobs(google::cloud::aiplatform::v1::ListTuningJobsRequest, Options)

Lists TuningJobs in a Location.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::ListTuningJobsRequest 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.ListTuningJobsRequest. 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::TuningJob >	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.TuningJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CancelTuningJob(std::string const &, Options)

Cancels a TuningJob.

Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and TuningJob.state is set to CANCELLED.

Parameters
Name	Description
name	std::string const & Required. The name of the TuningJob to cancel. Format: projects/{project}/locations/{location}/tuningJobs/{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.

CancelTuningJob(google::cloud::aiplatform::v1::CancelTuningJobRequest const &, Options)

Cancels a TuningJob.

Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and TuningJob.state is set to CANCELLED.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::CancelTuningJobRequest 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.CancelTuningJobRequest. 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.