Skip to content

Commit d85fe38

Browse files
feat(recommender): update the api
#### recommender:v1beta1 The following keys were added: - resources.organizations.resources.locations.resources.insightTypes.methods.config (Total Keys: 17) - resources.organizations.resources.locations.resources.insightTypes.methods.getConfig (Total Keys: 11) - resources.organizations.resources.locations.resources.recommenders.methods.config (Total Keys: 17) - resources.organizations.resources.locations.resources.recommenders.methods.getConfig (Total Keys: 11) - resources.projects.resources.locations.resources.insightTypes.methods.getConfig (Total Keys: 11) - resources.projects.resources.locations.resources.insightTypes.methods.updateConfig (Total Keys: 17) - resources.projects.resources.locations.resources.recommenders.methods.getConfig (Total Keys: 11) - resources.projects.resources.locations.resources.recommenders.methods.updateConfig (Total Keys: 17) - schemas.GoogleCloudRecommenderV1beta1InsightTypeConfig (Total Keys: 9) - schemas.GoogleCloudRecommenderV1beta1InsightTypeGenerationConfig (Total Keys: 4) - schemas.GoogleCloudRecommenderV1beta1RecommenderConfig (Total Keys: 9) - schemas.GoogleCloudRecommenderV1beta1RecommenderGenerationConfig (Total Keys: 4)
1 parent 673da33 commit d85fe38

6 files changed

+732
-2
lines changed

docs/dyn/recommender_v1beta1.organizations.locations.insightTypes.html

