Skip to content

Commit 58a7d6a

Browse files
feat(recommender): update the api
#### recommender:v1 The following keys were added: - resources.billingAccounts.resources.locations.resources.insightTypes.methods.getConfig (Total Keys: 11) - resources.billingAccounts.resources.locations.resources.insightTypes.methods.updateConfig (Total Keys: 17) - resources.billingAccounts.resources.locations.resources.recommenders.methods.getConfig (Total Keys: 11) - resources.billingAccounts.resources.locations.resources.recommenders.methods.updateConfig (Total Keys: 17) #### recommender:v1beta1 The following keys were added: - resources.billingAccounts.resources.locations.resources.insightTypes.methods.getConfig (Total Keys: 11) - resources.billingAccounts.resources.locations.resources.insightTypes.methods.updateConfig (Total Keys: 17) - resources.billingAccounts.resources.locations.resources.recommenders.methods.getConfig (Total Keys: 11) - resources.billingAccounts.resources.locations.resources.recommenders.methods.updateConfig (Total Keys: 17)
1 parent 546cd30 commit 58a7d6a

14 files changed

+642
-20
lines changed

docs/dyn/recommender_v1.billingAccounts.locations.insightTypes.html

Lines changed: 89 additions & 0 deletions
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="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
87+
<p class="firstline">Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.</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 an InsightTypeConfig change. This will create a new revision of the config.</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="getConfig">getConfig(name, x__xgafv=None)</code>
99+
<pre>Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.
100+
101+
Args:
102+
name: string, Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` (required)
103+
x__xgafv: string, V1 error format.
104+
Allowed values
105+
1 - v1 error format
106+
2 - v2 error format
107+
108+
Returns:
109+
An object of the form:
110+
111+
{ # Configuration for an InsightType.
112+
&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.
113+
&quot;a_key&quot;: &quot;A String&quot;,
114+
},
115+
&quot;displayName&quot;: &quot;A String&quot;, # A user-settable field to provide a human-readable name to be used in user interfaces.
116+
&quot;etag&quot;: &quot;A String&quot;, # Fingerprint of the InsightTypeConfig. Provides optimistic locking when updating.
117+
&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.
118+
&quot;params&quot;: { # Parameters for this InsightTypeGenerationConfig. These configs can be used by or are applied to all subtypes.
119+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
120+
},
121+
},
122+
&quot;name&quot;: &quot;A String&quot;, # Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config
123+
&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.
124+
&quot;updateTime&quot;: &quot;A String&quot;, # 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 an InsightTypeConfig change. This will create a new revision of the config.
131+
132+
Args:
133+
name: string, Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config (required)
134+
body: object, The request body.
135+
The object takes the form of:
136+
137+
{ # Configuration for an InsightType.
138+
&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.
139+
&quot;a_key&quot;: &quot;A String&quot;,
140+
},
141+
&quot;displayName&quot;: &quot;A String&quot;, # A user-settable field to provide a human-readable name to be used in user interfaces.
142+
&quot;etag&quot;: &quot;A String&quot;, # Fingerprint of the InsightTypeConfig. Provides optimistic locking when updating.
143+
&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.
144+
&quot;params&quot;: { # Parameters for this InsightTypeGenerationConfig. These configs can be used by or are applied to all subtypes.
145+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
146+
},
147+
},
148+
&quot;name&quot;: &quot;A String&quot;, # Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config
149+
&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.
150+
&quot;updateTime&quot;: &quot;A String&quot;, # 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+
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_v1.billingAccounts.locations.recommenders.html

Lines changed: 89 additions & 0 deletions
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="#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>
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="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+
101+
Args:
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` * `billingAccounts/[BILLING_ACCOUNT_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+
108+
Returns:
109+
An object of the form:
110+
111+
{ # Configuration for a Recommender.
112+
&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.
113+
&quot;a_key&quot;: &quot;A String&quot;,
114+
},
115+
&quot;displayName&quot;: &quot;A String&quot;, # A user-settable field to provide a human-readable name to be used in user interfaces.
116+
&quot;etag&quot;: &quot;A String&quot;, # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
117+
&quot;name&quot;: &quot;A String&quot;, # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
118+
&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.
119+
&quot;params&quot;: { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes.
120+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
121+
},
122+
},
123+
&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.
124+
&quot;updateTime&quot;: &quot;A String&quot;, # 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+
132+
Args:
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+
&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.
139+
&quot;a_key&quot;: &quot;A String&quot;,
140+
},
141+
&quot;displayName&quot;: &quot;A String&quot;, # A user-settable field to provide a human-readable name to be used in user interfaces.
142+
&quot;etag&quot;: &quot;A String&quot;, # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
143+
&quot;name&quot;: &quot;A String&quot;, # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
144+
&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.
145+
&quot;params&quot;: { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes.
146+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
147+
},
148+
},
149+
&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.
150+
&quot;updateTime&quot;: &quot;A String&quot;, # 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+
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>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>Method Details</h3>
9999
<pre>Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.
100100

101101
Args:
102-
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` * `organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` (required)
102+
name: string, Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` (required)
103103
x__xgafv: string, V1 error format.
104104
Allowed values
105105
1 - v1 error format

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>Method Details</h3>
9999
<pre>Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
100100

101101
Args:
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)
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` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` (required)
103103
x__xgafv: string, V1 error format.
104104
Allowed values
105105
1 - v1 error format

docs/dyn/recommender_v1.projects.locations.insightTypes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>Method Details</h3>
9999
<pre>Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.
100100

101101
Args:
102-
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` * `organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` (required)
102+
name: string, Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` (required)
103103
x__xgafv: string, V1 error format.
104104
Allowed values
105105
1 - v1 error format

docs/dyn/recommender_v1.projects.locations.recommenders.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>Method Details</h3>
9999
<pre>Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
100100

101101
Args:
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)
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` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` (required)
103103
x__xgafv: string, V1 error format.
104104
Allowed values
105105
1 - v1 error format

0 commit comments

Comments
 (0)