Vertex AI v1beta1 API - Class OnlineEvaluatorService.OnlineEvaluatorServiceClient (1.0.0-beta78) 

public class OnlineEvaluatorService.OnlineEvaluatorServiceClient : ClientBase<OnlineEvaluatorService.OnlineEvaluatorServiceClient>

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

Client for OnlineEvaluatorService

Inheritance

object > ClientBase > ClientBaseOnlineEvaluatorServiceOnlineEvaluatorServiceClient > OnlineEvaluatorService.OnlineEvaluatorServiceClient

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

OnlineEvaluatorServiceClient()

protected OnlineEvaluatorServiceClient()

Protected parameterless constructor to allow creation of test doubles.

OnlineEvaluatorServiceClient(CallInvoker)

public OnlineEvaluatorServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

OnlineEvaluatorServiceClient(ChannelBase)

public OnlineEvaluatorServiceClient(ChannelBase channel)

Creates a new client for OnlineEvaluatorService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

OnlineEvaluatorServiceClient(ClientBaseConfiguration)

protected OnlineEvaluatorServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

ActivateOnlineEvaluator(ActivateOnlineEvaluatorRequest, CallOptions)

public virtual Operation ActivateOnlineEvaluator(ActivateOnlineEvaluatorRequest request, CallOptions options)

Activates an OnlineEvaluator.

Parameters
Name Description
request ActivateOnlineEvaluatorRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

