OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/cloudruntimeconfig": { | 8 "https://www.googleapis.com/auth/cloudruntimeconfig": { |
9 "description": "Manage your Google Cloud Platform services'
runtime configuration" | 9 "description": "Manage your Google Cloud Platform services'
runtime configuration" |
10 } | 10 } |
(...skipping 104 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
115 "type": "string" | 115 "type": "string" |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "projects": { | 120 "projects": { |
121 "resources": { | 121 "resources": { |
122 "configs": { | 122 "configs": { |
123 "methods": { | 123 "methods": { |
124 "update": { | 124 "update": { |
125 "description": "Updates the config resource object.\
nRuntimeConfig object must already exist.", | 125 "description": "Updates a RuntimeConfig resource. Th
e configuration must exist beforehand.", |
126 "httpMethod": "PUT", | 126 "httpMethod": "PUT", |
127 "id": "runtimeconfig.projects.configs.update", | 127 "id": "runtimeconfig.projects.configs.update", |
128 "parameterOrder": [ | 128 "parameterOrder": [ |
129 "name" | 129 "name" |
130 ], | 130 ], |
131 "parameters": { | 131 "parameters": { |
132 "name": { | 132 "name": { |
133 "description": "The name of the config resou
rce to update.\nRequired. Must be a valid config resource.", | 133 "description": "The name of the RuntimeConfi
g resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_N
AME]`", |
134 "location": "path", | 134 "location": "path", |
135 "pattern": "^projects/[^/]*/configs/[^/]*$", | 135 "pattern": "^projects/[^/]*/configs/[^/]*$", |
136 "required": true, | 136 "required": true, |
137 "type": "string" | 137 "type": "string" |
138 } | 138 } |
139 }, | 139 }, |
140 "path": "v1beta1/{+name}", | 140 "path": "v1beta1/{+name}", |
141 "request": { | 141 "request": { |
142 "$ref": "RuntimeConfig" | 142 "$ref": "RuntimeConfig" |
143 }, | 143 }, |
144 "response": { | 144 "response": { |
145 "$ref": "RuntimeConfig" | 145 "$ref": "RuntimeConfig" |
146 }, | 146 }, |
147 "scopes": [ | 147 "scopes": [ |
148 "https://www.googleapis.com/auth/cloud-platform"
, | 148 "https://www.googleapis.com/auth/cloud-platform"
, |
149 "https://www.googleapis.com/auth/cloudruntimecon
fig" | 149 "https://www.googleapis.com/auth/cloudruntimecon
fig" |
150 ] | 150 ] |
151 }, | 151 }, |
152 "get": { | 152 "get": { |
153 "description": "Gets the config resource object.", | 153 "description": "Gets information about a RuntimeConf
ig resource.", |
154 "httpMethod": "GET", | 154 "httpMethod": "GET", |
155 "id": "runtimeconfig.projects.configs.get", | 155 "id": "runtimeconfig.projects.configs.get", |
156 "parameterOrder": [ | 156 "parameterOrder": [ |
157 "name" | 157 "name" |
158 ], | 158 ], |
159 "parameters": { | 159 "parameters": { |
160 "name": { | 160 "name": { |
161 "description": "The name of the RuntimeConfi
g resource object to retrieve.", | 161 "description": "The name of the RuntimeConfi
g resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG
_NAME]`", |
162 "location": "path", | 162 "location": "path", |
163 "pattern": "^projects/[^/]*/configs/[^/]*$", | 163 "pattern": "^projects/[^/]*/configs/[^/]*$", |
164 "required": true, | 164 "required": true, |
165 "type": "string" | 165 "type": "string" |
166 } | 166 } |
167 }, | 167 }, |
168 "path": "v1beta1/{+name}", | 168 "path": "v1beta1/{+name}", |
169 "response": { | 169 "response": { |
170 "$ref": "RuntimeConfig" | 170 "$ref": "RuntimeConfig" |
171 }, | 171 }, |
172 "scopes": [ | 172 "scopes": [ |
173 "https://www.googleapis.com/auth/cloud-platform"
, | 173 "https://www.googleapis.com/auth/cloud-platform"
, |
174 "https://www.googleapis.com/auth/cloudruntimecon
fig" | 174 "https://www.googleapis.com/auth/cloudruntimecon
fig" |
175 ] | 175 ] |
176 }, | 176 }, |
177 "create": { | 177 "create": { |
178 "description": "CreateConfig creates a new config re
source object.\nThe configuration name must be unique within project.", | 178 "description": "Creates a new RuntimeConfig resource
. The configuration name must be\nunique within project.", |
179 "httpMethod": "POST", | 179 "httpMethod": "POST", |
180 "id": "runtimeconfig.projects.configs.create", | 180 "id": "runtimeconfig.projects.configs.create", |
181 "parameterOrder": [ | 181 "parameterOrder": [ |
182 "parent" | 182 "parent" |
183 ], | 183 ], |
184 "parameters": { | 184 "parameters": { |
185 "parent": { | 185 "parent": { |
186 "description": "The cloud project to which c
onfiguration belongs.\nRequired. Must be a valid GCP project.", | 186 "description": "The [project ID](https://sup
port.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request,
in the format `projects/[PROJECT_ID]`.", |
187 "location": "path", | 187 "location": "path", |
188 "pattern": "^projects/[^/]*$", | 188 "pattern": "^projects/[^/]*$", |
189 "required": true, | 189 "required": true, |
190 "type": "string" | 190 "type": "string" |
191 } | 191 } |
192 }, | 192 }, |
193 "path": "v1beta1/{+parent}/configs", | 193 "path": "v1beta1/{+parent}/configs", |
194 "request": { | 194 "request": { |
195 "$ref": "RuntimeConfig" | 195 "$ref": "RuntimeConfig" |
196 }, | 196 }, |
197 "response": { | 197 "response": { |
198 "$ref": "RuntimeConfig" | 198 "$ref": "RuntimeConfig" |
199 }, | 199 }, |
200 "scopes": [ | 200 "scopes": [ |
201 "https://www.googleapis.com/auth/cloud-platform"
, | 201 "https://www.googleapis.com/auth/cloud-platform"
, |
202 "https://www.googleapis.com/auth/cloudruntimecon
fig" | 202 "https://www.googleapis.com/auth/cloudruntimecon
fig" |
203 ] | 203 ] |
204 }, | 204 }, |
205 "list": { | 205 "list": { |
206 "description": "Lists all the config objects within
project.", | 206 "description": "Lists all the RuntimeConfig resource
s within project.", |
207 "httpMethod": "GET", | 207 "httpMethod": "GET", |
208 "id": "runtimeconfig.projects.configs.list", | 208 "id": "runtimeconfig.projects.configs.list", |
209 "parameterOrder": [ | 209 "parameterOrder": [ |
210 "parent" | 210 "parent" |
211 ], | 211 ], |
212 "parameters": { | 212 "parameters": { |
213 "pageSize": { | 213 "pageSize": { |
214 "description": "List pagination support.\nTh
e size of the page to return. We may return fewer elements.", | 214 "description": "Specifies the number of resu
lts to return per page. If there are fewer\nelements than the specified number,
returns all elements.", |
215 "format": "int32", | 215 "format": "int32", |
216 "location": "query", | 216 "location": "query", |
217 "type": "integer" | 217 "type": "integer" |
218 }, | 218 }, |
219 "parent": { | 219 "parent": { |
220 "description": "The cloud project, whose con
figuration resources we want to list.\nRequired. Must be a valid GCP project.", | 220 "description": "The [project ID](https://sup
port.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request,
in the format `projects/[PROJECT_ID]`.", |
221 "location": "path", | 221 "location": "path", |
222 "pattern": "^projects/[^/]*$", | 222 "pattern": "^projects/[^/]*$", |
223 "required": true, | 223 "required": true, |
224 "type": "string" | 224 "type": "string" |
225 }, | 225 }, |
226 "pageToken": { | 226 "pageToken": { |
227 "description": "The token for pagination.", | 227 "description": "Specifies a page token to us
e. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to
get the next page of results.", |
228 "location": "query", | 228 "location": "query", |
229 "type": "string" | 229 "type": "string" |
230 } | 230 } |
231 }, | 231 }, |
232 "path": "v1beta1/{+parent}/configs", | 232 "path": "v1beta1/{+parent}/configs", |
233 "response": { | 233 "response": { |
234 "$ref": "ListConfigsResponse" | 234 "$ref": "ListConfigsResponse" |
235 }, | 235 }, |
236 "scopes": [ | 236 "scopes": [ |
237 "https://www.googleapis.com/auth/cloud-platform"
, | 237 "https://www.googleapis.com/auth/cloud-platform"
, |
238 "https://www.googleapis.com/auth/cloudruntimecon
fig" | 238 "https://www.googleapis.com/auth/cloudruntimecon
fig" |
239 ] | 239 ] |
240 }, | 240 }, |
241 "delete": { | 241 "delete": { |
242 "description": "Deletes the config object.", | 242 "description": "Deletes a RuntimeConfig resource.", |
243 "httpMethod": "DELETE", | 243 "httpMethod": "DELETE", |
244 "id": "runtimeconfig.projects.configs.delete", | 244 "id": "runtimeconfig.projects.configs.delete", |
245 "parameterOrder": [ | 245 "parameterOrder": [ |
246 "name" | 246 "name" |
247 ], | 247 ], |
248 "parameters": { | 248 "parameters": { |
249 "name": { | 249 "name": { |
250 "description": "The configuration resource o
bject to delete.\nRequired. Must be a valid GCP project.", | 250 "description": "The RuntimeConfig resource t
o delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", |
251 "location": "path", | 251 "location": "path", |
252 "pattern": "^projects/[^/]*/configs/[^/]*$", | 252 "pattern": "^projects/[^/]*/configs/[^/]*$", |
253 "required": true, | 253 "required": true, |
254 "type": "string" | 254 "type": "string" |
255 } | 255 } |
256 }, | 256 }, |
257 "path": "v1beta1/{+name}", | 257 "path": "v1beta1/{+name}", |
258 "response": { | 258 "response": { |
259 "$ref": "Empty" | 259 "$ref": "Empty" |
260 }, | 260 }, |
261 "scopes": [ | 261 "scopes": [ |
262 "https://www.googleapis.com/auth/cloud-platform"
, | 262 "https://www.googleapis.com/auth/cloud-platform"
, |
263 "https://www.googleapis.com/auth/cloudruntimecon
fig" | 263 "https://www.googleapis.com/auth/cloudruntimecon
fig" |
264 ] | 264 ] |
265 } | 265 } |
266 }, | 266 }, |
267 "resources": { | 267 "resources": { |
268 "variables": { | 268 "variables": { |
269 "methods": { | 269 "methods": { |
270 "watch": { | 270 "watch": { |
271 "description": "WatchVariable watches for a
variable to change and then returns the new\nvalue or times out.\nIf variable is
deleted while being watched, VariableState will be DELETED\nand the Value will
contain the last known value.\nIf the operation deadline is set to a larger valu
e than internal timeout\nexisting, current variable value will be returned and V
ariable state will\nbe VARIABLE_STATE_UNSPECIFIED.", | 271 "description": "Watches a specific variable
and waits for a change in the variable's value.\nWhen there is a change, this me
thod returns the new value or times out.\n\nIf a variable is deleted while being
watched, the `variableState` state is\nset to `DELETED` and the method returns
the last known variable `value`.\n\nIf you set the deadline for watching to a la
rger value than internal timeout\n(60 seconds), the current variable value is re
turned and the `variableState`\nwill be `VARIABLE_STATE_UNSPECIFIED`.\n\nTo lear
n more about creating a watcher, read the\n[Watching a Variable for Changes](/de
ployment-manager/runtime-configurator/watching-a-variable)\ndocumentation.", |
272 "httpMethod": "POST", | 272 "httpMethod": "POST", |
273 "id": "runtimeconfig.projects.configs.variab
les.watch", | 273 "id": "runtimeconfig.projects.configs.variab
les.watch", |
274 "parameterOrder": [ | 274 "parameterOrder": [ |
275 "name" | 275 "name" |
276 ], | 276 ], |
277 "parameters": { | 277 "parameters": { |
278 "name": { | 278 "name": { |
279 "description": "The name of the vari
able to retrieve.", | 279 "description": "The name of the vari
able to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", |
280 "location": "path", | 280 "location": "path", |
281 "pattern": "^projects/[^/]*/configs/
[^/]*/variables/.*$", | 281 "pattern": "^projects/[^/]*/configs/
[^/]*/variables/.*$", |
282 "required": true, | 282 "required": true, |
283 "type": "string" | 283 "type": "string" |
284 } | 284 } |
285 }, | 285 }, |
286 "path": "v1beta1/{+name}:watch", | 286 "path": "v1beta1/{+name}:watch", |
287 "request": { | 287 "request": { |
288 "$ref": "WatchVariableRequest" | 288 "$ref": "WatchVariableRequest" |
289 }, | 289 }, |
290 "response": { | 290 "response": { |
291 "$ref": "Variable" | 291 "$ref": "Variable" |
292 }, | 292 }, |
293 "scopes": [ | 293 "scopes": [ |
294 "https://www.googleapis.com/auth/cloud-p
latform", | 294 "https://www.googleapis.com/auth/cloud-p
latform", |
295 "https://www.googleapis.com/auth/cloudru
ntimeconfig" | 295 "https://www.googleapis.com/auth/cloudru
ntimeconfig" |
296 ] | 296 ] |
297 }, | 297 }, |
298 "list": { | 298 "list": { |
299 "description": "Lists variables within given
RuntimeConfig object, matching optionally\nprovided filter.\nList contains only
variable metadata, but not values.", | 299 "description": "Lists variables within given
a configuration, matching any provided filters.\nThis only lists variable names
, not the values.", |
300 "httpMethod": "GET", | 300 "httpMethod": "GET", |
301 "id": "runtimeconfig.projects.configs.variab
les.list", | 301 "id": "runtimeconfig.projects.configs.variab
les.list", |
302 "parameterOrder": [ | 302 "parameterOrder": [ |
303 "parent" | 303 "parent" |
304 ], | 304 ], |
305 "parameters": { | 305 "parameters": { |
306 "pageSize": { | 306 "pageSize": { |
307 "description": "List pagination supp
ort.\nThe size of the page to return. We may return fewer elements.", | 307 "description": "Specifies the number
of results to return per page. If there are fewer\nelements than the specified
number, returns all elements.", |
308 "format": "int32", | 308 "format": "int32", |
309 "location": "query", | 309 "location": "query", |
310 "type": "integer" | 310 "type": "integer" |
311 }, | 311 }, |
312 "filter": { | 312 "filter": { |
313 "description": "List only variables
matching filter prefix exactly.\ne.g. `projects/{project_id}/config/{config_id}/
variables/{variable/id}`.", | 313 "description": "Filters variables by
matching the specified filter. For example:\n\n`projects/example-project/config
/[CONFIG_NAME]/variables/example-variable`.", |
314 "location": "query", | 314 "location": "query", |
315 "type": "string" | 315 "type": "string" |
316 }, | 316 }, |
317 "parent": { | 317 "parent": { |
318 "description": "Which RuntimeConfig
object to list for variables.", | 318 "description": "The path to the Runt
imeConfig resource for which you want to list variables.\nThe configuration must
exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/con
figs/[CONFIG_NAME]`", |
319 "location": "path", | 319 "location": "path", |
320 "pattern": "^projects/[^/]*/configs/
[^/]*$", | 320 "pattern": "^projects/[^/]*/configs/
[^/]*$", |
321 "required": true, | 321 "required": true, |
322 "type": "string" | 322 "type": "string" |
323 }, | 323 }, |
324 "pageToken": { | 324 "pageToken": { |
325 "description": "The token for pagina
tion.", | 325 "description": "Specifies a page tok
en to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list req
uest to get the next page of results.", |
326 "location": "query", | 326 "location": "query", |
327 "type": "string" | 327 "type": "string" |
328 } | 328 } |
329 }, | 329 }, |
330 "path": "v1beta1/{+parent}/variables", | 330 "path": "v1beta1/{+parent}/variables", |
331 "response": { | 331 "response": { |
332 "$ref": "ListVariablesResponse" | 332 "$ref": "ListVariablesResponse" |
333 }, | 333 }, |
334 "scopes": [ | 334 "scopes": [ |
335 "https://www.googleapis.com/auth/cloud-p
latform", | 335 "https://www.googleapis.com/auth/cloud-p
latform", |
336 "https://www.googleapis.com/auth/cloudru
ntimeconfig" | 336 "https://www.googleapis.com/auth/cloudru
ntimeconfig" |
337 ] | 337 ] |
338 }, | 338 }, |
339 "get": { | 339 "get": { |
340 "description": "Gets the variable resource o
bject.", | 340 "description": "Gets information about a sin
gle variable.", |
341 "httpMethod": "GET", | 341 "httpMethod": "GET", |
342 "id": "runtimeconfig.projects.configs.variab
les.get", | 342 "id": "runtimeconfig.projects.configs.variab
les.get", |
343 "parameterOrder": [ | 343 "parameterOrder": [ |
344 "name" | 344 "name" |
345 ], | 345 ], |
346 "parameters": { | 346 "parameters": { |
347 "name": { | 347 "name": { |
348 "description": "What variable to ret
urn.", | 348 "description": "The name of the vari
able to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/v
ariables/[VARIBLE_NAME]`", |
349 "location": "path", | 349 "location": "path", |
350 "pattern": "^projects/[^/]*/configs/
[^/]*/variables/.*$", | 350 "pattern": "^projects/[^/]*/configs/
[^/]*/variables/.*$", |
351 "required": true, | 351 "required": true, |
352 "type": "string" | 352 "type": "string" |
353 } | 353 } |
354 }, | 354 }, |
355 "path": "v1beta1/{+name}", | 355 "path": "v1beta1/{+name}", |
356 "response": { | 356 "response": { |
357 "$ref": "Variable" | 357 "$ref": "Variable" |
358 }, | 358 }, |
359 "scopes": [ | 359 "scopes": [ |
360 "https://www.googleapis.com/auth/cloud-p
latform", | 360 "https://www.googleapis.com/auth/cloud-p
latform", |
361 "https://www.googleapis.com/auth/cloudru
ntimeconfig" | 361 "https://www.googleapis.com/auth/cloudru
ntimeconfig" |
362 ] | 362 ] |
363 }, | 363 }, |
364 "create": { | 364 "create": { |
365 "description": "Creates a variable within th
e given configuration.\nCreate variable will create all required intermediate pa
th elements.\nIt is a FAILED_PRECONDITION error to create a variable with a name
that is\na prefix of an existing variable name, or that has an existing variabl
e\nname as a prefix.", | 365 "description": "Creates a variable within th
e given configuration. You cannot create\na variable with a name that is a prefi
x of an existing variable name, or a\nname that has an existing variable name as
a prefix.\n\nTo learn more about creating a variable, read the\n[Setting and Ge
tting Data](/deployment-manager/runtime-configurator/seta-and-get-variables)\ndo
cumentation.", |
366 "httpMethod": "POST", | 366 "httpMethod": "POST", |
367 "id": "runtimeconfig.projects.configs.variab
les.create", | 367 "id": "runtimeconfig.projects.configs.variab
les.create", |
368 "parameterOrder": [ | 368 "parameterOrder": [ |
369 "parent" | 369 "parent" |
370 ], | 370 ], |
371 "parameters": { | 371 "parameters": { |
372 "parent": { | 372 "parent": { |
373 "description": "The configuration pa
rent, that will own the variable.\nRequired, must a valid configuration name wit
hin project_id.", | 373 "description": "The path to the Ruti
meConfig resource that this variable should belong to.\nThe configuration must e
xist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/confi
gs/[CONFIG_NAME]`", |
374 "location": "path", | 374 "location": "path", |
375 "pattern": "^projects/[^/]*/configs/
[^/]*$", | 375 "pattern": "^projects/[^/]*/configs/
[^/]*$", |
376 "required": true, | 376 "required": true, |
377 "type": "string" | 377 "type": "string" |
378 } | 378 } |
379 }, | 379 }, |
380 "path": "v1beta1/{+parent}/variables", | 380 "path": "v1beta1/{+parent}/variables", |
381 "request": { | 381 "request": { |
382 "$ref": "Variable" | 382 "$ref": "Variable" |
383 }, | 383 }, |
384 "response": { | 384 "response": { |
385 "$ref": "Variable" | 385 "$ref": "Variable" |
386 }, | 386 }, |
387 "scopes": [ | 387 "scopes": [ |
388 "https://www.googleapis.com/auth/cloud-p
latform", | 388 "https://www.googleapis.com/auth/cloud-p
latform", |
389 "https://www.googleapis.com/auth/cloudru
ntimeconfig" | 389 "https://www.googleapis.com/auth/cloudru
ntimeconfig" |
390 ] | 390 ] |
391 }, | 391 }, |
392 "update": { | 392 "update": { |
393 "description": "Updates an existing variable
with a new value.", | 393 "description": "Updates an existing variable
with a new value.", |
394 "httpMethod": "PUT", | 394 "httpMethod": "PUT", |
395 "id": "runtimeconfig.projects.configs.variab
les.update", | 395 "id": "runtimeconfig.projects.configs.variab
les.update", |
396 "parameterOrder": [ | 396 "parameterOrder": [ |
397 "name" | 397 "name" |
398 ], | 398 ], |
399 "parameters": { | 399 "parameters": { |
400 "name": { | 400 "name": { |
401 "description": "The name of the vari
able to update.\nIn the format of:\n\"projects/{project_id}/configs/{config_id}/
variables/{variable_id}\"", | 401 "description": "The name of the vari
able to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/v
ariables/[VARIABLE_NAME]`", |
402 "location": "path", | 402 "location": "path", |
403 "pattern": "^projects/[^/]*/configs/
[^/]*/variables/.*$", | 403 "pattern": "^projects/[^/]*/configs/
[^/]*/variables/.*$", |
404 "required": true, | 404 "required": true, |
405 "type": "string" | 405 "type": "string" |
406 } | 406 } |
407 }, | 407 }, |
408 "path": "v1beta1/{+name}", | 408 "path": "v1beta1/{+name}", |
409 "request": { | 409 "request": { |
410 "$ref": "Variable" | 410 "$ref": "Variable" |
411 }, | 411 }, |
412 "response": { | 412 "response": { |
413 "$ref": "Variable" | 413 "$ref": "Variable" |
414 }, | 414 }, |
415 "scopes": [ | 415 "scopes": [ |
416 "https://www.googleapis.com/auth/cloud-p
latform", | 416 "https://www.googleapis.com/auth/cloud-p
latform", |
417 "https://www.googleapis.com/auth/cloudru
ntimeconfig" | 417 "https://www.googleapis.com/auth/cloudru
ntimeconfig" |
418 ] | 418 ] |
419 }, | 419 }, |
420 "delete": { | 420 "delete": { |
421 "description": "Deletes variable or variable
s.\nIf name denotes a variable, that variable is deleted. If name is a prefix\na
nd recursive is true, then all variables with that prefix are deleted,\nit's a F
AILED_PRECONDITION to delete a prefix without recursive being true.", | 421 "description": "Deletes a variable or multip
le variables.\n\nIf you specify a variable name, then that variable is deleted.
If you\nspecify a prefix and `recursive` is true, then all variables with that\n
prefix are deleted. You must set a `recursive` to true if you delete\nvariables
by prefix.", |
422 "httpMethod": "DELETE", | 422 "httpMethod": "DELETE", |
423 "id": "runtimeconfig.projects.configs.variab
les.delete", | 423 "id": "runtimeconfig.projects.configs.variab
les.delete", |
424 "parameterOrder": [ | 424 "parameterOrder": [ |
425 "name" | 425 "name" |
426 ], | 426 ], |
427 "parameters": { | 427 "parameters": { |
428 "recursive": { | 428 "recursive": { |
429 "description": "If recursive is fals
e and name is a prefix of other variables, then\nthe request will fail.", | 429 "description": "Set to `true` to rec
ursively delete multiple variables with the same\nprefix.", |
430 "location": "query", | 430 "location": "query", |
431 "type": "boolean" | 431 "type": "boolean" |
432 }, | 432 }, |
433 "name": { | 433 "name": { |
434 "description": "The name of the vari
able to delete.", | 434 "description": "The name of the vari
able to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/v
ariables/[VARIABLE_NAME]`", |
435 "location": "path", | 435 "location": "path", |
436 "pattern": "^projects/[^/]*/configs/
[^/]*/variables/.*$", | 436 "pattern": "^projects/[^/]*/configs/
[^/]*/variables/.*$", |
437 "required": true, | 437 "required": true, |
438 "type": "string" | 438 "type": "string" |
439 } | 439 } |
440 }, | 440 }, |
441 "path": "v1beta1/{+name}", | 441 "path": "v1beta1/{+name}", |
442 "response": { | 442 "response": { |
443 "$ref": "Empty" | 443 "$ref": "Empty" |
444 }, | 444 }, |
445 "scopes": [ | 445 "scopes": [ |
446 "https://www.googleapis.com/auth/cloud-p
latform", | 446 "https://www.googleapis.com/auth/cloud-p
latform", |
447 "https://www.googleapis.com/auth/cloudru
ntimeconfig" | 447 "https://www.googleapis.com/auth/cloudru
ntimeconfig" |
448 ] | 448 ] |
449 } | 449 } |
450 } | 450 } |
451 }, | 451 }, |
452 "waiters": { | 452 "waiters": { |
453 "methods": { | 453 "methods": { |
454 "get": { | 454 "get": { |
455 "description": "Gets the Waiter resource wit
h the specified name.", | 455 "description": "Gets information about a sin
gle waiter.", |
456 "httpMethod": "GET", | 456 "httpMethod": "GET", |
457 "id": "runtimeconfig.projects.configs.waiter
s.get", | 457 "id": "runtimeconfig.projects.configs.waiter
s.get", |
458 "parameterOrder": [ | 458 "parameterOrder": [ |
459 "name" | 459 "name" |
460 ], | 460 ], |
461 "parameters": { | 461 "parameters": { |
462 "name": { | 462 "name": { |
463 "description": "The fully-qualified
name of the Waiter resource object to retrieve.", | 463 "description": "The fully-qualified
name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PR
OJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", |
464 "location": "path", | 464 "location": "path", |
465 "pattern": "^projects/[^/]*/configs/
[^/]*/waiters/[^/]*$", | 465 "pattern": "^projects/[^/]*/configs/
[^/]*/waiters/[^/]*$", |
466 "required": true, | 466 "required": true, |
467 "type": "string" | 467 "type": "string" |
468 } | 468 } |
469 }, | 469 }, |
470 "path": "v1beta1/{+name}", | 470 "path": "v1beta1/{+name}", |
471 "response": { | 471 "response": { |
472 "$ref": "Waiter" | 472 "$ref": "Waiter" |
473 }, | 473 }, |
474 "scopes": [ | 474 "scopes": [ |
475 "https://www.googleapis.com/auth/cloud-p
latform", | 475 "https://www.googleapis.com/auth/cloud-p
latform", |
476 "https://www.googleapis.com/auth/cloudru
ntimeconfig" | 476 "https://www.googleapis.com/auth/cloudru
ntimeconfig" |
477 ] | 477 ] |
478 }, | 478 }, |
479 "create": { | 479 "create": { |
480 "description": "Creates a Waiter resource. T
his operation returns a long-running Operation\nresource which can be polled for
completion. However, a Waiter with the\ngiven name will exist (and can be retri
eved) prior to the resultant\nOperation completing. If the resultant Operation i
ndicates a failure, the\nfailed Waiter resource will still exist and must be del
eted prior to\nsubsequent creation attempts.", | 480 "description": "Creates a Waiter resource. T
his operation returns a long-running Operation\nresource which can be polled for
completion. However, a waiter with the\ngiven name will exist (and can be retri
eved) prior to the operation\ncompleting. If the operation fails, the failed Wai
ter resource will\nstill exist and must be deleted prior to subsequent creation
attempts.", |
481 "httpMethod": "POST", | 481 "httpMethod": "POST", |
482 "id": "runtimeconfig.projects.configs.waiter
s.create", | 482 "id": "runtimeconfig.projects.configs.waiter
s.create", |
483 "parameterOrder": [ | 483 "parameterOrder": [ |
484 "parent" | 484 "parent" |
485 ], | 485 ], |
486 "parameters": { | 486 "parameters": { |
487 "parent": { | 487 "parent": { |
488 "description": "The fully-qualified
name of the configuration that will own the waiter.\nRequired. Must be a valid c
onfiguration name.", | 488 "description": "The path to the conf
iguration that will own the waiter.\nThe configuration must exist beforehand; th
e path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`."
, |
489 "location": "path", | 489 "location": "path", |
490 "pattern": "^projects/[^/]*/configs/
[^/]*$", | 490 "pattern": "^projects/[^/]*/configs/
[^/]*$", |
491 "required": true, | 491 "required": true, |
492 "type": "string" | 492 "type": "string" |
493 } | 493 } |
494 }, | 494 }, |
495 "path": "v1beta1/{+parent}/waiters", | 495 "path": "v1beta1/{+parent}/waiters", |
496 "request": { | 496 "request": { |
497 "$ref": "Waiter" | 497 "$ref": "Waiter" |
498 }, | 498 }, |
499 "response": { | 499 "response": { |
500 "$ref": "Operation" | 500 "$ref": "Operation" |
501 }, | 501 }, |
502 "scopes": [ | 502 "scopes": [ |
503 "https://www.googleapis.com/auth/cloud-p
latform", | 503 "https://www.googleapis.com/auth/cloud-p
latform", |
504 "https://www.googleapis.com/auth/cloudru
ntimeconfig" | 504 "https://www.googleapis.com/auth/cloudru
ntimeconfig" |
505 ] | 505 ] |
506 }, | 506 }, |
507 "list": { | 507 "list": { |
508 "description": "List Waiters within the give
n RuntimeConfig resource.", | 508 "description": "List waiters within the give
n configuration.", |
509 "httpMethod": "GET", | 509 "httpMethod": "GET", |
510 "id": "runtimeconfig.projects.configs.waiter
s.list", | 510 "id": "runtimeconfig.projects.configs.waiter
s.list", |
511 "parameterOrder": [ | 511 "parameterOrder": [ |
512 "parent" | 512 "parent" |
513 ], | 513 ], |
514 "parameters": { | 514 "parameters": { |
515 "pageSize": { | 515 "pageSize": { |
516 "description": "List pagination supp
ort.\nThe size of the page to return. We may return fewer elements.", | 516 "description": "Specifies the number
of results to return per page. If there are fewer\nelements than the specified
number, returns all elements.", |
517 "format": "int32", | 517 "format": "int32", |
518 "location": "query", | 518 "location": "query", |
519 "type": "integer" | 519 "type": "integer" |
520 }, | 520 }, |
521 "parent": { | 521 "parent": { |
522 "description": "The fully-qualified
name of the configuration to list.\nRequired. Must be a valid configuration name
.", | 522 "description": "The path to the conf
iguration for which you want to get a list of waiters.\nThe configuration must e
xist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/confi
gs/[CONFIG_NAME]`", |
523 "location": "path", | 523 "location": "path", |
524 "pattern": "^projects/[^/]*/configs/
[^/]*$", | 524 "pattern": "^projects/[^/]*/configs/
[^/]*$", |
525 "required": true, | 525 "required": true, |
526 "type": "string" | 526 "type": "string" |
527 }, | 527 }, |
528 "pageToken": { | 528 "pageToken": { |
529 "description": "The token for pagina
tion.", | 529 "description": "Specifies a page tok
en to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list req
uest to get the next page of results.", |
530 "location": "query", | 530 "location": "query", |
531 "type": "string" | 531 "type": "string" |
532 } | 532 } |
533 }, | 533 }, |
534 "path": "v1beta1/{+parent}/waiters", | 534 "path": "v1beta1/{+parent}/waiters", |
535 "response": { | 535 "response": { |
536 "$ref": "ListWaitersResponse" | 536 "$ref": "ListWaitersResponse" |
537 }, | 537 }, |
538 "scopes": [ | 538 "scopes": [ |
539 "https://www.googleapis.com/auth/cloud-p
latform", | 539 "https://www.googleapis.com/auth/cloud-p
latform", |
540 "https://www.googleapis.com/auth/cloudru
ntimeconfig" | 540 "https://www.googleapis.com/auth/cloudru
ntimeconfig" |
541 ] | 541 ] |
542 }, | 542 }, |
543 "delete": { | 543 "delete": { |
544 "description": "Deletes the Waiter with the
specified name.", | 544 "description": "Deletes the waiter with the
specified name.", |
545 "httpMethod": "DELETE", | 545 "httpMethod": "DELETE", |
546 "id": "runtimeconfig.projects.configs.waiter
s.delete", | 546 "id": "runtimeconfig.projects.configs.waiter
s.delete", |
547 "parameterOrder": [ | 547 "parameterOrder": [ |
548 "name" | 548 "name" |
549 ], | 549 ], |
550 "parameters": { | 550 "parameters": { |
551 "name": { | 551 "name": { |
552 "description": "The Waiter resource
to delete.", | 552 "description": "The Waiter resource
to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waite
rs/[WAITER_NAME]`", |
553 "location": "path", | 553 "location": "path", |
554 "pattern": "^projects/[^/]*/configs/
[^/]*/waiters/[^/]*$", | 554 "pattern": "^projects/[^/]*/configs/
[^/]*/waiters/[^/]*$", |
555 "required": true, | 555 "required": true, |
556 "type": "string" | 556 "type": "string" |
557 } | 557 } |
558 }, | 558 }, |
559 "path": "v1beta1/{+name}", | 559 "path": "v1beta1/{+name}", |
560 "response": { | 560 "response": { |
561 "$ref": "Empty" | 561 "$ref": "Empty" |
562 }, | 562 }, |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
594 "https://www.googleapis.com/auth/cloudru
ntimeconfig" | 594 "https://www.googleapis.com/auth/cloudru
ntimeconfig" |
595 ] | 595 ] |
596 } | 596 } |
597 } | 597 } |
598 } | 598 } |
599 } | 599 } |
600 } | 600 } |
601 } | 601 } |
602 } | 602 } |
603 }, | 603 }, |
604 "revision": "20160518", | 604 "revision": "20160524", |
605 "rootUrl": "https://runtimeconfig.googleapis.com/", | 605 "rootUrl": "https://runtimeconfig.googleapis.com/", |
606 "schemas": { | 606 "schemas": { |
607 "Status": { | 607 "Status": { |
608 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\
n\nThe error model and the `Status` message can be used in a variety of\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", | 608 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\
n\nThe error model and the `Status` message can be used in a variety of\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", |
609 "id": "Status", | 609 "id": "Status", |
610 "properties": { | 610 "properties": { |
611 "code": { | 611 "code": { |
612 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | 612 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
613 "format": "int32", | 613 "format": "int32", |
614 "type": "integer" | 614 "type": "integer" |
(...skipping 10 matching lines...) Expand all Loading... |
625 "type": "array" | 625 "type": "array" |
626 }, | 626 }, |
627 "message": { | 627 "message": { |
628 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", | 628 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
629 "type": "string" | 629 "type": "string" |
630 } | 630 } |
631 }, | 631 }, |
632 "type": "object" | 632 "type": "object" |
633 }, | 633 }, |
634 "ListConfigsResponse": { | 634 "ListConfigsResponse": { |
635 "description": "Response for the `ListConfigs()` method.\nOrder of r
eturned configuration objects is arbitrary.", | |
636 "id": "ListConfigsResponse", | 635 "id": "ListConfigsResponse", |
637 "properties": { | 636 "properties": { |
638 "nextPageToken": { | 637 "nextPageToken": { |
639 "description": "Pagination support.", | 638 "description": "This token allows you to get the next page o
f results for list requests.\nIf the number of results is larger than `pageSize`
, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the
next list request.\nSubsequent list requests will have their own `nextPageToken
` to continue\npaging through the results", |
640 "type": "string" | 639 "type": "string" |
641 }, | 640 }, |
642 "configs": { | 641 "configs": { |
643 "description": "Found configurations in the project.", | 642 "description": "A list of the configurations in the project.
The order of returned\nobjects is arbitrary; that is, it is not ordered in any
particular way.", |
644 "items": { | 643 "items": { |
645 "$ref": "RuntimeConfig" | 644 "$ref": "RuntimeConfig" |
646 }, | 645 }, |
647 "type": "array" | 646 "type": "array" |
648 } | 647 } |
649 }, | 648 }, |
650 "type": "object" | 649 "type": "object" |
651 }, | 650 }, |
652 "Variable": { | 651 "Variable": { |
653 "description": "Variable message describes a single variable within
a Configuration object.\nname denotes the hierarchical variable name, e.g.\nport
s/serving_port within flags configuration object.\nValue is an opaque string and
only leaf variables can have values.", | 652 "description": "Describes a single variable within a RuntimeConfig r
esource.\nThe name denotes the hierarchical variable name. For example,\n`ports/
serving_port` is a valid variable name. The variable value is an\nopaque string
and only leaf variables can have values (that is, variables\nthat do not have an
y child variables).", |
654 "id": "Variable", | 653 "id": "Variable", |
655 "properties": { | 654 "properties": { |
656 "value": { | 655 "value": { |
657 "description": "`len(value)` must be less than 4096 bytes. E
mpty values are also accepted.\nvalue must be Base64 encoded.", | 656 "description": "The value of the variable. The length of the
value must be less than 4096\nbytes. Empty values are also accepted. The value
must be Base64 encoded.", |
658 "format": "byte", | 657 "format": "byte", |
659 "type": "string" | 658 "type": "string" |
660 }, | 659 }, |
661 "updateTime": { | 660 "updateTime": { |
662 "description": "[Output Only] The time of the last variable
update.", | 661 "description": "[Output Only] The time of the last variable
update.", |
663 "format": "google-datetime", | 662 "format": "google-datetime", |
664 "type": "string" | 663 "type": "string" |
665 }, | 664 }, |
666 "state": { | 665 "state": { |
667 "description": "[Ouput only] The current state of the variab
le.\nState denotes the outcome of the Watch call and is unset by the Get/List\nc
alls.", | 666 "description": "[Ouput only] The current state of the variab
le. The variable state indicates\nthe outcome of the `variables().watch` call an
d is visible through the\n`get` and `list` calls.", |
668 "enum": [ | 667 "enum": [ |
669 "VARIABLE_STATE_UNSPECIFIED", | 668 "VARIABLE_STATE_UNSPECIFIED", |
670 "UPDATED", | 669 "UPDATED", |
671 "DELETED" | 670 "DELETED" |
672 ], | 671 ], |
673 "enumDescriptions": [ | 672 "enumDescriptions": [ |
674 "Default variable state.", | 673 "Default variable state.", |
675 "Variable had been updated, while watch was executing.", | 674 "The variable was updated, while `variables().watch` was
executing.", |
676 "Variable had been deleted, while watch was executing." | 675 "The variable was deleted, while `variables().watch` was
executing." |
677 ], | 676 ], |
678 "type": "string" | 677 "type": "string" |
679 }, | 678 }, |
680 "name": { | 679 "name": { |
681 "description": "Name of the variable resource.\nIt has forma
t of\n\"projects/{project_id}/configs/{config_id}/variables/{variable_id}\",\nWh
ere `project_id` must be a valid Google Cloud project ID, `config_id`\nmust be a
valid RuntimeConfig object and `variable_id` follows Unix\nfile system file pat
h naming.\n`variable_id` can contain ASCII letters, numbers, slashes and dashes.
\nSlashes are used as path element separators and are not part of the\n`variable
_id` itself, so `variable_id` must contain at least one non-slash\ncharacter. Mu
ltiple slashes are coalesced into single slash character.\nEach path segment sho
uld follow RFC 1035 segment specification.\n`len(variable_id)` must be less than
256 bytes.\nThe name is assigned by the client, but will be validated on the se
rver\nside to adhere to the format.\nName is immutable and cannot be changed.", | 680 "description": "The name of the variable resource, in the fo
rmat:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAM
E]\n\nThe `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a\n
valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system\nfile
path naming.\n\nThe `[VARIABLE_NAME]` can contain ASCII letters, numbers, slash
es and\ndashes. Slashes are used as path element separators and are not part of
the\n`[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one\nn
on-slash character. Multiple slashes are coalesced into single slash\ncharacter.
Each path segment should follow RFC 1035 segment specification.\nThe length of
a `[VARIABLE_NAME]` must be less than 256 bytes.\n\nOnce you create a variable,
you cannot change the variable name.", |
682 "type": "string" | 681 "type": "string" |
683 } | 682 } |
684 }, | 683 }, |
685 "type": "object" | 684 "type": "object" |
686 }, | 685 }, |
687 "Operation": { | 686 "Operation": { |
688 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", | 687 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
689 "id": "Operation", | 688 "id": "Operation", |
690 "properties": { | 689 "properties": { |
691 "error": { | 690 "error": { |
(...skipping 21 matching lines...) Expand all Loading... |
713 "type": "object" | 712 "type": "object" |
714 }, | 713 }, |
715 "name": { | 714 "name": { |
716 "description": "The server-assigned name, which is only uniq
ue within the same service that\noriginally returns it. If you use the default H
TTP mapping, the\n`name` should have the format of `operations/some/unique/name`
.", | 715 "description": "The server-assigned name, which is only uniq
ue within the same service that\noriginally returns it. If you use the default H
TTP mapping, the\n`name` should have the format of `operations/some/unique/name`
.", |
717 "type": "string" | 716 "type": "string" |
718 } | 717 } |
719 }, | 718 }, |
720 "type": "object" | 719 "type": "object" |
721 }, | 720 }, |
722 "Waiter": { | 721 "Waiter": { |
723 "description": "A Waiter resource waits for some condition within a
RuntimeConfig resource\nto be met. For example: each node in a distributed syste
m startup process\nwrites a value to a Variable resource indicating its readines
s. A Waiter\nconfigured with the proper `success` condition can be used to wait
until\nsome number of nodes have checked in.\nOnce created, a Waiter resource is
immutable.", | 722 "description": "A Waiter resource waits for some end condition withi
n a RuntimeConfig resource\nto be met before it returns. For example, assume you
have a distributed\nsystem where each node writes to a Variable resource indidi
cating the node's\nreadiness as part of the startup process.\n\nYou then configu
re a Waiter resource with the success condition set to wait\nuntil some number o
f nodes have checked in. Afterwards, your application\nruns some arbitrary code
after the condition has been met and the waiter\nreturns successfully.\n\nOnce c
reated, a Waiter resource is immutable.\n\nTo learn more about using waiters, re
ad the\n[Creating a Waiter](/deployment-manager/runtime-config/creating-a-water)
\ndocumentation.", |
724 "id": "Waiter", | 723 "id": "Waiter", |
725 "properties": { | 724 "properties": { |
726 "timeout": { | 725 "timeout": { |
727 "description": "The timeout, beginning from the instant that
CreateWaiter is called. If\nthis timeout elapses prior to the success or failur
e conditions being met,\nthe Waiter will fail and the `error` code will be set t
o DEADLINE_EXCEEDED.\nRequired.", | 726 "description": "[Required] Specifies the timeout of the wait
er in seconds, beginning from\nthe instant that `waiters().create` method is cal
led. If this time elapses\nbefore the success or failure conditions are met, the
waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.", |
728 "format": "google-duration", | 727 "format": "google-duration", |
729 "type": "string" | 728 "type": "string" |
730 }, | 729 }, |
731 "success": { | 730 "success": { |
732 "$ref": "EndCondition", | 731 "$ref": "EndCondition", |
733 "description": "The success condition. If this condition is
met, `done` will be set to\n`true` and the `error` value will remain unset. The
failure condition\ntakes precedence over the success condition. If both conditio
ns are met, a\nfailure will be indicated. Required." | 732 "description": "[Required] The success condition. If this co
ndition is met, `done` will be\nset to `true` and the `error` value will remain
unset. The failure condition\ntakes precedence over the success condition. If bo
th conditions are met, a\nfailure will be indicated." |
734 }, | 733 }, |
735 "failure": { | 734 "failure": { |
736 "$ref": "EndCondition", | 735 "$ref": "EndCondition", |
737 "description": "The failure condition. If this condition is
met, `done` will be set to\n`true` and the `error` code will be set to ABORTED.
The failure condition\ntakes precedence over the success condition. If both cond
itions are met, a\nfailure will be indicated. This value is optional; if no fail
ure condition\nis set, the only failure scenario will be a timeout. Optional." | 736 "description": "[Optional] The failure condition of this wai
ter. If this condition is met,\n`done` will be set to `true` and the `error` cod
e will be set to `ABORTED`.\nThe failure condition takes precedence over the suc
cess condition. If both\nconditions are met, a failure will be indicated. This v
alue is optional; if\nno failure condition is set, the only failure scenario wil
l be a timeout." |
738 }, | 737 }, |
739 "createTime": { | 738 "createTime": { |
740 "description": "The instant at which this Waiter was created
. Adding the value of `timeout`\nto this instant yields the timeout deadline for
this Waiter. Output only.", | 739 "description": "[Output Only] The instant at which this Wait
er resource was created. Adding\nthe value of `timeout` to this instant yields t
he timeout deadline for the\nwaiter.", |
741 "format": "google-datetime", | 740 "format": "google-datetime", |
742 "type": "string" | 741 "type": "string" |
743 }, | 742 }, |
744 "name": { | 743 "name": { |
745 "description": "Name of the variable resource.\nIt has forma
t of\n\"projects/{project_id}/configs/{config_id}/waiters/{waiter_id}\",\nWhere
`project_id` must be a valid Google Cloud project ID, `config_id`\nmust be a val
id RuntimeConfig object and the `waiter_id` must match\nRFC 1035 segment specifi
cation, and `len(waiter_id)` must be less than\n64 bytes.\nThe name is assigned
by the client, but will be validated on the server\nside to adhere to the format
.\nName is immutable and cannot be changed. Required.", | 744 "description": "The name of the Waiter resource, in the form
at:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\n
The `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]`
must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 103
5 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64
bytes.\n\nAfter you create a Waiter resource, you cannot change the resource na
me.", |
746 "type": "string" | 745 "type": "string" |
747 }, | 746 }, |
748 "error": { | 747 "error": { |
749 "$ref": "Status", | 748 "$ref": "Status", |
750 "description": "If the Waiter ended due to a failure or time
out, this value will be set.\nOutput only.\n" | 749 "description": "[Output Only] If the waiter ended due to a f
ailure or timeout, this value\nwill be set.\n" |
751 }, | 750 }, |
752 "done": { | 751 "done": { |
753 "description": "If the value is `false`, it means the Waiter
is still waiting for one of\nits conditions to be met.\nIf true, the Waiter has
finished. If the Waiter finished due to a timeout\nor failure, `error` will be
set. Output only.", | 752 "description": "[Output Only] If the value is `false`, it me
ans the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true
, the waiter has finished. If the waiter finished due to a timeout\nor failure,
`error` will be set.", |
754 "type": "boolean" | 753 "type": "boolean" |
755 } | 754 } |
756 }, | 755 }, |
757 "type": "object" | 756 "type": "object" |
758 }, | 757 }, |
759 "RuntimeConfig": { | 758 "RuntimeConfig": { |
760 "description": "RuntimeConfig is the primary resource in the Configu
ration service.\nIt consists of metadata and a hierarchy of variables.", | 759 "description": "A RuntimeConfig resource is the primary resource in
the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata
and a hierarchy of\nvariables.", |
761 "id": "RuntimeConfig", | 760 "id": "RuntimeConfig", |
762 "properties": { | 761 "properties": { |
763 "description": { | 762 "description": { |
764 "description": "Description of the configuration object.\n`l
en(description)` must be less than 256.", | 763 "description": "An optional description of the RuntimeConfig
object.\nThe length of the description must be less than 256 bytes.", |
765 "type": "string" | 764 "type": "string" |
766 }, | 765 }, |
767 "name": { | 766 "name": { |
768 "description": "The resource name of a runtime config.\nIt h
as the format of \"projects/{project_id}/configs/{config_id}\",\nwhere `project_
id` is a valid Google cloud project ID, and the\n`config_id` must match RFC 1035
segment specification, and\n`len(config_id)` must be less than 64 bytes.\nThe n
ame is assigned by the client, but will be validated on the server\nside to adhe
re to the format.\nName is immutable and cannot be changed.", | 767 "description": "The resource name of a runtime config. The n
ame must have the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]\n\n
The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an\narbitr
ary name that matches RFC 1035 segment specification. The length of\n`[CONFIG_NA
ME]` must be less than 64 bytes.\n\nYou pick the RuntimeConfig resource name, bu
t the server will validate that\nthe name adheres to this format. After you crea
te the resource, you cannot\nchange the resource's name.", |
769 "type": "string" | 768 "type": "string" |
770 } | 769 } |
771 }, | 770 }, |
772 "type": "object" | 771 "type": "object" |
773 }, | 772 }, |
774 "ListWaitersResponse": { | 773 "ListWaitersResponse": { |
775 "description": "Response for the `ListWaiters()` method.\nOrder of r
eturned waiter objects is arbitrary.", | 774 "description": "Response for the `ListWaiters()` method.\nOrder of r
eturned waiter objects is arbitrary.", |
776 "id": "ListWaitersResponse", | 775 "id": "ListWaitersResponse", |
777 "properties": { | 776 "properties": { |
778 "nextPageToken": { | 777 "nextPageToken": { |
779 "description": "Pagination support.", | 778 "description": "This token allows you to get the next page o
f results for list requests.\nIf the number of results is larger than `pageSize`
, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the
next list request.\nSubsequent list requests will have their own `nextPageToken
` to continue\npaging through the results", |
780 "type": "string" | 779 "type": "string" |
781 }, | 780 }, |
782 "waiters": { | 781 "waiters": { |
783 "description": "Found waiters in the project.", | 782 "description": "Found waiters in the project.", |
784 "items": { | 783 "items": { |
785 "$ref": "Waiter" | 784 "$ref": "Waiter" |
786 }, | 785 }, |
787 "type": "array" | 786 "type": "array" |
788 } | 787 } |
789 }, | 788 }, |
790 "type": "object" | 789 "type": "object" |
791 }, | 790 }, |
792 "EndCondition": { | 791 "EndCondition": { |
793 "description": "A condition that a Waiter resource is waiting for. T
he set of possible\nconditions may expand over time.", | 792 "description": "The condition that a Waiter resource is waiting for.
", |
794 "id": "EndCondition", | 793 "id": "EndCondition", |
795 "properties": { | 794 "properties": { |
796 "cardinality": { | 795 "cardinality": { |
797 "$ref": "Cardinality", | 796 "$ref": "Cardinality", |
798 "description": "The Cardinality condition type configuration
." | 797 "description": "The cardinality of the `EndCondition`." |
799 } | 798 } |
800 }, | 799 }, |
801 "type": "object" | 800 "type": "object" |
802 }, | 801 }, |
803 "Cardinality": { | 802 "Cardinality": { |
804 "description": "The Cardinality condition is met when the count of `
Variable` resources\nunder the specified path prefix reaches the specified numbe
r.\nFor example, take the following variables in a RuntimeConfig object:\n /foo
/variable1 = \"value1\"\n /foo/variable2 = \"value2\"\n /bar/variable3 = \"val
ue3\"\n\nThese variables would satisfy a Cardinality condition with `path` set t
o\n\"/foo\" and `number` set to 2, but would not satisify the same condition\nwi
th `number` set to 3.", | 803 "description": "A Cardinality condition for the Waiter resource. A c
ardinality condition is\nmet when the number of variables under a specified path
prefix reaches a\npredefined number. For example, if you set a Cardinality cond
ition where\nthe `path` is set to `/foo` and the number of paths is set to 2, th
e\nfollowing variables would meet the condition in a RuntimeConfig resource:\n\n
+ `/foo/variable1 = \"value1\"`\n+ `/foo/variable2 = \"value2\"`\n+ `/bar/variab
le3 = \"value3\"`\n\nIt would not would not satisify the same condition with the
`number` set to\n3, however, because there is only 2 paths that start with `/fo
o`.\nCardinality conditions are recursive; all subtrees under the specific\npath
prefix are counted.", |
805 "id": "Cardinality", | 804 "id": "Cardinality", |
806 "properties": { | 805 "properties": { |
807 "path": { | 806 "path": { |
808 "description": "The root of the variable subtree to monitor.
Required.", | 807 "description": "The root of the variable subtree to monitor.
For example, `/foo`.", |
809 "type": "string" | 808 "type": "string" |
810 }, | 809 }, |
811 "number": { | 810 "number": { |
812 "description": "The number of decendents of `path` that must
exist before this condition\nis met. Optional; defaults to 1 if not specified."
, | 811 "description": "The number variables under the `path` that m
ust exist to meet this\ncondition. Defaults to 1 if not specified.", |
813 "format": "int32", | 812 "format": "int32", |
814 "type": "integer" | 813 "type": "integer" |
815 } | 814 } |
816 }, | 815 }, |
817 "type": "object" | 816 "type": "object" |
818 }, | 817 }, |
819 "Empty": { | 818 "Empty": { |
820 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | 819 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
821 "id": "Empty", | 820 "id": "Empty", |
822 "properties": {}, | 821 "properties": {}, |
823 "type": "object" | 822 "type": "object" |
824 }, | 823 }, |
825 "WatchVariableRequest": { | 824 "WatchVariableRequest": { |
826 "description": "Request for the `WatchVariable()` method.", | 825 "description": "Request for the `WatchVariable()` method.", |
827 "id": "WatchVariableRequest", | 826 "id": "WatchVariableRequest", |
828 "properties": { | 827 "properties": { |
829 "newerThan": { | 828 "newerThan": { |
830 "description": "If backend has a variable that has a newer v
alue than this timestamp, then\nrequest will return immediately with current val
ue.\nIf not specified or variable has an older timestamp, will wait for the new\
nvalue.", | 829 "description": "If specified, checks the current timestamp o
f the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp
, the method returns\nimmediately.\n\nIf not specified or the variable has an ol
der timestamp, the watcher waits\nfor a the value to change before returning.", |
831 "format": "google-datetime", | 830 "format": "google-datetime", |
832 "type": "string" | 831 "type": "string" |
833 } | 832 } |
834 }, | 833 }, |
835 "type": "object" | 834 "type": "object" |
836 }, | 835 }, |
837 "ListVariablesResponse": { | 836 "ListVariablesResponse": { |
838 "description": "Response for the `ListVariables()` method.\nOrder of
returned variable objects is arbitrary.", | |
839 "id": "ListVariablesResponse", | 837 "id": "ListVariablesResponse", |
840 "properties": { | 838 "properties": { |
841 "variables": { | 839 "variables": { |
842 "description": "Matched variables and their values.", | 840 "description": "A list of variables and their values. The or
der of returned variable\nobjects is arbitrary.", |
843 "items": { | 841 "items": { |
844 "$ref": "Variable" | 842 "$ref": "Variable" |
845 }, | 843 }, |
846 "type": "array" | 844 "type": "array" |
847 }, | 845 }, |
848 "nextPageToken": { | 846 "nextPageToken": { |
849 "description": "Pagination support.", | 847 "description": "This token allows you to get the next page o
f results for list requests.\nIf the number of results is larger than `pageSize`
, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the
next list request.\nSubsequent list requests will have their own `nextPageToken
` to continue\npaging through the results", |
850 "type": "string" | 848 "type": "string" |
851 } | 849 } |
852 }, | 850 }, |
853 "type": "object" | 851 "type": "object" |
854 } | 852 } |
855 }, | 853 }, |
856 "servicePath": "", | 854 "servicePath": "", |
857 "title": "Google Cloud RuntimeConfig API", | 855 "title": "Google Cloud RuntimeConfig API", |
858 "version": "v1beta1" | 856 "version": "v1beta1" |
859 } | 857 } |
OLD | NEW |