Vertex AI v1beta1 API - Class OnlineEvaluatorServiceClientImpl (1.0.0-beta77)

public sealed class OnlineEvaluatorServiceClientImpl : OnlineEvaluatorServiceClient

Reference documentation and code samples for the Vertex AI v1beta1 API class OnlineEvaluatorServiceClientImpl.

OnlineEvaluatorService client wrapper implementation, for convenient use.

Inheritance

object > OnlineEvaluatorServiceClient > OnlineEvaluatorServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Remarks

This service is used to create and manage Vertex AI OnlineEvaluators.

Constructors

OnlineEvaluatorServiceClientImpl(OnlineEvaluatorServiceClient, OnlineEvaluatorServiceSettings, ILogger)

public OnlineEvaluatorServiceClientImpl(OnlineEvaluatorService.OnlineEvaluatorServiceClient grpcClient, OnlineEvaluatorServiceSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient OnlineEvaluatorServiceOnlineEvaluatorServiceClient

The underlying gRPC client.

settings OnlineEvaluatorServiceSettings

The base OnlineEvaluatorServiceSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

ActivateOnlineEvaluatorOperationsClient

public override OperationsClient ActivateOnlineEvaluatorOperationsClient { get; }

The long-running operations client for ActivateOnlineEvaluator.

Property Value
Type Description
OperationsClient
Overrides

CreateOnlineEvaluatorOperationsClient

public override OperationsClient CreateOnlineEvaluatorOperationsClient { get; }

The long-running operations client for CreateOnlineEvaluator.

Property Value
Type Description
OperationsClient
Overrides

DeleteOnlineEvaluatorOperationsClient

public override OperationsClient DeleteOnlineEvaluatorOperationsClient { get; }

The long-running operations client for DeleteOnlineEvaluator.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override OnlineEvaluatorService.OnlineEvaluatorServiceClient GrpcClient { get; }

The underlying gRPC OnlineEvaluatorService client

Property Value
Type Description
OnlineEvaluatorServiceOnlineEvaluatorServiceClient
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

SuspendOnlineEvaluatorOperationsClient

public override OperationsClient SuspendOnlineEvaluatorOperationsClient { get; }

The long-running operations client for SuspendOnlineEvaluator.

Property Value
Type Description
OperationsClient
Overrides

UpdateOnlineEvaluatorOperationsClient

public override OperationsClient UpdateOnlineEvaluatorOperationsClient { get; }

The long-running operations client for UpdateOnlineEvaluator.

Property Value
Type Description
OperationsClient
Overrides

Methods

ActivateOnlineEvaluator(ActivateOnlineEvaluatorRequest, CallSettings)

public override Operation<OnlineEvaluator, ActivateOnlineEvaluatorOperationMetadata> ActivateOnlineEvaluator(ActivateOnlineEvaluatorRequest request, CallSettings callSettings = null)

Activates an OnlineEvaluator.

Parameters
Name Description
request ActivateOnlineEvaluatorRequest

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
OperationOnlineEvaluatorActivateOnlineEvaluatorOperationMetadata

The RPC response.

Overrides

ActivateOnlineEvaluatorAsync(ActivateOnlineEvaluatorRequest, CallSettings)

public override Task<Operation<OnlineEvaluator, ActivateOnlineEvaluatorOperationMetadata>> ActivateOnlineEvaluatorAsync(ActivateOnlineEvaluatorRequest request, CallSettings callSettings = null)

Activates an OnlineEvaluator.

Parameters
Name Description
request ActivateOnlineEvaluatorRequest

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
TaskOperationOnlineEvaluatorActivateOnlineEvaluatorOperationMetadata

A Task containing the RPC response.

Overrides

CreateOnlineEvaluator(CreateOnlineEvaluatorRequest, CallSettings)

public override Operation<OnlineEvaluator, CreateOnlineEvaluatorOperationMetadata> CreateOnlineEvaluator(CreateOnlineEvaluatorRequest request, CallSettings callSettings = null)

Creates an OnlineEvaluator in the given project and location.

Parameters
Name Description
request CreateOnlineEvaluatorRequest

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
OperationOnlineEvaluatorCreateOnlineEvaluatorOperationMetadata

The RPC response.

Overrides

CreateOnlineEvaluatorAsync(CreateOnlineEvaluatorRequest, CallSettings)

public override Task<Operation<OnlineEvaluator, CreateOnlineEvaluatorOperationMetadata>> CreateOnlineEvaluatorAsync(CreateOnlineEvaluatorRequest request, CallSettings callSettings = null)

Creates an OnlineEvaluator in the given project and location.

Parameters
Name Description
request CreateOnlineEvaluatorRequest

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
TaskOperationOnlineEvaluatorCreateOnlineEvaluatorOperationMetadata

A Task containing the RPC response.

Overrides

DeleteOnlineEvaluator(DeleteOnlineEvaluatorRequest, CallSettings)

public override Operation<Empty, DeleteOnlineEvaluatorOperationMetadata> DeleteOnlineEvaluator(DeleteOnlineEvaluatorRequest request, CallSettings callSettings = null)

Deletes an OnlineEvaluator.

Parameters
Name Description
request DeleteOnlineEvaluatorRequest

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
OperationEmptyDeleteOnlineEvaluatorOperationMetadata

The RPC response.

Overrides

DeleteOnlineEvaluatorAsync(DeleteOnlineEvaluatorRequest, CallSettings)

public override Task<Operation<Empty, DeleteOnlineEvaluatorOperationMetadata>> DeleteOnlineEvaluatorAsync(DeleteOnlineEvaluatorRequest request, CallSettings callSettings = null)

Deletes an OnlineEvaluator.

Parameters
Name Description
request DeleteOnlineEvaluatorRequest

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
TaskOperationEmptyDeleteOnlineEvaluatorOperationMetadata

A Task containing the RPC response.

Overrides

GetOnlineEvaluator(GetOnlineEvaluatorRequest, CallSettings)

public override OnlineEvaluator GetOnlineEvaluator(GetOnlineEvaluatorRequest request, CallSettings callSettings = null)

Gets details of an OnlineEvaluator.

Parameters
Name Description
request GetOnlineEvaluatorRequest

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
OnlineEvaluator

The RPC response.

Overrides

GetOnlineEvaluatorAsync(GetOnlineEvaluatorRequest, CallSettings)

public override Task<OnlineEvaluator> GetOnlineEvaluatorAsync(GetOnlineEvaluatorRequest request, CallSettings callSettings = null)

Gets details of an OnlineEvaluator.

Parameters
Name Description
request GetOnlineEvaluatorRequest

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
TaskOnlineEvaluator

A Task containing the RPC response.

Overrides

ListOnlineEvaluators(ListOnlineEvaluatorsRequest, CallSettings)

public override PagedEnumerable<ListOnlineEvaluatorsResponse, OnlineEvaluator> ListOnlineEvaluators(ListOnlineEvaluatorsRequest request, CallSettings callSettings = null)

Lists the OnlineEvaluators for the given project and location.

Parameters
Name Description
request ListOnlineEvaluatorsRequest

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
PagedEnumerableListOnlineEvaluatorsResponseOnlineEvaluator

A pageable sequence of OnlineEvaluator resources.

Overrides

ListOnlineEvaluatorsAsync(ListOnlineEvaluatorsRequest, CallSettings)

public override PagedAsyncEnumerable<ListOnlineEvaluatorsResponse, OnlineEvaluator> ListOnlineEvaluatorsAsync(ListOnlineEvaluatorsRequest request, CallSettings callSettings = null)

Lists the OnlineEvaluators for the given project and location.

Parameters
Name Description
request ListOnlineEvaluatorsRequest

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
PagedAsyncEnumerableListOnlineEvaluatorsResponseOnlineEvaluator

A pageable asynchronous sequence of OnlineEvaluator resources.

Overrides

SuspendOnlineEvaluator(SuspendOnlineEvaluatorRequest, CallSettings)

public override Operation<OnlineEvaluator, SuspendOnlineEvaluatorOperationMetadata> SuspendOnlineEvaluator(SuspendOnlineEvaluatorRequest request, CallSettings callSettings = null)

Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again.

Parameters
Name Description
request SuspendOnlineEvaluatorRequest

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
OperationOnlineEvaluatorSuspendOnlineEvaluatorOperationMetadata

The RPC response.

Overrides

SuspendOnlineEvaluatorAsync(SuspendOnlineEvaluatorRequest, CallSettings)

public override Task<Operation<OnlineEvaluator, SuspendOnlineEvaluatorOperationMetadata>> SuspendOnlineEvaluatorAsync(SuspendOnlineEvaluatorRequest request, CallSettings callSettings = null)

Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again.

Parameters
Name Description
request SuspendOnlineEvaluatorRequest

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
TaskOperationOnlineEvaluatorSuspendOnlineEvaluatorOperationMetadata

A Task containing the RPC response.

Overrides

UpdateOnlineEvaluator(UpdateOnlineEvaluatorRequest, CallSettings)

public override Operation<OnlineEvaluator, UpdateOnlineEvaluatorOperationMetadata> UpdateOnlineEvaluator(UpdateOnlineEvaluatorRequest request, CallSettings callSettings = null)

Updates the fields of an OnlineEvaluator.

Parameters
Name Description
request UpdateOnlineEvaluatorRequest

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
OperationOnlineEvaluatorUpdateOnlineEvaluatorOperationMetadata

The RPC response.

Overrides

UpdateOnlineEvaluatorAsync(UpdateOnlineEvaluatorRequest, CallSettings)

public override Task<Operation<OnlineEvaluator, UpdateOnlineEvaluatorOperationMetadata>> UpdateOnlineEvaluatorAsync(UpdateOnlineEvaluatorRequest request, CallSettings callSettings = null)

Updates the fields of an OnlineEvaluator.

Parameters
Name Description
request UpdateOnlineEvaluatorRequest

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
TaskOperationOnlineEvaluatorUpdateOnlineEvaluatorOperationMetadata

A Task containing the RPC response.

Overrides