ActivateOnlineEvaluator(ActivateOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ActivateOnlineEvaluator(ActivateOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Activates an OnlineEvaluator.

Parameters
Name Description
request ActivateOnlineEvaluatorRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
Operation

The response received from the server.

ActivateOnlineEvaluatorAsync(ActivateOnlineEvaluatorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ActivateOnlineEvaluatorAsync(ActivateOnlineEvaluatorRequest request, CallOptions options)

Activates an OnlineEvaluator.

Parameters
Name Description
request ActivateOnlineEvaluatorRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

ActivateOnlineEvaluatorAsync(ActivateOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ActivateOnlineEvaluatorAsync(ActivateOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Activates an OnlineEvaluator.

Parameters
Name Description
request ActivateOnlineEvaluatorRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallOperation

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.

CreateOnlineEvaluator(CreateOnlineEvaluatorRequest, CallOptions)

public virtual Operation CreateOnlineEvaluator(CreateOnlineEvaluatorRequest request, CallOptions options)

Creates an OnlineEvaluator in the given project and location.

Parameters
Name Description
request CreateOnlineEvaluatorRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateOnlineEvaluator(CreateOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateOnlineEvaluator(CreateOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an OnlineEvaluator in the given project and location.

Parameters
Name Description
request CreateOnlineEvaluatorRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
Operation

The response received from the server.

CreateOnlineEvaluatorAsync(CreateOnlineEvaluatorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateOnlineEvaluatorAsync(CreateOnlineEvaluatorRequest request, CallOptions options)

Creates an OnlineEvaluator in the given project and location.

Parameters
Name Description
request CreateOnlineEvaluatorRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateOnlineEvaluatorAsync(CreateOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateOnlineEvaluatorAsync(CreateOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an OnlineEvaluator in the given project and location.

Parameters
Name Description
request CreateOnlineEvaluatorRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallOperation

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteOnlineEvaluator(DeleteOnlineEvaluatorRequest, CallOptions)

public virtual Operation DeleteOnlineEvaluator(DeleteOnlineEvaluatorRequest request, CallOptions options)

Deletes an OnlineEvaluator.

Parameters
Name Description
request DeleteOnlineEvaluatorRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteOnlineEvaluator(DeleteOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteOnlineEvaluator(DeleteOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an OnlineEvaluator.

Parameters
Name Description
request DeleteOnlineEvaluatorRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
Operation

The response received from the server.

DeleteOnlineEvaluatorAsync(DeleteOnlineEvaluatorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteOnlineEvaluatorAsync(DeleteOnlineEvaluatorRequest request, CallOptions options)

Deletes an OnlineEvaluator.

Parameters
Name Description
request DeleteOnlineEvaluatorRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteOnlineEvaluatorAsync(DeleteOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteOnlineEvaluatorAsync(DeleteOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an OnlineEvaluator.

Parameters
Name Description
request DeleteOnlineEvaluatorRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallOperation

The call object.

GetOnlineEvaluator(GetOnlineEvaluatorRequest, CallOptions)

public virtual OnlineEvaluator GetOnlineEvaluator(GetOnlineEvaluatorRequest request, CallOptions options)

Gets details of an OnlineEvaluator.

Parameters
Name Description
request GetOnlineEvaluatorRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
OnlineEvaluator

The response received from the server.

GetOnlineEvaluator(GetOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual OnlineEvaluator GetOnlineEvaluator(GetOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of an OnlineEvaluator.

Parameters
Name Description
request GetOnlineEvaluatorRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
OnlineEvaluator

The response received from the server.

GetOnlineEvaluatorAsync(GetOnlineEvaluatorRequest, CallOptions)

public virtual AsyncUnaryCall<OnlineEvaluator> GetOnlineEvaluatorAsync(GetOnlineEvaluatorRequest request, CallOptions options)

Gets details of an OnlineEvaluator.

Parameters
Name Description
request GetOnlineEvaluatorRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOnlineEvaluator

The call object.

GetOnlineEvaluatorAsync(GetOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<OnlineEvaluator> GetOnlineEvaluatorAsync(GetOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of an OnlineEvaluator.

Parameters
Name Description
request GetOnlineEvaluatorRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallOnlineEvaluator

The call object.

ListOnlineEvaluators(ListOnlineEvaluatorsRequest, CallOptions)

public virtual ListOnlineEvaluatorsResponse ListOnlineEvaluators(ListOnlineEvaluatorsRequest request, CallOptions options)

Lists the OnlineEvaluators for the given project and location.

Parameters
Name Description
request ListOnlineEvaluatorsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListOnlineEvaluatorsResponse

The response received from the server.

ListOnlineEvaluators(ListOnlineEvaluatorsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListOnlineEvaluatorsResponse ListOnlineEvaluators(ListOnlineEvaluatorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the OnlineEvaluators for the given project and location.

Parameters
Name Description
request ListOnlineEvaluatorsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
ListOnlineEvaluatorsResponse

The response received from the server.

ListOnlineEvaluatorsAsync(ListOnlineEvaluatorsRequest, CallOptions)

public virtual AsyncUnaryCall<ListOnlineEvaluatorsResponse> ListOnlineEvaluatorsAsync(ListOnlineEvaluatorsRequest request, CallOptions options)

Lists the OnlineEvaluators for the given project and location.

Parameters
Name Description
request ListOnlineEvaluatorsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListOnlineEvaluatorsResponse

The call object.

ListOnlineEvaluatorsAsync(ListOnlineEvaluatorsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListOnlineEvaluatorsResponse> ListOnlineEvaluatorsAsync(ListOnlineEvaluatorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the OnlineEvaluators for the given project and location.

Parameters
Name Description
request ListOnlineEvaluatorsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallListOnlineEvaluatorsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override OnlineEvaluatorService.OnlineEvaluatorServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
OnlineEvaluatorServiceOnlineEvaluatorServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluatorService.OnlineEvaluatorServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SuspendOnlineEvaluator(SuspendOnlineEvaluatorRequest, CallOptions)

public virtual Operation SuspendOnlineEvaluator(SuspendOnlineEvaluatorRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

SuspendOnlineEvaluator(SuspendOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SuspendOnlineEvaluator(SuspendOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
Operation

The response received from the server.

SuspendOnlineEvaluatorAsync(SuspendOnlineEvaluatorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SuspendOnlineEvaluatorAsync(SuspendOnlineEvaluatorRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

SuspendOnlineEvaluatorAsync(SuspendOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SuspendOnlineEvaluatorAsync(SuspendOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallOperation

The call object.

UpdateOnlineEvaluator(UpdateOnlineEvaluatorRequest, CallOptions)

public virtual Operation UpdateOnlineEvaluator(UpdateOnlineEvaluatorRequest request, CallOptions options)

Updates the fields of an OnlineEvaluator.

Parameters
Name Description
request UpdateOnlineEvaluatorRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdateOnlineEvaluator(UpdateOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateOnlineEvaluator(UpdateOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the fields of an OnlineEvaluator.

Parameters
Name Description
request UpdateOnlineEvaluatorRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
Operation

The response received from the server.

UpdateOnlineEvaluatorAsync(UpdateOnlineEvaluatorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateOnlineEvaluatorAsync(UpdateOnlineEvaluatorRequest request, CallOptions options)

Updates the fields of an OnlineEvaluator.

Parameters
Name Description
request UpdateOnlineEvaluatorRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateOnlineEvaluatorAsync(UpdateOnlineEvaluatorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateOnlineEvaluatorAsync(UpdateOnlineEvaluatorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the fields of an OnlineEvaluator.

Parameters
Name Description
request UpdateOnlineEvaluatorRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallOperation

The call object.