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="recommender_v1beta1.html">Recommender API</a> . <a href="recommender_v1beta1.projects.html">projects</a> . <a href="recommender_v1beta1.projects.locations.html">locations</a> . <a href="recommender_v1beta1.projects.locations.recommenders.html">recommenders</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="recommender_v1beta1.projects.locations.recommenders.recommendations.html">recommendations()</a></code> 79</p> 80<p class="firstline">Returns the recommendations Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p> 87<p class="firstline">Gets the requested Recommender Config. There is only one instance of the config for each Recommender.</p> 88<p class="toc_element"> 89 <code><a href="#updateConfig">updateConfig(name, body, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Updates a Recommender Config. This will create a new revision of the config.</p> 91<h3>Method Details</h3> 92<div class="method"> 93 <code class="details" id="close">close()</code> 94 <pre>Close httplib2 connections.</pre> 95</div> 96 97<div class="method"> 98 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code> 99 <pre>Gets the requested Recommender Config. There is only one instance of the config for each Recommender. 100 101Args: 102 name: string, Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` (required) 103 x__xgafv: string, V1 error format. 104 Allowed values 105 1 - v1 error format 106 2 - v2 error format 107 108Returns: 109 An object of the form: 110 111 { # Configuration for a Recommender. 112 "annotations": { # Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. 113 "a_key": "A String", 114 }, 115 "displayName": "A String", # A user-settable field to provide a human-readable name to be used in user interfaces. 116 "etag": "A String", # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating. 117 "name": "A String", # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config 118 "recommenderGenerationConfig": { # A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation. # RecommenderGenerationConfig which configures the Generation of recommendations for this recommender. 119 "params": { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes. 120 "a_key": "", # Properties of the object. 121 }, 122 }, 123 "revisionId": "A String", # Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string. 124 "updateTime": "A String", # Last time when the config was updated. 125}</pre> 126</div> 127 128<div class="method"> 129 <code class="details" id="updateConfig">updateConfig(name, body, updateMask=None, validateOnly=None, x__xgafv=None)</code> 130 <pre>Updates a Recommender Config. This will create a new revision of the config. 131 132Args: 133 name: string, Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config (required) 134 body: object, The request body. 135 The object takes the form of: 136 137{ # Configuration for a Recommender. 138 "annotations": { # Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. 139 "a_key": "A String", 140 }, 141 "displayName": "A String", # A user-settable field to provide a human-readable name to be used in user interfaces. 142 "etag": "A String", # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating. 143 "name": "A String", # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config 144 "recommenderGenerationConfig": { # A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation. # RecommenderGenerationConfig which configures the Generation of recommendations for this recommender. 145 "params": { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes. 146 "a_key": "", # Properties of the object. 147 }, 148 }, 149 "revisionId": "A String", # Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string. 150 "updateTime": "A String", # Last time when the config was updated. 151} 152 153 updateMask: string, The list of fields to be updated. 154 validateOnly: boolean, If true, validate the request and preview the change, but do not actually update it. 155 x__xgafv: string, V1 error format. 156 Allowed values 157 1 - v1 error format 158 2 - v2 error format 159 160Returns: 161 An object of the form: 162 163 { # Configuration for a Recommender. 164 "annotations": { # Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. 165 "a_key": "A String", 166 }, 167 "displayName": "A String", # A user-settable field to provide a human-readable name to be used in user interfaces. 168 "etag": "A String", # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating. 169 "name": "A String", # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config 170 "recommenderGenerationConfig": { # A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation. # RecommenderGenerationConfig which configures the Generation of recommendations for this recommender. 171 "params": { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes. 172 "a_key": "", # Properties of the object. 173 }, 174 }, 175 "revisionId": "A String", # Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string. 176 "updateTime": "A String", # Last time when the config was updated. 177}</pre> 178</div> 179 180</body></html>