Blame - docs/dyn/runtimeconfig_v1beta1.projects.configs.variables.html - platform/external/python/google-api-python-client

blob: 14b6207ac3d4fc76fb5d780b9a27ec3ad37a3ffe [file] [log] [blame]

Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	75	<h1><a href="runtimeconfig_v1beta1.html">Cloud Runtime Configuration API</a> . <a href="runtimeconfig_v1beta1.projects.html">projects</a> . <a href="runtimeconfig_v1beta1.projects.configs.html">configs</a> . <a href="runtimeconfig_v1beta1.projects.configs.variables.html">variables</a></h1>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#create">create(parent, body=None, requestId=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	79	<p class="firstline">Creates a variable within the given configuration. You cannot create</p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	80	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	81	<code><a href="#delete">delete(name, recursive=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	82	<p class="firstline">Deletes a variable or multiple variables.</p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	83	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	84	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	85	<p class="firstline">Gets information about a single variable.</p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	86	<p class="toc_element">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	87	<code><a href="#list">list(parent, pageToken=None, returnValues=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Lists variables within given a configuration, matching any provided</p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	93	<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	94	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	97	<p class="firstline">Updates an existing variable with a new value.</p>
				98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#watch">watch(name, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	100	<p class="firstline">Watches a specific variable and waits for a change in the variable's value.</p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	101	<h3>Method Details</h3>
				102	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	103	<code class="details" id="create">create(parent, body=None, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	104	<pre>Creates a variable within the given configuration. You cannot create
				105	a variable with a name that is a prefix of an existing variable name, or a
				106	name that has an existing variable name as a prefix.
				107
				108	To learn more about creating a variable, read the
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	109	[Setting and Getting
				110	Data](/deployment-manager/runtime-configurator/set-and-get-variables)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	111	documentation.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	112
				113	Args:
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	114	parent: string, The path to the RutimeConfig resource that this variable should belong to.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	115	The configuration must exist beforehand; the path must be in the format:
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	116
				117	`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	118	body: object, The request body.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	119	The object takes the form of:
				120
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	121	{ # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	122	# The name denotes the hierarchical variable name. For example,
				123	# `ports/serving_port` is a valid variable name. The variable value is an
				124	# opaque string and only leaf variables can have values (that is, variables
				125	# that do not have any child variables).
				126	"updateTime": "A String", # Output only. The time of the last variable update.
				127	# Timestamp will be UTC timestamp.
				128	"state": "A String", # Output only. The current state of the variable. The variable state
				129	# indicates the outcome of the `variables().watch` call and is visible
				130	# through the `get` and `list` calls.
				131	"name": "A String", # The name of the variable resource, in the format:
				132	#
				133	# projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
				134	#
				135	# The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
				136	# valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
				137	# file path naming.
				138	#
				139	# The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
				140	# dashes. Slashes are used as path element separators and are not part of the
				141	# `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
				142	# non-slash character. Multiple slashes are coalesced into single slash
				143	# character. Each path segment should match
				144	# [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
				145	# The length of a `[VARIABLE_NAME]` must be less than 256 characters.
				146	#
				147	# Once you create a variable, you cannot change the variable name.
				148	"text": "A String", # The string value of the variable. The length of the value must be less
				149	# than 4096 bytes. Empty values are also accepted. For example,
				150	# `text: "my text value"`. The string must be valid UTF-8.
				151	"value": "A String", # The binary value of the variable. The length of the value must be less
				152	# than 4096 bytes. Empty values are also accepted. The value must be
				153	# base64 encoded, and must comply with IETF RFC4648
				154	# (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
				155	# can be set.
				156	}
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	157
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	158	requestId: string, An optional but recommended unique `request_id`. If the server
				159	receives two `create()` requests with the same
				160	`request_id`, then the second request will be ignored and the
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	161	first resource created and stored in the backend is returned.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	162	Empty `request_id` fields are ignored.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	163
				164	It is responsibility of the client to ensure uniqueness of the
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	165	`request_id` strings.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	166
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	167	`request_id` strings are limited to 64 characters.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	168	x__xgafv: string, V1 error format.
				169	Allowed values
				170	1 - v1 error format
				171	2 - v2 error format
				172
				173	Returns:
				174	An object of the form:
				175
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	176	{ # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	177	# The name denotes the hierarchical variable name. For example,
				178	# `ports/serving_port` is a valid variable name. The variable value is an
				179	# opaque string and only leaf variables can have values (that is, variables
				180	# that do not have any child variables).
				181	"updateTime": "A String", # Output only. The time of the last variable update.
				182	# Timestamp will be UTC timestamp.
				183	"state": "A String", # Output only. The current state of the variable. The variable state
				184	# indicates the outcome of the `variables().watch` call and is visible
				185	# through the `get` and `list` calls.
				186	"name": "A String", # The name of the variable resource, in the format:
				187	#
				188	# projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
				189	#
				190	# The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
				191	# valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
				192	# file path naming.
				193	#
				194	# The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
				195	# dashes. Slashes are used as path element separators and are not part of the
				196	# `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
				197	# non-slash character. Multiple slashes are coalesced into single slash
				198	# character. Each path segment should match
				199	# [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
				200	# The length of a `[VARIABLE_NAME]` must be less than 256 characters.
				201	#
				202	# Once you create a variable, you cannot change the variable name.
				203	"text": "A String", # The string value of the variable. The length of the value must be less
				204	# than 4096 bytes. Empty values are also accepted. For example,
				205	# `text: "my text value"`. The string must be valid UTF-8.
				206	"value": "A String", # The binary value of the variable. The length of the value must be less
				207	# than 4096 bytes. Empty values are also accepted. The value must be
				208	# base64 encoded, and must comply with IETF RFC4648
				209	# (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
				210	# can be set.
				211	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	212	</div>
				213
				214	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	215	<code class="details" id="delete">delete(name, recursive=None, x__xgafv=None)</code>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	216	<pre>Deletes a variable or multiple variables.
				217
				218	If you specify a variable name, then that variable is deleted. If you
				219	specify a prefix and `recursive` is true, then all variables with that
				220	prefix are deleted. You must set a `recursive` to true if you delete
				221	variables by prefix.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	222
				223	Args:
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	224	name: string, The name of the variable to delete, in the format:
				225
				226	`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	227	recursive: boolean, Set to `true` to recursively delete multiple variables with the same
				228	prefix.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	229	x__xgafv: string, V1 error format.
				230	Allowed values
				231	1 - v1 error format
				232	2 - v2 error format
				233
				234	Returns:
				235	An object of the form:
				236
				237	{ # A generic empty message that you can re-use to avoid defining duplicated
				238	# empty messages in your APIs. A typical example is to use it as the request
				239	# or the response type of an API method. For instance:
				240	#
				241	# service Foo {
				242	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				243	# }
				244	#
				245	# The JSON representation for `Empty` is empty JSON object `{}`.
				246	}</pre>
				247	</div>
				248
				249	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	250	<code class="details" id="get">get(name, x__xgafv=None)</code>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	251	<pre>Gets information about a single variable.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	252
				253	Args:
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	254	name: string, The name of the variable to return, in the format:
				255
				256	`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` (required)
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	257	x__xgafv: string, V1 error format.
				258	Allowed values
				259	1 - v1 error format
				260	2 - v2 error format
				261
				262	Returns:
				263	An object of the form:
				264
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	265	{ # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	266	# The name denotes the hierarchical variable name. For example,
				267	# `ports/serving_port` is a valid variable name. The variable value is an
				268	# opaque string and only leaf variables can have values (that is, variables
				269	# that do not have any child variables).
				270	"updateTime": "A String", # Output only. The time of the last variable update.
				271	# Timestamp will be UTC timestamp.
				272	"state": "A String", # Output only. The current state of the variable. The variable state
				273	# indicates the outcome of the `variables().watch` call and is visible
				274	# through the `get` and `list` calls.
				275	"name": "A String", # The name of the variable resource, in the format:
				276	#
				277	# projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
				278	#
				279	# The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
				280	# valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
				281	# file path naming.
				282	#
				283	# The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
				284	# dashes. Slashes are used as path element separators and are not part of the
				285	# `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
				286	# non-slash character. Multiple slashes are coalesced into single slash
				287	# character. Each path segment should match
				288	# [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
				289	# The length of a `[VARIABLE_NAME]` must be less than 256 characters.
				290	#
				291	# Once you create a variable, you cannot change the variable name.
				292	"text": "A String", # The string value of the variable. The length of the value must be less
				293	# than 4096 bytes. Empty values are also accepted. For example,
				294	# `text: "my text value"`. The string must be valid UTF-8.
				295	"value": "A String", # The binary value of the variable. The length of the value must be less
				296	# than 4096 bytes. Empty values are also accepted. The value must be
				297	# base64 encoded, and must comply with IETF RFC4648
				298	# (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
				299	# can be set.
				300	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	301	</div>
				302
				303	<div class="method">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	304	<code class="details" id="list">list(parent, pageToken=None, returnValues=None, pageSize=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	305	<pre>Lists variables within given a configuration, matching any provided
				306	filters. This only lists variable names, not the values, unless
				307	`return_values` is true, in which case only variables that user has IAM
				308	permission to GetVariable will be returned.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	309
				310	Args:
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	311	parent: string, The path to the RuntimeConfig resource for which you want to list
				312	variables. The configuration must exist beforehand; the path must be in the
				313	format:
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	314
				315	`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	316	pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
				317	returned by a previous list request to get the next page of results.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	318	returnValues: boolean, The flag indicates whether the user wants to return values of variables.
				319	If true, then only those variables that user has IAM GetVariable permission
				320	will be returned along with their values.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	321	pageSize: integer, Specifies the number of results to return per page. If there are fewer
				322	elements than the specified number, returns all elements.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	323	filter: string, Filters variables by matching the specified filter. For example:
				324
				325	`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	326	x__xgafv: string, V1 error format.
				327	Allowed values
				328	1 - v1 error format
				329	2 - v2 error format
				330
				331	Returns:
				332	An object of the form:
				333
				334	{ # Response for the `ListVariables()` method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	335	"variables": [ # A list of variables and their values. The order of returned variable
				336	# objects is arbitrary.
				337	{ # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	338	# The name denotes the hierarchical variable name. For example,
				339	# `ports/serving_port` is a valid variable name. The variable value is an
				340	# opaque string and only leaf variables can have values (that is, variables
				341	# that do not have any child variables).
				342	"updateTime": "A String", # Output only. The time of the last variable update.
				343	# Timestamp will be UTC timestamp.
				344	"state": "A String", # Output only. The current state of the variable. The variable state
				345	# indicates the outcome of the `variables().watch` call and is visible
				346	# through the `get` and `list` calls.
				347	"name": "A String", # The name of the variable resource, in the format:
				348	#
				349	# projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
				350	#
				351	# The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
				352	# valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
				353	# file path naming.
				354	#
				355	# The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
				356	# dashes. Slashes are used as path element separators and are not part of the
				357	# `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
				358	# non-slash character. Multiple slashes are coalesced into single slash
				359	# character. Each path segment should match
				360	# [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
				361	# The length of a `[VARIABLE_NAME]` must be less than 256 characters.
				362	#
				363	# Once you create a variable, you cannot change the variable name.
				364	"text": "A String", # The string value of the variable. The length of the value must be less
				365	# than 4096 bytes. Empty values are also accepted. For example,
				366	# `text: "my text value"`. The string must be valid UTF-8.
				367	"value": "A String", # The binary value of the variable. The length of the value must be less
				368	# than 4096 bytes. Empty values are also accepted. The value must be
				369	# base64 encoded, and must comply with IETF RFC4648
				370	# (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
				371	# can be set.
				372	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	373	],
				374	"nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	375	# If the number of results is larger than `pageSize`, use the `nextPageToken`
				376	# as a value for the query parameter `pageToken` in the next list request.
				377	# Subsequent list requests will have their own `nextPageToken` to continue
				378	# paging through the results
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	379	}</pre>
				380	</div>
				381
				382	<div class="method">
				383	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				384	<pre>Retrieves the next page of results.
				385
				386	Args:
				387	previous_request: The request for the previous page. (required)
				388	previous_response: The response from the request for the previous page. (required)
				389
				390	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	391	A request object that you can call 'execute()' on to request the next
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	392	page. Returns None if there are no more items in the collection.
				393	</pre>
				394	</div>
				395
				396	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	397	<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	398	<pre>Returns permissions that a caller has on the specified resource.
				399	If the resource does not exist, this will return an empty set of
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	400	permissions, not a `NOT_FOUND` error.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	401
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	402	Note: This operation is designed to be used for building permission-aware
				403	UIs and command-line tools, not for authorization checking. This operation
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	404	may "fail open" without warning.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	405
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	406	Args:
				407	resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	408	See the operation documentation for the appropriate value for this field. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	409	body: object, The request body.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	410	The object takes the form of:
				411
				412	{ # Request message for `TestIamPermissions` method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	413	"permissions": [ # The set of permissions to check for the `resource`. Permissions with
				414	# wildcards (such as '' or 'storage.') are not allowed. For more
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	415	# information see
				416	# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	417	"A String",
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	418	],
				419	}
				420
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	421	x__xgafv: string, V1 error format.
				422	Allowed values
				423	1 - v1 error format
				424	2 - v2 error format
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	425
				426	Returns:
				427	An object of the form:
				428
				429	{ # Response message for `TestIamPermissions` method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	430	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	431	# allowed.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	432	"A String",
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	433	],
				434	}</pre>
				435	</div>
				436
				437	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	438	<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	439	<pre>Updates an existing variable with a new value.
				440
				441	Args:
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	442	name: string, The name of the variable to update, in the format:
				443
				444	`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	445	body: object, The request body.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	446	The object takes the form of:
				447
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	448	{ # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	449	# The name denotes the hierarchical variable name. For example,
				450	# `ports/serving_port` is a valid variable name. The variable value is an
				451	# opaque string and only leaf variables can have values (that is, variables
				452	# that do not have any child variables).
				453	"updateTime": "A String", # Output only. The time of the last variable update.
				454	# Timestamp will be UTC timestamp.
				455	"state": "A String", # Output only. The current state of the variable. The variable state
				456	# indicates the outcome of the `variables().watch` call and is visible
				457	# through the `get` and `list` calls.
				458	"name": "A String", # The name of the variable resource, in the format:
				459	#
				460	# projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
				461	#
				462	# The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
				463	# valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
				464	# file path naming.
				465	#
				466	# The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
				467	# dashes. Slashes are used as path element separators and are not part of the
				468	# `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
				469	# non-slash character. Multiple slashes are coalesced into single slash
				470	# character. Each path segment should match
				471	# [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
				472	# The length of a `[VARIABLE_NAME]` must be less than 256 characters.
				473	#
				474	# Once you create a variable, you cannot change the variable name.
				475	"text": "A String", # The string value of the variable. The length of the value must be less
				476	# than 4096 bytes. Empty values are also accepted. For example,
				477	# `text: "my text value"`. The string must be valid UTF-8.
				478	"value": "A String", # The binary value of the variable. The length of the value must be less
				479	# than 4096 bytes. Empty values are also accepted. The value must be
				480	# base64 encoded, and must comply with IETF RFC4648
				481	# (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
				482	# can be set.
				483	}
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	484
				485	x__xgafv: string, V1 error format.
				486	Allowed values
				487	1 - v1 error format
				488	2 - v2 error format
				489
				490	Returns:
				491	An object of the form:
				492
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	493	{ # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	494	# The name denotes the hierarchical variable name. For example,
				495	# `ports/serving_port` is a valid variable name. The variable value is an
				496	# opaque string and only leaf variables can have values (that is, variables
				497	# that do not have any child variables).
				498	"updateTime": "A String", # Output only. The time of the last variable update.
				499	# Timestamp will be UTC timestamp.
				500	"state": "A String", # Output only. The current state of the variable. The variable state
				501	# indicates the outcome of the `variables().watch` call and is visible
				502	# through the `get` and `list` calls.
				503	"name": "A String", # The name of the variable resource, in the format:
				504	#
				505	# projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
				506	#
				507	# The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
				508	# valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
				509	# file path naming.
				510	#
				511	# The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
				512	# dashes. Slashes are used as path element separators and are not part of the
				513	# `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
				514	# non-slash character. Multiple slashes are coalesced into single slash
				515	# character. Each path segment should match
				516	# [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
				517	# The length of a `[VARIABLE_NAME]` must be less than 256 characters.
				518	#
				519	# Once you create a variable, you cannot change the variable name.
				520	"text": "A String", # The string value of the variable. The length of the value must be less
				521	# than 4096 bytes. Empty values are also accepted. For example,
				522	# `text: "my text value"`. The string must be valid UTF-8.
				523	"value": "A String", # The binary value of the variable. The length of the value must be less
				524	# than 4096 bytes. Empty values are also accepted. The value must be
				525	# base64 encoded, and must comply with IETF RFC4648
				526	# (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
				527	# can be set.
				528	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	529	</div>
				530
				531	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	532	<code class="details" id="watch">watch(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	533	<pre>Watches a specific variable and waits for a change in the variable's value.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	534	When there is a change, this method returns the new value or times out.
				535
				536	If a variable is deleted while being watched, the `variableState` state is
				537	set to `DELETED` and the method returns the last known variable `value`.
				538
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	539	If you set the deadline for watching to a larger value than internal
				540	timeout (60 seconds), the current variable value is returned and the
				541	`variableState` will be `VARIABLE_STATE_UNSPECIFIED`.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	542
				543	To learn more about creating a watcher, read the
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	544	[Watching a Variable for
				545	Changes](/deployment-manager/runtime-configurator/watching-a-variable)
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	546	documentation.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	547
				548	Args:
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	549	name: string, The name of the variable to watch, in the format:
				550
				551	`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	552	body: object, The request body.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	553	The object takes the form of:
				554
				555	{ # Request for the `WatchVariable()` method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	556	"newerThan": "A String", # If specified, checks the current timestamp of the variable and if the
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	557	# current timestamp is newer than `newerThan` timestamp, the method returns
				558	# immediately.
				559	#
				560	# If not specified or the variable has an older timestamp, the watcher waits
				561	# for a the value to change before returning.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	562	}
				563
				564	x__xgafv: string, V1 error format.
				565	Allowed values
				566	1 - v1 error format
				567	2 - v2 error format
				568
				569	Returns:
				570	An object of the form:
				571
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	572	{ # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	573	# The name denotes the hierarchical variable name. For example,
				574	# `ports/serving_port` is a valid variable name. The variable value is an
				575	# opaque string and only leaf variables can have values (that is, variables
				576	# that do not have any child variables).
				577	"updateTime": "A String", # Output only. The time of the last variable update.
				578	# Timestamp will be UTC timestamp.
				579	"state": "A String", # Output only. The current state of the variable. The variable state
				580	# indicates the outcome of the `variables().watch` call and is visible
				581	# through the `get` and `list` calls.
				582	"name": "A String", # The name of the variable resource, in the format:
				583	#
				584	# projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
				585	#
				586	# The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
				587	# valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
				588	# file path naming.
				589	#
				590	# The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
				591	# dashes. Slashes are used as path element separators and are not part of the
				592	# `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
				593	# non-slash character. Multiple slashes are coalesced into single slash
				594	# character. Each path segment should match
				595	# [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
				596	# The length of a `[VARIABLE_NAME]` must be less than 256 characters.
				597	#
				598	# Once you create a variable, you cannot change the variable name.
				599	"text": "A String", # The string value of the variable. The length of the value must be less
				600	# than 4096 bytes. Empty values are also accepted. For example,
				601	# `text: "my text value"`. The string must be valid UTF-8.
				602	"value": "A String", # The binary value of the variable. The length of the value must be less
				603	# than 4096 bytes. Empty values are also accepted. The value must be
				604	# base64 encoded, and must comply with IETF RFC4648
				605	# (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
				606	# can be set.
				607	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	608	</div>
				609
				610	</body></html>