public sealed class PredictionApiKeyRegistryClientImpl : PredictionApiKeyRegistryClientReference documentation and code samples for the Recommendations AI v1beta1 API class PredictionApiKeyRegistryClientImpl.
PredictionApiKeyRegistry client wrapper implementation, for convenient use.
Namespace
Google.Cloud.RecommendationEngine.V1Beta1Assembly
Google.Cloud.RecommendationEngine.V1Beta1.dll
Remarks
Service for registering API keys for use with the predict method. If you
use an API key to request predictions, you must first register the API key.
Otherwise, your prediction request is rejected. If you use OAuth to
authenticate your predict method call, you do not need to register an API
key. You can register up to 20 API keys per project.
Constructors
PredictionApiKeyRegistryClientImpl(PredictionApiKeyRegistry.PredictionApiKeyRegistryClient, PredictionApiKeyRegistrySettings, ILogger)
public PredictionApiKeyRegistryClientImpl(PredictionApiKeyRegistry.PredictionApiKeyRegistryClient grpcClient, PredictionApiKeyRegistrySettings settings, ILogger logger)Constructs a client wrapper for the PredictionApiKeyRegistry service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | PredictionApiKeyRegistry.PredictionApiKeyRegistryClientThe underlying gRPC client. |
settings | PredictionApiKeyRegistrySettingsThe base PredictionApiKeyRegistrySettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override PredictionApiKeyRegistry.PredictionApiKeyRegistryClient GrpcClient { get; }The underlying gRPC PredictionApiKeyRegistry client
| Property Value | |
|---|---|
| Type | Description |
PredictionApiKeyRegistry.PredictionApiKeyRegistryClient | |
Methods
CreatePredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest, CallSettings)
public override PredictionApiKeyRegistration CreatePredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest request, CallSettings callSettings = null)Register an API key for use with predict method.
| Parameters | |
|---|---|
| Name | Description |
request | CreatePredictionApiKeyRegistrationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PredictionApiKeyRegistration | The RPC response. |
CreatePredictionApiKeyRegistrationAsync(CreatePredictionApiKeyRegistrationRequest, CallSettings)
public override Task<PredictionApiKeyRegistration> CreatePredictionApiKeyRegistrationAsync(CreatePredictionApiKeyRegistrationRequest request, CallSettings callSettings = null)Register an API key for use with predict method.
| Parameters | |
|---|---|
| Name | Description |
request | CreatePredictionApiKeyRegistrationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PredictionApiKeyRegistration> | A Task containing the RPC response. |
DeletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest, CallSettings)
public override void DeletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest request, CallSettings callSettings = null)Unregister an apiKey from using for predict method.
| Parameters | |
|---|---|
| Name | Description |
request | DeletePredictionApiKeyRegistrationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeletePredictionApiKeyRegistrationAsync(DeletePredictionApiKeyRegistrationRequest, CallSettings)
public override Task DeletePredictionApiKeyRegistrationAsync(DeletePredictionApiKeyRegistrationRequest request, CallSettings callSettings = null)Unregister an apiKey from using for predict method.
| Parameters | |
|---|---|
| Name | Description |
request | DeletePredictionApiKeyRegistrationRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
ListPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest, CallSettings)
public override PagedEnumerable<ListPredictionApiKeyRegistrationsResponse, PredictionApiKeyRegistration> ListPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest request, CallSettings callSettings = null)List the registered apiKeys for use with predict method.
| Parameters | |
|---|---|
| Name | Description |
request | ListPredictionApiKeyRegistrationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListPredictionApiKeyRegistrationsResponse, PredictionApiKeyRegistration> | A pageable sequence of PredictionApiKeyRegistration resources. |
ListPredictionApiKeyRegistrationsAsync(ListPredictionApiKeyRegistrationsRequest, CallSettings)
public override PagedAsyncEnumerable<ListPredictionApiKeyRegistrationsResponse, PredictionApiKeyRegistration> ListPredictionApiKeyRegistrationsAsync(ListPredictionApiKeyRegistrationsRequest request, CallSettings callSettings = null)List the registered apiKeys for use with predict method.
| Parameters | |
|---|---|
| Name | Description |
request | ListPredictionApiKeyRegistrationsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListPredictionApiKeyRegistrationsResponse, PredictionApiKeyRegistration> | A pageable asynchronous sequence of PredictionApiKeyRegistration resources. |