1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="recommendationengine_v1beta1.html">Recommendations AI (Beta)</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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Register an API key for use with predict method.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Unregister an apiKey from using for predict method.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">List the registered apiKeys for use with predict method.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 100 <pre>Register an API key for use with predict method. 101 102Args: 103 parent: string, Required. The parent resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`. (required) 104 body: object, The request body. 105 The object takes the form of: 106 107{ # Request message for the `CreatePredictionApiKeyRegistration` method. 108 "predictionApiKeyRegistration": { # Registered Api Key. # Required. The prediction API key registration. 109 "apiKey": "A String", # The API key. 110 }, 111} 112 113 x__xgafv: string, V1 error format. 114 Allowed values 115 1 - v1 error format 116 2 - v2 error format 117 118Returns: 119 An object of the form: 120 121 { # Registered Api Key. 122 "apiKey": "A String", # The API key. 123}</pre> 124</div> 125 126<div class="method"> 127 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 128 <pre>Unregister an apiKey from using for predict method. 129 130Args: 131 name: string, Required. The API key to unregister including full resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/` (required) 132 x__xgafv: string, V1 error format. 133 Allowed values 134 1 - v1 error format 135 2 - v2 error format 136 137Returns: 138 An object of the form: 139 140 { # 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 `{}`. 141}</pre> 142</div> 143 144<div class="method"> 145 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 146 <pre>List the registered apiKeys for use with predict method. 147 148Args: 149 parent: string, Required. The parent placement resource name such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store` (required) 150 pageSize: integer, Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default. 151 pageToken: string, Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`. 152 x__xgafv: string, V1 error format. 153 Allowed values 154 1 - v1 error format 155 2 - v2 error format 156 157Returns: 158 An object of the form: 159 160 { # Response message for the `ListPredictionApiKeyRegistrations`. 161 "nextPageToken": "A String", # If empty, the list is complete. If nonempty, pass the token to the next request's `ListPredictionApiKeysRegistrationsRequest.pageToken`. 162 "predictionApiKeyRegistrations": [ # The list of registered API keys. 163 { # Registered Api Key. 164 "apiKey": "A String", # The API key. 165 }, 166 ], 167}</pre> 168</div> 169 170<div class="method"> 171 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 172 <pre>Retrieves the next page of results. 173 174Args: 175 previous_request: The request for the previous page. (required) 176 previous_response: The response from the request for the previous page. (required) 177 178Returns: 179 A request object that you can call 'execute()' on to request the next 180 page. Returns None if there are no more items in the collection. 181 </pre> 182</div> 183 184</body></html>