+89
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,99 @@ <h2>Instance Methods</h2>
8282
<p class="toc_element">
8383
<code><a href="#close">close()</a></code></p>
8484
<p class="firstline">Close httplib2 connections.</p>
85+
<p class="toc_element">
86+
<code><a href="#config">config(name, body, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
87+
<p class="firstline">Updates an InsightTypeConfig change. This will create a new revision of the config.</p>
88+
<p class="toc_element">
89+
<code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
90+
<p class="firstline">Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.</p>
8591
<h3>Method Details</h3>
8692
<div class="method">
8793
<code class="details" id="close">close()</code>
8894
<pre>Close httplib2 connections.</pre>
8995
</div>
9096

97+
<div class="method">
98+
<code class="details" id="config">config(name, body, updateMask=None, validateOnly=None, x__xgafv=None)</code>
99+
<pre>Updates an InsightTypeConfig change. This will create a new revision of the config.
100+
101+
Args:
102+
name: string, Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config (required)
103+
body: object, The request body.
104+
The object takes the form of:
105+
106+
{ # Configuration for an InsightType.
107+
&quot;annotations&quot;: { # 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.
108+
&quot;a_key&quot;: &quot;A String&quot;,
109+
},
110+
&quot;displayName&quot;: &quot;A String&quot;, # A user-settable field to provide a human-readable name to be used in user interfaces.
111+
&quot;etag&quot;: &quot;A String&quot;, # Fingerprint of the InsightTypeConfig. Provides optimistic locking when updating.
112+
&quot;insightTypeGenerationConfig&quot;: { # A configuration to customize the generation of insights. Eg, customizing the lookback period considered when generating a insight. # InsightTypeGenerationConfig which configures the generation of insights for this insight type.
113+
&quot;params&quot;: { # Parameters for this InsightTypeGenerationConfig. These configs can be used by or are applied to all subtypes.
114+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
115+
},
116+
},
117+
&quot;name&quot;: &quot;A String&quot;, # Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config
118+
&quot;revisionId&quot;: &quot;A String&quot;, # 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.
119+
&quot;updateTime&quot;: &quot;A String&quot;, # Last time when the config was updated.
120+
}
121+
122+
updateMask: string, The list of fields to be updated.
123+
validateOnly: boolean, If true, validate the request and preview the change, but do not actually update it.
124+
x__xgafv: string, V1 error format.
125+
Allowed values
126+
1 - v1 error format
127+
2 - v2 error format
128+
129+
Returns:
130+
An object of the form:
131+
132+
{ # Configuration for an InsightType.
133+
&quot;annotations&quot;: { # 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.
134+
&quot;a_key&quot;: &quot;A String&quot;,
135+
},
136+
&quot;displayName&quot;: &quot;A String&quot;, # A user-settable field to provide a human-readable name to be used in user interfaces.
137+
&quot;etag&quot;: &quot;A String&quot;, # Fingerprint of the InsightTypeConfig. Provides optimistic locking when updating.
138+
&quot;insightTypeGenerationConfig&quot;: { # A configuration to customize the generation of insights. Eg, customizing the lookback period considered when generating a insight. # InsightTypeGenerationConfig which configures the generation of insights for this insight type.
139+
&quot;params&quot;: { # Parameters for this InsightTypeGenerationConfig. These configs can be used by or are applied to all subtypes.
140+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
141+
},
142+
},
143+
&quot;name&quot;: &quot;A String&quot;, # Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config
144+
&quot;revisionId&quot;: &quot;A String&quot;, # 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.
145+
&quot;updateTime&quot;: &quot;A String&quot;, # Last time when the config was updated.
146+
}</pre>
147+
</div>
148+
149+
<div class="method">
150+
<code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
151+
<pre>Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.
152+
153+
Args:
154+
name: string, Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` (required)
155+
x__xgafv: string, V1 error format.
156+
Allowed values
157+
1 - v1 error format
158+
2 - v2 error format
159+
160+
Returns:
161+
An object of the form:
162+
163+
{ # Configuration for an InsightType.
164+
&quot;annotations&quot;: { # 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+
&quot;a_key&quot;: &quot;A String&quot;,
166+
},
167+
&quot;displayName&quot;: &quot;A String&quot;, # A user-settable field to provide a human-readable name to be used in user interfaces.
168+
&quot;etag&quot;: &quot;A String&quot;, # Fingerprint of the InsightTypeConfig. Provides optimistic locking when updating.
169+
&quot;insightTypeGenerationConfig&quot;: { # A configuration to customize the generation of insights. Eg, customizing the lookback period considered when generating a insight. # InsightTypeGenerationConfig which configures the generation of insights for this insight type.
170+
&quot;params&quot;: { # Parameters for this InsightTypeGenerationConfig. These configs can be used by or are applied to all subtypes.
171+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
172+
},
173+
},
174+
&quot;name&quot;: &quot;A String&quot;, # Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config
175+
&quot;revisionId&quot;: &quot;A String&quot;, # 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+
&quot;updateTime&quot;: &quot;A String&quot;, # Last time when the config was updated.
177+
}</pre>
178+
</div>
179+
91180
</body></html>

docs/dyn/recommender_v1beta1.organizations.locations.recommenders.html

+89
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,99 @@ <h2>Instance Methods</h2>
8282
<p class="toc_element">
8383
<code><a href="#close">close()</a></code></p>
8484
<p class="firstline">Close httplib2 connections.</p>
85+
<p class="toc_element">
86+
<code><a href="#config">config(name, body, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
87+
<p class="firstline">Updates a Recommender Config. This will create a new revision of the config.</p>
88+
<p class="toc_element">
89+
<code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
90+
<p class="firstline">Gets the requested Recommender Config. There is only one instance of the config for each Recommender.</p>
8591
<h3>Method Details</h3>
8692
<div class="method">
8793
<code class="details" id="close">close()</code>
8894
<pre>Close httplib2 connections.</pre>
8995
</div>
9096

97+
<div class="method">
98+
<code class="details" id="config">config(name, body, updateMask=None, validateOnly=None, x__xgafv=None)</code>
99+
<pre>Updates a Recommender Config. This will create a new revision of the config.
100+
101+
Args:
102+
name: string, Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config (required)
103+
body: object, The request body.
104+
The object takes the form of:
105+
106+
{ # Configuration for a Recommender.
107+
&quot;annotations&quot;: { # 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.
108+
&quot;a_key&quot;: &quot;A String&quot;,
109+
},
110+
&quot;displayName&quot;: &quot;A String&quot;, # A user-settable field to provide a human-readable name to be used in user interfaces.
111+
&quot;etag&quot;: &quot;A String&quot;, # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
112+
&quot;name&quot;: &quot;A String&quot;, # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
113+
&quot;recommenderGenerationConfig&quot;: { # 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.
114+
&quot;params&quot;: { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes.
115+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
116+
},
117+
},
118+
&quot;revisionId&quot;: &quot;A String&quot;, # 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.
119+
&quot;updateTime&quot;: &quot;A String&quot;, # Last time when the config was updated.
120+
}
121+
122+
updateMask: string, The list of fields to be updated.
123+
validateOnly: boolean, If true, validate the request and preview the change, but do not actually update it.
124+
x__xgafv: string, V1 error format.
125+
Allowed values
126+
1 - v1 error format
127+
2 - v2 error format
128+
129+
Returns:
130+
An object of the form:
131+
132+
{ # Configuration for a Recommender.
133+
&quot;annotations&quot;: { # 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.
134+
&quot;a_key&quot;: &quot;A String&quot;,
135+
},
136+
&quot;displayName&quot;: &quot;A String&quot;, # A user-settable field to provide a human-readable name to be used in user interfaces.
137+
&quot;etag&quot;: &quot;A String&quot;, # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
138+
&quot;name&quot;: &quot;A String&quot;, # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
139+
&quot;recommenderGenerationConfig&quot;: { # 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.
140+
&quot;params&quot;: { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes.
141+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
142+
},
143+
},
144+
&quot;revisionId&quot;: &quot;A String&quot;, # 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.
145+
&quot;updateTime&quot;: &quot;A String&quot;, # Last time when the config was updated.
146+
}</pre>
147+
</div>
148+
149+
<div class="method">
150+
<code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
151+
<pre>Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
152+
153+
Args:
154+
name: string, Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[RECOMMENDER_ID]/config` (required)
155+
x__xgafv: string, V1 error format.
156+
Allowed values
157+
1 - v1 error format
158+
2 - v2 error format
159+
160+
Returns:
161+
An object of the form:
162+
163+
{ # Configuration for a Recommender.
164+
&quot;annotations&quot;: { # 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+
&quot;a_key&quot;: &quot;A String&quot;,
166+
},
167+
&quot;displayName&quot;: &quot;A String&quot;, # A user-settable field to provide a human-readable name to be used in user interfaces.
168+
&quot;etag&quot;: &quot;A String&quot;, # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
169+
&quot;name&quot;: &quot;A String&quot;, # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
170+
&quot;recommenderGenerationConfig&quot;: { # 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+
&quot;params&quot;: { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes.
172+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
173+
},
174+
},
175+
&quot;revisionId&quot;: &quot;A String&quot;, # 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+
&quot;updateTime&quot;: &quot;A String&quot;, # Last time when the config was updated.
177+
}</pre>
178+
</div>
179+
91180
</body></html>

0 commit comments

Comments
 (0)