Cloud AI Platform v1 API - Class GenAiTuningServiceClientImpl (3.0.0) 

public sealed class GenAiTuningServiceClientImpl : GenAiTuningServiceClient

Reference documentation and code samples for the Cloud AI Platform v1 API class GenAiTuningServiceClientImpl.

GenAiTuningService client wrapper implementation, for convenient use.

Inheritance

object > GenAiTuningServiceClient > GenAiTuningServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for creating and managing GenAI Tuning Jobs.

Constructors

GenAiTuningServiceClientImpl(GenAiTuningServiceClient, GenAiTuningServiceSettings, ILogger)

public GenAiTuningServiceClientImpl(GenAiTuningService.GenAiTuningServiceClient grpcClient, GenAiTuningServiceSettings settings, ILogger logger)

Constructs a client wrapper for the GenAiTuningService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient GenAiTuningServiceGenAiTuningServiceClient

The underlying gRPC client.
settings GenAiTuningServiceSettings

The base GenAiTuningServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override GenAiTuningService.GenAiTuningServiceClient GrpcClient { get; }

The underlying gRPC GenAiTuningService client

Property Value
Type Description
GenAiTuningServiceGenAiTuningServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CancelTuningJob(CancelTuningJobRequest, CallSettings)

public override void CancelTuningJob(CancelTuningJobRequest request, CallSettings callSettings = null)

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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.TuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [TuningJob.state][google.cloud.aiplatform.v1.TuningJob.state] is set to CANCELLED.

Parameters
Name Description
request CancelTuningJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

CancelTuningJobAsync(CancelTuningJobRequest, CallSettings)

public override Task CancelTuningJobAsync(CancelTuningJobRequest request, CallSettings callSettings = null)

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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.TuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED, and [TuningJob.state][google.cloud.aiplatform.v1.TuningJob.state] is set to CANCELLED.

Parameters
Name Description
request CancelTuningJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

CreateTuningJob(CreateTuningJobRequest, CallSettings)

public override TuningJob CreateTuningJob(CreateTuningJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateTuningJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TuningJob

The RPC response.
Overrides

CreateTuningJobAsync(CreateTuningJobRequest, CallSettings)

public override Task<TuningJob> CreateTuningJobAsync(CreateTuningJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateTuningJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTuningJob

A Task containing the RPC response.
Overrides

GetTuningJob(GetTuningJobRequest, CallSettings)

public override TuningJob GetTuningJob(GetTuningJobRequest request, CallSettings callSettings = null)

Gets a TuningJob.

Parameters
Name Description
request GetTuningJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TuningJob

The RPC response.
Overrides

GetTuningJobAsync(GetTuningJobRequest, CallSettings)

public override Task<TuningJob> GetTuningJobAsync(GetTuningJobRequest request, CallSettings callSettings = null)

Gets a TuningJob.

Parameters
Name Description
request GetTuningJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTuningJob

A Task containing the RPC response.
Overrides

ListTuningJobs(ListTuningJobsRequest, CallSettings)

public override PagedEnumerable<ListTuningJobsResponse, TuningJob> ListTuningJobs(ListTuningJobsRequest request, CallSettings callSettings = null)

Lists TuningJobs in a Location.

Parameters
Name Description
request ListTuningJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTuningJobsResponseTuningJob

A pageable sequence of TuningJob resources.
Overrides

ListTuningJobsAsync(ListTuningJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTuningJobsResponse, TuningJob> ListTuningJobsAsync(ListTuningJobsRequest request, CallSettings callSettings = null)

Lists TuningJobs in a Location.

Parameters
Name Description
request ListTuningJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTuningJobsResponseTuningJob

A pageable asynchronous sequence of TuningJob resources.
Overrides