Class PredictionApiKeyRegistryAsyncClient (0.6.1)

PredictionApiKeyRegistryAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.transports.base.PredictionApiKeyRegistryTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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.

Inheritance

builtins.object > PredictionApiKeyRegistryAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
PredictionApiKeyRegistryTransport	The transport used by the client instance.

Methods

PredictionApiKeyRegistryAsyncClient

PredictionApiKeyRegistryAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.transports.base.PredictionApiKeyRegistryTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the prediction api key registry client.

Parameters

Name	Description
credentials	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	Union[str, `.PredictionApiKeyRegistryTransport`] The transport to use. If set to None, a transport is chosen automatically.
client_options	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions

Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_prediction_api_key_registration

create_prediction_api_key_registration(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest, dict]] = None, *, parent: Optional[str] = None, prediction_api_key_registration: Optional[google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.PredictionApiKeyRegistration] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

from google.cloud import recommendationengine_v1beta1

def sample_create_prediction_api_key_registration():
    # Create a client
    client = recommendationengine_v1beta1.PredictionApiKeyRegistryClient()

    # Initialize request argument(s)
    request = recommendationengine_v1beta1.CreatePredictionApiKeyRegistrationRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_prediction_api_key_registration(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.recommendationengine_v1beta1.types.CreatePredictionApiKeyRegistrationRequest, dict]` The request object. Request message for the `CreatePredictionApiKeyRegistration` method.
parent	`str` Required. The parent resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
prediction_api_key_registration	`PredictionApiKeyRegistration` Required. The prediction API key registration. This corresponds to the `prediction_api_key_registration` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration	Registered Api Key.

delete_prediction_api_key_registration

delete_prediction_api_key_registration(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Unregister an apiKey from using for predict method.

from google.cloud import recommendationengine_v1beta1

def sample_delete_prediction_api_key_registration():
    # Create a client
    client = recommendationengine_v1beta1.PredictionApiKeyRegistryClient()

    # Initialize request argument(s)
    request = recommendationengine_v1beta1.DeletePredictionApiKeyRegistrationRequest(
        name="name_value",
    )

    # Make the request
    client.delete_prediction_api_key_registration(request=request)

Parameters

Name	Description
request	`Union[google.cloud.recommendationengine_v1beta1.types.DeletePredictionApiKeyRegistrationRequest, dict]` The request object. Request message for `DeletePredictionApiKeyRegistration` method.
name	`str` Required. The API key to unregister including full resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

event_store_path

event_store_path(project: str, location: str, catalog: str, event_store: str)

Returns a fully-qualified event_store string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
PredictionApiKeyRegistryAsyncClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
PredictionApiKeyRegistryAsyncClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
PredictionApiKeyRegistryAsyncClient	The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter

Name	Description
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns

Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_prediction_api_key_registrations

list_prediction_api_key_registrations(request: Optional[Union[google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

List the registered apiKeys for use with predict method.

from google.cloud import recommendationengine_v1beta1

def sample_list_prediction_api_key_registrations():
    # Create a client
    client = recommendationengine_v1beta1.PredictionApiKeyRegistryClient()

    # Initialize request argument(s)
    request = recommendationengine_v1beta1.ListPredictionApiKeyRegistrationsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_prediction_api_key_registrations(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsRequest, dict]` The request object. Request message for the `ListPredictionApiKeyRegistrations`.
parent	`str` Required. The parent placement resource name such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsAsyncPager	Response message for the ListPredictionApiKeyRegistrations. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_event_store_path

parse_event_store_path(path: str)

Parses a event_store path into its component segments.

parse_prediction_api_key_registration_path

parse_prediction_api_key_registration_path(path: str)

Parses a prediction_api_key_registration path into its component segments.

prediction_api_key_registration_path

prediction_api_key_registration_path(
    project: str,
    location: str,
    catalog: str,
    event_store: str,
    prediction_api_key_registration: str,
)

Returns a fully-qualified prediction_api_key_registration string.