As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

PredictionApiKeyRegistry

class google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.transports.base.PredictionApiKeyRegistryTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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.

Instantiates the prediction api key registry client.

Parameters
  • 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.

Raises

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

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

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

Register an API key for use with predict method.

Parameters
Returns

Registered Api Key.

Return type

google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration

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

Unregister an apiKey from using for predict method.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.DeletePredictionApiKeyRegistrationRequest) – 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.

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

Returns a fully-qualified event_store string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PredictionApiKeyRegistryAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PredictionApiKeyRegistryAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PredictionApiKeyRegistryAsyncClient

get_transport_class()Type[google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.transports.base.PredictionApiKeyRegistryTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_prediction_api_key_registrations(request: Optional[google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsAsyncPager[source]

List the registered apiKeys for use with predict method.

Parameters
  • request (google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsRequest) – 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

Response message for the ListPredictionApiKeyRegistrations.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsAsyncPager

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_event_store_path(path: str)Dict[str, str]

Parses a event_store path into its component segments.

static parse_prediction_api_key_registration_path(path: str)Dict[str, str]

Parses a prediction_api_key_registration path into its component segments.

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

Returns a fully-qualified prediction_api_key_registration string.

property transport: google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.transports.base.PredictionApiKeyRegistryTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

PredictionApiKeyRegistryTransport

class google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.transports.base.PredictionApiKeyRegistryTransport]] = None, 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>)[source]

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.

Instantiates the prediction api key registry client.

Parameters
  • 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 (google.api_core.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.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.PredictionApiKeyRegistration[source]

Register an API key for use with predict method.

Parameters
Returns

Registered Api Key.

Return type

google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration

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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Unregister an apiKey from using for predict method.

Parameters
  • 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.

static event_store_path(project: str, location: str, catalog: str, event_store: str)str[source]

Returns a fully-qualified event_store string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PredictionApiKeyRegistryClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PredictionApiKeyRegistryClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PredictionApiKeyRegistryClient

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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsPager[source]

List the registered apiKeys for use with predict method.

Parameters
  • 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

Response message for the ListPredictionApiKeyRegistrations.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsPager

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_event_store_path(path: str)Dict[str, str][source]

Parses a event_store path into its component segments.

static parse_prediction_api_key_registration_path(path: str)Dict[str, str][source]

Parses a prediction_api_key_registration path into its component segments.

static prediction_api_key_registration_path(project: str, location: str, catalog: str, event_store: str, prediction_api_key_registration: str)str[source]

Returns a fully-qualified prediction_api_key_registration string.

property transport: google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.transports.base.PredictionApiKeyRegistryTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

PredictionApiKeyRegistryTransport

class google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsAsyncPager(method: Callable[[...], Awaitable[google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse]], request: google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest, response: google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_prediction_api_key_registrations requests.

This class thinly wraps an initial google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsResponse object, and provides an __aiter__ method to iterate through its prediction_api_key_registrations field.

If there are more pages, the __aiter__ method will make additional ListPredictionApiKeyRegistrations requests and continue to iterate through the prediction_api_key_registrations field on the corresponding responses.

All the usual google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsPager(method: Callable[[...], google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse], request: google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest, response: google.cloud.recommendationengine_v1beta1.types.prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_prediction_api_key_registrations requests.

This class thinly wraps an initial google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsResponse object, and provides an __iter__ method to iterate through its prediction_api_key_registrations field.

If there are more pages, the __iter__ method will make additional ListPredictionApiKeyRegistrations requests and continue to iterate through the prediction_api_key_registrations field on the corresponding responses.

All the usual google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters