public class PredictionApiKeyRegistry.PredictionApiKeyRegistryClient : ClientBase<PredictionApiKeyRegistry.PredictionApiKeyRegistryClient>Reference documentation and code samples for the Recommendations AI v1beta1 API class PredictionApiKeyRegistry.PredictionApiKeyRegistryClient.
Client for PredictionApiKeyRegistry
Inheritance
object > ClientBase > ClientBasePredictionApiKeyRegistryPredictionApiKeyRegistryClient > PredictionApiKeyRegistry.PredictionApiKeyRegistryClientNamespace
Google.Cloud.RecommendationEngine.V1Beta1Assembly
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 | |
|---|---|
| Name | Description |
callInvoker |
CallInvokerThe callInvoker to use to make remote calls. |
PredictionApiKeyRegistryClient(ChannelBase)
public PredictionApiKeyRegistryClient(ChannelBase channel)Creates a new client for PredictionApiKeyRegistry
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
PredictionApiKeyRegistryClient(ClientBaseConfiguration)
protected PredictionApiKeyRegistryClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfigurationThe client configuration. |
Methods
CreatePredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest, CallOptions)
public virtual PredictionApiKeyRegistration CreatePredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest request, CallOptions options)Register an API key for use with predict method.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePredictionApiKeyRegistrationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
PredictionApiKeyRegistration |
The response received from the server. |
CreatePredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest, Metadata, DateTime?, CancellationToken)
public virtual PredictionApiKeyRegistration CreatePredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Register an API key for use with predict method.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePredictionApiKeyRegistrationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
CreatePredictionApiKeyRegistrationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPredictionApiKeyRegistration |
The call object. |
CreatePredictionApiKeyRegistrationAsync(CreatePredictionApiKeyRegistrationRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<PredictionApiKeyRegistration> CreatePredictionApiKeyRegistrationAsync(CreatePredictionApiKeyRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Register an API key for use with predict method.
| Parameters | |
|---|---|
| Name | Description |
request |
CreatePredictionApiKeyRegistrationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPredictionApiKeyRegistration |
The call object. |
DeletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest, CallOptions)
public virtual Empty DeletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest request, CallOptions options)Unregister an apiKey from using for predict method.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePredictionApiKeyRegistrationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty |
The response received from the server. |
DeletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Unregister an apiKey from using for predict method.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePredictionApiKeyRegistrationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DeletePredictionApiKeyRegistrationRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeletePredictionApiKeyRegistrationAsync(DeletePredictionApiKeyRegistrationRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeletePredictionApiKeyRegistrationAsync(DeletePredictionApiKeyRegistrationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Unregister an apiKey from using for predict method.
| Parameters | |
|---|---|
| Name | Description |
request |
DeletePredictionApiKeyRegistrationRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty |
The call object. |
ListPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest, CallOptions)
public virtual ListPredictionApiKeyRegistrationsResponse ListPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest request, CallOptions options)List the registered apiKeys for use with predict method.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPredictionApiKeyRegistrationsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListPredictionApiKeyRegistrationsResponse |
The response received from the server. |
ListPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListPredictionApiKeyRegistrationsResponse ListPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)List the registered apiKeys for use with predict method.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPredictionApiKeyRegistrationsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ListPredictionApiKeyRegistrationsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListPredictionApiKeyRegistrationsResponse |
The call object. |
ListPredictionApiKeyRegistrationsAsync(ListPredictionApiKeyRegistrationsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListPredictionApiKeyRegistrationsResponse> ListPredictionApiKeyRegistrationsAsync(ListPredictionApiKeyRegistrationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)List the registered apiKeys for use with predict method.
| Parameters | |
|---|---|
| Name | Description |
request |
ListPredictionApiKeyRegistrationsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListPredictionApiKeyRegistrationsResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override PredictionApiKeyRegistry.PredictionApiKeyRegistryClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
PredictionApiKeyRegistryPredictionApiKeyRegistryClient |
|