docs/dyn/recommendationengine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html - external/github.com/google/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="recommendationengine_v1beta1.html">Recommendations AI</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html">predictionApiKeyRegistrations</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Register an API key for use with predict method.</p>
 <p class="toc_element">
   <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Unregister an apiKey from using for predict method.</p>
 <p class="toc_element">
   <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
 <p class="firstline">List the registered apiKeys for use with predict method.</p>
 <p class="toc_element">
   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
   <pre>Register an API key for use with predict method.

 Args:
   parent: string, Required. The parent resource path.
 &quot;projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store&quot;. (required)
   body: object, The request body.
     The object takes the form of:

 { # Request message for the `CreatePredictionApiKeyRegistration` method.
     &quot;predictionApiKeyRegistration&quot;: { # Registered Api Key. # Required. The prediction API key registration.
       &quot;apiKey&quot;: &quot;A String&quot;, # The API key.
     },
   }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Registered Api Key.
     &quot;apiKey&quot;: &quot;A String&quot;, # The API key.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="delete">delete(name, x__xgafv=None)</code>
   <pre>Unregister an apiKey from using for predict method.

 Args:
   name: string, Required. The API key to unregister including full resource path.
 &quot;projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/&lt;YOUR_API_KEY&gt;&quot; (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # A generic empty message that you can re-use to avoid defining duplicated
       # empty messages in your APIs. A typical example is to use it as the request
       # or the response type of an API method. For instance:
       #
       #     service Foo {
       #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
       #     }
       #
       # The JSON representation for `Empty` is empty JSON object `{}`.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
   <pre>List the registered apiKeys for use with predict method.

 Args:
   parent: string, Required. The parent placement resource name such as
 &quot;projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store&quot; (required)
   pageSize: integer, Optional. Maximum number of results to return per page. If unset, the
 service will choose a reasonable default.
   pageToken: string, Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Response message for the `ListPredictionApiKeyRegistrations`.
     &quot;nextPageToken&quot;: &quot;A String&quot;, # If empty, the list is complete. If nonempty, pass the token to the next
         # request&#x27;s `ListPredictionApiKeysRegistrationsRequest.pageToken`.
     &quot;predictionApiKeyRegistrations&quot;: [ # The list of registered API keys.
       { # Registered Api Key.
         &quot;apiKey&quot;: &quot;A String&quot;, # The API key.
       },
     ],
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
   <pre>Retrieves the next page of results.

 Args:
   previous_request: The request for the previous page. (required)
   previous_response: The response from the request for the previous page. (required)

 Returns:
   A request object that you can call &#x27;execute()&#x27; on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="recommendationengine_v1beta1.html">Recommendations AI</a> . <a href="recommendationengine_v1beta1.projects.html">projects</a> . <a href="recommendationengine_v1beta1.projects.locations.html">locations</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.html">catalogs</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores</a> . <a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.html">predictionApiKeyRegistrations</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Register an API key for use with predict method.</p>
	<p class="toc_element">
	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Unregister an apiKey from using for predict method.</p>
	<p class="toc_element">
	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
	<p class="firstline">List the registered apiKeys for use with predict method.</p>
	<p class="toc_element">
	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
	<p class="firstline">Retrieves the next page of results.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
	<pre>Register an API key for use with predict method.

	Args:
	parent: string, Required. The parent resource path.
	"projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store". (required)
	body: object, The request body.
	The object takes the form of:

	{ # Request message for the `CreatePredictionApiKeyRegistration` method.
	"predictionApiKeyRegistration": { # Registered Api Key. # Required. The prediction API key registration.
	"apiKey": "A String", # The API key.
	},
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Registered Api Key.
	"apiKey": "A String", # The API key.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
	<pre>Unregister an apiKey from using for predict method.

	Args:
	name: string, Required. The API key to unregister including full resource path.
	"projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>" (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # A generic empty message that you can re-use to avoid defining duplicated
	# empty messages in your APIs. A typical example is to use it as the request
	# or the response type of an API method. For instance:
	#
	# service Foo {
	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
	# }
	#
	# The JSON representation for `Empty` is empty JSON object `{}`.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
	<pre>List the registered apiKeys for use with predict method.

	Args:
	parent: string, Required. The parent placement resource name such as
	"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store" (required)
	pageSize: integer, Optional. Maximum number of results to return per page. If unset, the
	service will choose a reasonable default.
	pageToken: string, Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Response message for the `ListPredictionApiKeyRegistrations`.
	"nextPageToken": "A String", # If empty, the list is complete. If nonempty, pass the token to the next
	# request's `ListPredictionApiKeysRegistrationsRequest.pageToken`.
	"predictionApiKeyRegistrations": [ # The list of registered API keys.
	{ # Registered Api Key.
	"apiKey": "A String", # The API key.
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
	<pre>Retrieves the next page of results.

	Args:
	previous_request: The request for the previous page. (required)
	previous_response: The response from the request for the previous page. (required)

	Returns:
	A request object that you can call 'execute()' on to request the next
	page. Returns None if there are no more items in the collection.
	</pre>
	</div>

	</body></html>