blob: 85e3aa454571880346a4ee0f8c990292c1081165 [file] [log] [blame]
<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 (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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="recommendationengine_v1beta1.projects.locations.catalogs.catalogItems.html">catalogItems()</a></code>
</p>
<p class="firstline">Returns the catalogItems Resource.</p>
<p class="toc_element">
<code><a href="recommendationengine_v1beta1.projects.locations.catalogs.eventStores.html">eventStores()</a></code>
</p>
<p class="firstline">Returns the eventStores Resource.</p>
<p class="toc_element">
<code><a href="recommendationengine_v1beta1.projects.locations.catalogs.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the catalog configurations associated with the project.</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>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the catalog configuration.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all the catalog configurations associated with the project.
Args:
parent: string, Required. The account resource name with an associated location. (required)
pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, Optional. A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListCatalogs method.
&quot;catalogs&quot;: [ # Output only. All the customer&#x27;s catalogs.
{ # The catalog configuration. Next ID: 5.
&quot;catalogItemLevelConfig&quot;: { # Configures the catalog level that users send events to, and the level at which predictions are made. # Required. The catalog item level configuration.
&quot;eventItemLevel&quot;: &quot;A String&quot;, # Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
&quot;predictItemLevel&quot;: &quot;A String&quot;, # Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
},
&quot;defaultEventStoreId&quot;: &quot;A String&quot;, # Required. The ID of the default event store.
&quot;displayName&quot;: &quot;A String&quot;, # Required. The catalog display name.
&quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the catalog.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token, if not returned indicates the last page.
}</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>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the catalog configuration.
Args:
name: string, The fully qualified resource name of the catalog. (required)
body: object, The request body.
The object takes the form of:
{ # The catalog configuration. Next ID: 5.
&quot;catalogItemLevelConfig&quot;: { # Configures the catalog level that users send events to, and the level at which predictions are made. # Required. The catalog item level configuration.
&quot;eventItemLevel&quot;: &quot;A String&quot;, # Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
&quot;predictItemLevel&quot;: &quot;A String&quot;, # Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
},
&quot;defaultEventStoreId&quot;: &quot;A String&quot;, # Required. The ID of the default event store.
&quot;displayName&quot;: &quot;A String&quot;, # Required. The catalog display name.
&quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the catalog.
}
updateMask: string, Optional. Indicates which fields in the provided &#x27;catalog&#x27; to update. If not set, will only update the catalog_item_level_config field. Currently only fields that can be updated are catalog_item_level_config.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The catalog configuration. Next ID: 5.
&quot;catalogItemLevelConfig&quot;: { # Configures the catalog level that users send events to, and the level at which predictions are made. # Required. The catalog item level configuration.
&quot;eventItemLevel&quot;: &quot;A String&quot;, # Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
&quot;predictItemLevel&quot;: &quot;A String&quot;, # Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
},
&quot;defaultEventStoreId&quot;: &quot;A String&quot;, # Required. The ID of the default event store.
&quot;displayName&quot;: &quot;A String&quot;, # Required. The catalog display name.
&quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the catalog.
}</pre>
</div>
</body></html>