Cloud AI Platform v1 API - Class GenAiTuningService.GenAiTuningServiceClient (3.1.0)

Version 3.1.0

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class GenAiTuningService.GenAiTuningServiceClient : ClientBase<GenAiTuningService.GenAiTuningServiceClient>

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

Client for GenAiTuningService

Inheritance

object > ClientBase > ClientBaseGenAiTuningServiceGenAiTuningServiceClient > GenAiTuningService.GenAiTuningServiceClient

Inherited Members

ClientBase<GenAiTuningService.GenAiTuningServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

GenAiTuningServiceClient()

protected GenAiTuningServiceClient()

Protected parameterless constructor to allow creation of test doubles.

GenAiTuningServiceClient(CallInvoker)

public GenAiTuningServiceClient(CallInvoker callInvoker)

Creates a new client for GenAiTuningService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

GenAiTuningServiceClient(ChannelBase)

public GenAiTuningServiceClient(ChannelBase channel)

Creates a new client for GenAiTuningService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

GenAiTuningServiceClient(ClientBaseConfiguration)

protected GenAiTuningServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CancelTuningJob(CancelTuningJobRequest, CallOptions)

public virtual Empty CancelTuningJob(CancelTuningJobRequest request, CallOptions 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][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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

CancelTuningJob(CancelTuningJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty CancelTuningJob(CancelTuningJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

CancelTuningJobAsync(CancelTuningJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> CancelTuningJobAsync(CancelTuningJobRequest request, CallOptions 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][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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

CancelTuningJobAsync(CancelTuningJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> CancelTuningJobAsync(CancelTuningJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateTuningJob(CreateTuningJobRequest, CallOptions)

public virtual TuningJob CreateTuningJob(CreateTuningJobRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateTuningJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TuningJob	The response received from the server.

CreateTuningJob(CreateTuningJobRequest, Metadata, DateTime?, CancellationToken)

public virtual TuningJob CreateTuningJob(CreateTuningJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateTuningJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TuningJob	The response received from the server.

CreateTuningJobAsync(CreateTuningJobRequest, CallOptions)

public virtual AsyncUnaryCall<TuningJob> CreateTuningJobAsync(CreateTuningJobRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateTuningJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTuningJob	The call object.

CreateTuningJobAsync(CreateTuningJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TuningJob> CreateTuningJobAsync(CreateTuningJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateTuningJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTuningJob	The call object.

GetTuningJob(GetTuningJobRequest, CallOptions)

public virtual TuningJob GetTuningJob(GetTuningJobRequest request, CallOptions options)

Gets a TuningJob.

Parameters
Name	Description
request	GetTuningJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TuningJob	The response received from the server.

GetTuningJob(GetTuningJobRequest, Metadata, DateTime?, CancellationToken)

public virtual TuningJob GetTuningJob(GetTuningJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a TuningJob.

Parameters
Name	Description
request	GetTuningJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TuningJob	The response received from the server.

GetTuningJobAsync(GetTuningJobRequest, CallOptions)

public virtual AsyncUnaryCall<TuningJob> GetTuningJobAsync(GetTuningJobRequest request, CallOptions options)

Gets a TuningJob.

Parameters
Name	Description
request	GetTuningJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTuningJob	The call object.

GetTuningJobAsync(GetTuningJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TuningJob> GetTuningJobAsync(GetTuningJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a TuningJob.

Parameters
Name	Description
request	GetTuningJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTuningJob	The call object.

ListTuningJobs(ListTuningJobsRequest, CallOptions)

public virtual ListTuningJobsResponse ListTuningJobs(ListTuningJobsRequest request, CallOptions options)

Lists TuningJobs in a Location.

Parameters
Name	Description
request	ListTuningJobsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListTuningJobsResponse	The response received from the server.

ListTuningJobs(ListTuningJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListTuningJobsResponse ListTuningJobs(ListTuningJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists TuningJobs in a Location.

Parameters
Name	Description
request	ListTuningJobsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListTuningJobsResponse	The response received from the server.

ListTuningJobsAsync(ListTuningJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListTuningJobsResponse> ListTuningJobsAsync(ListTuningJobsRequest request, CallOptions options)

Lists TuningJobs in a Location.

Parameters
Name	Description
request	ListTuningJobsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListTuningJobsResponse	The call object.

ListTuningJobsAsync(ListTuningJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListTuningJobsResponse> ListTuningJobsAsync(ListTuningJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists TuningJobs in a Location.

Parameters
Name	Description
request	ListTuningJobsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListTuningJobsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override GenAiTuningService.GenAiTuningServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
GenAiTuningServiceGenAiTuningServiceClient

Overrides

ClientBase<GenAiTuningService.GenAiTuningServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)