Recommendations AI v1beta1 API - Class PredictionApiKeyRegistry.PredictionApiKeyRegistryClient (2.0.0-beta03)

public class PredictionApiKeyRegistryClient : ClientBase<PredictionApiKeyRegistry.PredictionApiKeyRegistryClient>

Reference documentation and code samples for the Recommendations AI v1beta1 API class PredictionApiKeyRegistry.PredictionApiKeyRegistryClient.

Client for PredictionApiKeyRegistry

Inheritance

Object > ClientBase > ClientBase<PredictionApiKeyRegistry.PredictionApiKeyRegistryClient> > PredictionApiKeyRegistry.PredictionApiKeyRegistryClient

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

PredictionApiKeyRegistryClient()

protected PredictionApiKeyRegistryClient()

Protected parameterless constructor to allow creation of test doubles.

PredictionApiKeyRegistryClient(CallInvoker)

public PredictionApiKeyRegistryClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

PredictionApiKeyRegistryClient(ChannelBase)

public PredictionApiKeyRegistryClient(ChannelBase channel)

Creates a new client for PredictionApiKeyRegistry

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

PredictionApiKeyRegistryClient(ClientBase.ClientBaseConfiguration)

protected PredictionApiKeyRegistryClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreatePredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest, CallOptions)

public virtual PredictionApiKeyRegistration CreatePredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest request, CallOptions options)

Register an API key for use with predict method.

Parameters
NameDescription
requestCreatePredictionApiKeyRegistrationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
PredictionApiKeyRegistration

The response received from the server.

CreatePredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual PredictionApiKeyRegistration CreatePredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Register an API key for use with predict method.

Parameters
NameDescription
requestCreatePredictionApiKeyRegistrationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
PredictionApiKeyRegistration

The response received from the server.

CreatePredictionApiKeyRegistrationAsync(CreatePredictionApiKeyRegistrationRequest, CallOptions)

public virtual AsyncUnaryCall<PredictionApiKeyRegistration> CreatePredictionApiKeyRegistrationAsync(CreatePredictionApiKeyRegistrationRequest request, CallOptions options)

Register an API key for use with predict method.

Parameters
NameDescription
requestCreatePredictionApiKeyRegistrationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<PredictionApiKeyRegistration>

The call object.

CreatePredictionApiKeyRegistrationAsync(CreatePredictionApiKeyRegistrationRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<PredictionApiKeyRegistration> CreatePredictionApiKeyRegistrationAsync(CreatePredictionApiKeyRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Register an API key for use with predict method.

Parameters
NameDescription
requestCreatePredictionApiKeyRegistrationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<PredictionApiKeyRegistration>

The call object.

DeletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest, CallOptions)

public virtual Empty DeletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest request, CallOptions options)

Unregister an apiKey from using for predict method.

Parameters
NameDescription
requestDeletePredictionApiKeyRegistrationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Unregister an apiKey from using for predict method.

Parameters
NameDescription
requestDeletePredictionApiKeyRegistrationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeletePredictionApiKeyRegistrationAsync(DeletePredictionApiKeyRegistrationRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeletePredictionApiKeyRegistrationAsync(DeletePredictionApiKeyRegistrationRequest request, CallOptions options)

Unregister an apiKey from using for predict method.

Parameters
NameDescription
requestDeletePredictionApiKeyRegistrationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeletePredictionApiKeyRegistrationAsync(DeletePredictionApiKeyRegistrationRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Unregister an apiKey from using for predict method.

Parameters
NameDescription
requestDeletePredictionApiKeyRegistrationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

ListPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest, CallOptions)

public virtual ListPredictionApiKeyRegistrationsResponse ListPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest request, CallOptions options)

List the registered apiKeys for use with predict method.

Parameters
NameDescription
requestListPredictionApiKeyRegistrationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListPredictionApiKeyRegistrationsResponse

The response received from the server.

ListPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListPredictionApiKeyRegistrationsResponse ListPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List the registered apiKeys for use with predict method.

Parameters
NameDescription
requestListPredictionApiKeyRegistrationsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListPredictionApiKeyRegistrationsResponse

The response received from the server.

ListPredictionApiKeyRegistrationsAsync(ListPredictionApiKeyRegistrationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListPredictionApiKeyRegistrationsResponse> ListPredictionApiKeyRegistrationsAsync(ListPredictionApiKeyRegistrationsRequest request, CallOptions options)

List the registered apiKeys for use with predict method.

Parameters
NameDescription
requestListPredictionApiKeyRegistrationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListPredictionApiKeyRegistrationsResponse>

The call object.

ListPredictionApiKeyRegistrationsAsync(ListPredictionApiKeyRegistrationsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListPredictionApiKeyRegistrationsResponse> ListPredictionApiKeyRegistrationsAsync(ListPredictionApiKeyRegistrationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List the registered apiKeys for use with predict method.

Parameters
NameDescription
requestListPredictionApiKeyRegistrationsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListPredictionApiKeyRegistrationsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override PredictionApiKeyRegistry.PredictionApiKeyRegistryClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
PredictionApiKeyRegistry.PredictionApiKeyRegistryClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.RecommendationEngine.V1Beta1.PredictionApiKeyRegistry.PredictionApiKeyRegistryClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)