Update documentation
diff --git a/docs/dyn/runtimeconfig_v1beta1.projects.configs.variables.html b/docs/dyn/runtimeconfig_v1beta1.projects.configs.variables.html
index de2490b..eef113c 100644
--- a/docs/dyn/runtimeconfig_v1beta1.projects.configs.variables.html
+++ b/docs/dyn/runtimeconfig_v1beta1.projects.configs.variables.html
@@ -76,16 +76,16 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a variable within the given configuration.</p>
+<p class="firstline">Creates a variable within the given configuration. You cannot create</p>
<p class="toc_element">
- <code><a href="#delete">delete(name, recursive=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes variable or variables.</p>
+ <code><a href="#delete">delete(name=None, recursive=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a variable or multiple variables.</p>
<p class="toc_element">
- <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the variable resource object.</p>
+ <code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets information about a single variable.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists variables within given RuntimeConfig object, matching optionally</p>
+ <code><a href="#list">list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists variables within given a configuration, matching any provided filters.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -93,48 +93,59 @@
<code><a href="#update">update(name=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing variable with a new value.</p>
<p class="toc_element">
- <code><a href="#watch">watch(name, body, x__xgafv=None)</a></code></p>
-<p class="firstline">WatchVariable watches for a variable to change and then returns the new</p>
+ <code><a href="#watch">watch(name=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Watches a specific variable and waits for a change in the variable's value.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
- <pre>Creates a variable within the given configuration.
-Create variable will create all required intermediate path elements.
-It is a FAILED_PRECONDITION error to create a variable with a name that is
-a prefix of an existing variable name, or that has an existing variable
-name as a prefix.
+ <pre>Creates a variable within the given configuration. You cannot create
+a variable with a name that is a prefix of an existing variable name, or a
+name that has an existing variable name as a prefix.
+
+To learn more about creating a variable, read the
+[Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables)
+documentation.
Args:
- parent: string, The configuration parent, that will own the variable.
-Required, must a valid configuration name within project_id. (required)
+ parent: string, The path to the RutimeConfig resource that this variable should belong to.
+The configuration must exist beforehand; the path must by in the format:
+
+`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Variable message describes a single variable within a Configuration object.
- # name denotes the hierarchical variable name, e.g.
- # ports/serving_port within flags configuration object.
- # Value is an opaque string and only leaf variables can have values.
+{ # Describes a single variable within a RuntimeConfig resource.
+ # The name denotes the hierarchical variable name. For example,
+ # `ports/serving_port` is a valid variable name. The variable value is an
+ # opaque string and only leaf variables can have values (that is, variables
+ # that do not have any child variables).
+ "text": "A String", # The textual value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted.
+ # NB: Only one of value and string_value can be set at the same time.
"updateTime": "A String", # [Output Only] The time of the last variable update.
- "state": "A String", # [Ouput only] The current state of the variable.
- # State denotes the outcome of the Watch call and is unset by the Get/List
- # calls.
- "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
- # value must be Base64 encoded.
- "name": "A String", # Name of the variable resource.
- # It has format of
- # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
- # Where `project_id` must be a valid Google Cloud project ID, `config_id`
- # must be a valid RuntimeConfig object and `variable_id` follows Unix
- # file system file path naming.
- # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
- # Slashes are used as path element separators and are not part of the
- # `variable_id` itself, so `variable_id` must contain at least one non-slash
- # character. Multiple slashes are coalesced into single slash character.
- # Each path segment should follow RFC 1035 segment specification.
- # `len(variable_id)` must be less than 256 bytes.
- # The name is assigned by the client, but will be validated on the server
- # side to adhere to the format.
- # Name is immutable and cannot be changed.
+ "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
+ # the outcome of the `variables().watch` call and is visible through the
+ # `get` and `list` calls.
+ "value": "A String", # The binary value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted. The value must be
+ # Base64 encoded.
+ # NB: Only one of value and string_value can be set at the same time.
+ "name": "A String", # The name of the variable resource, in the format:
+ #
+ # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
+ #
+ # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
+ # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
+ # file path naming.
+ #
+ # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
+ # dashes. Slashes are used as path element separators and are not part of the
+ # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
+ # non-slash character. Multiple slashes are coalesced into single slash
+ # character. Each path segment should follow RFC 1035 segment specification.
+ # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
+ #
+ # Once you create a variable, you cannot change the variable name.
}
x__xgafv: string, V1 error format.
@@ -145,45 +156,56 @@
Returns:
An object of the form:
- { # Variable message describes a single variable within a Configuration object.
- # name denotes the hierarchical variable name, e.g.
- # ports/serving_port within flags configuration object.
- # Value is an opaque string and only leaf variables can have values.
+ { # Describes a single variable within a RuntimeConfig resource.
+ # The name denotes the hierarchical variable name. For example,
+ # `ports/serving_port` is a valid variable name. The variable value is an
+ # opaque string and only leaf variables can have values (that is, variables
+ # that do not have any child variables).
+ "text": "A String", # The textual value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted.
+ # NB: Only one of value and string_value can be set at the same time.
"updateTime": "A String", # [Output Only] The time of the last variable update.
- "state": "A String", # [Ouput only] The current state of the variable.
- # State denotes the outcome of the Watch call and is unset by the Get/List
- # calls.
- "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
- # value must be Base64 encoded.
- "name": "A String", # Name of the variable resource.
- # It has format of
- # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
- # Where `project_id` must be a valid Google Cloud project ID, `config_id`
- # must be a valid RuntimeConfig object and `variable_id` follows Unix
- # file system file path naming.
- # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
- # Slashes are used as path element separators and are not part of the
- # `variable_id` itself, so `variable_id` must contain at least one non-slash
- # character. Multiple slashes are coalesced into single slash character.
- # Each path segment should follow RFC 1035 segment specification.
- # `len(variable_id)` must be less than 256 bytes.
- # The name is assigned by the client, but will be validated on the server
- # side to adhere to the format.
- # Name is immutable and cannot be changed.
+ "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
+ # the outcome of the `variables().watch` call and is visible through the
+ # `get` and `list` calls.
+ "value": "A String", # The binary value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted. The value must be
+ # Base64 encoded.
+ # NB: Only one of value and string_value can be set at the same time.
+ "name": "A String", # The name of the variable resource, in the format:
+ #
+ # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
+ #
+ # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
+ # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
+ # file path naming.
+ #
+ # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
+ # dashes. Slashes are used as path element separators and are not part of the
+ # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
+ # non-slash character. Multiple slashes are coalesced into single slash
+ # character. Each path segment should follow RFC 1035 segment specification.
+ # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
+ #
+ # Once you create a variable, you cannot change the variable name.
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(name, recursive=None, x__xgafv=None)</code>
- <pre>Deletes variable or variables.
-If name denotes a variable, that variable is deleted. If name is a prefix
-and recursive is true, then all variables with that prefix are deleted,
-it's a FAILED_PRECONDITION to delete a prefix without recursive being true.
+ <code class="details" id="delete">delete(name=None, recursive=None, x__xgafv=None)</code>
+ <pre>Deletes a variable or multiple variables.
+
+If you specify a variable name, then that variable is deleted. If you
+specify a prefix and `recursive` is true, then all variables with that
+prefix are deleted. You must set a `recursive` to true if you delete
+variables by prefix.
Args:
- name: string, The name of the variable to delete. (required)
- recursive: boolean, If recursive is false and name is a prefix of other variables, then
-the request will fail.
+ name: string, The name of the variable to delete, in the format:
+
+`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
+ recursive: boolean, Set to `true` to recursively delete multiple variables with the same
+prefix.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -205,11 +227,13 @@
</div>
<div class="method">
- <code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Gets the variable resource object.
+ <code class="details" id="get">get(name=None, x__xgafv=None)</code>
+ <pre>Gets information about a single variable.
Args:
- name: string, What variable to return. (required)
+ name: string, The name of the variable to return, in the format:
+
+`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -218,47 +242,58 @@
Returns:
An object of the form:
- { # Variable message describes a single variable within a Configuration object.
- # name denotes the hierarchical variable name, e.g.
- # ports/serving_port within flags configuration object.
- # Value is an opaque string and only leaf variables can have values.
+ { # Describes a single variable within a RuntimeConfig resource.
+ # The name denotes the hierarchical variable name. For example,
+ # `ports/serving_port` is a valid variable name. The variable value is an
+ # opaque string and only leaf variables can have values (that is, variables
+ # that do not have any child variables).
+ "text": "A String", # The textual value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted.
+ # NB: Only one of value and string_value can be set at the same time.
"updateTime": "A String", # [Output Only] The time of the last variable update.
- "state": "A String", # [Ouput only] The current state of the variable.
- # State denotes the outcome of the Watch call and is unset by the Get/List
- # calls.
- "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
- # value must be Base64 encoded.
- "name": "A String", # Name of the variable resource.
- # It has format of
- # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
- # Where `project_id` must be a valid Google Cloud project ID, `config_id`
- # must be a valid RuntimeConfig object and `variable_id` follows Unix
- # file system file path naming.
- # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
- # Slashes are used as path element separators and are not part of the
- # `variable_id` itself, so `variable_id` must contain at least one non-slash
- # character. Multiple slashes are coalesced into single slash character.
- # Each path segment should follow RFC 1035 segment specification.
- # `len(variable_id)` must be less than 256 bytes.
- # The name is assigned by the client, but will be validated on the server
- # side to adhere to the format.
- # Name is immutable and cannot be changed.
+ "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
+ # the outcome of the `variables().watch` call and is visible through the
+ # `get` and `list` calls.
+ "value": "A String", # The binary value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted. The value must be
+ # Base64 encoded.
+ # NB: Only one of value and string_value can be set at the same time.
+ "name": "A String", # The name of the variable resource, in the format:
+ #
+ # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
+ #
+ # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
+ # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
+ # file path naming.
+ #
+ # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
+ # dashes. Slashes are used as path element separators and are not part of the
+ # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
+ # non-slash character. Multiple slashes are coalesced into single slash
+ # character. Each path segment should follow RFC 1035 segment specification.
+ # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
+ #
+ # Once you create a variable, you cannot change the variable name.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists variables within given RuntimeConfig object, matching optionally
-provided filter.
-List contains only variable metadata, but not values.
+ <code class="details" id="list">list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists variables within given a configuration, matching any provided filters.
+This only lists variable names, not the values.
Args:
- parent: string, Which RuntimeConfig object to list for variables. (required)
- pageSize: integer, List pagination support.
-The size of the page to return. We may return fewer elements.
- filter: string, List only variables matching filter prefix exactly.
-e.g. `projects/{project_id}/config/{config_id}/variables/{variable/id}`.
- pageToken: string, The token for pagination.
+ parent: string, The path to the RuntimeConfig resource for which you want to list variables.
+The configuration must exist beforehand; the path must by in the format:
+
+`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
+ pageSize: integer, Specifies the number of results to return per page. If there are fewer
+elements than the specified number, returns all elements.
+ filter: string, Filters variables by matching the specified filter. For example:
+
+`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.
+ pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
+returned by a previous list request to get the next page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -268,34 +303,45 @@
An object of the form:
{ # Response for the `ListVariables()` method.
- # Order of returned variable objects is arbitrary.
- "nextPageToken": "A String", # Pagination support.
- "variables": [ # Matched variables and their values.
- { # Variable message describes a single variable within a Configuration object.
- # name denotes the hierarchical variable name, e.g.
- # ports/serving_port within flags configuration object.
- # Value is an opaque string and only leaf variables can have values.
+ "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
+ # If the number of results is larger than `pageSize`, use the `nextPageToken`
+ # as a value for the query parameter `pageToken` in the next list request.
+ # Subsequent list requests will have their own `nextPageToken` to continue
+ # paging through the results
+ "variables": [ # A list of variables and their values. The order of returned variable
+ # objects is arbitrary.
+ { # Describes a single variable within a RuntimeConfig resource.
+ # The name denotes the hierarchical variable name. For example,
+ # `ports/serving_port` is a valid variable name. The variable value is an
+ # opaque string and only leaf variables can have values (that is, variables
+ # that do not have any child variables).
+ "text": "A String", # The textual value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted.
+ # NB: Only one of value and string_value can be set at the same time.
"updateTime": "A String", # [Output Only] The time of the last variable update.
- "state": "A String", # [Ouput only] The current state of the variable.
- # State denotes the outcome of the Watch call and is unset by the Get/List
- # calls.
- "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
- # value must be Base64 encoded.
- "name": "A String", # Name of the variable resource.
- # It has format of
- # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
- # Where `project_id` must be a valid Google Cloud project ID, `config_id`
- # must be a valid RuntimeConfig object and `variable_id` follows Unix
- # file system file path naming.
- # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
- # Slashes are used as path element separators and are not part of the
- # `variable_id` itself, so `variable_id` must contain at least one non-slash
- # character. Multiple slashes are coalesced into single slash character.
- # Each path segment should follow RFC 1035 segment specification.
- # `len(variable_id)` must be less than 256 bytes.
- # The name is assigned by the client, but will be validated on the server
- # side to adhere to the format.
- # Name is immutable and cannot be changed.
+ "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
+ # the outcome of the `variables().watch` call and is visible through the
+ # `get` and `list` calls.
+ "value": "A String", # The binary value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted. The value must be
+ # Base64 encoded.
+ # NB: Only one of value and string_value can be set at the same time.
+ "name": "A String", # The name of the variable resource, in the format:
+ #
+ # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
+ #
+ # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
+ # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
+ # file path naming.
+ #
+ # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
+ # dashes. Slashes are used as path element separators and are not part of the
+ # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
+ # non-slash character. Multiple slashes are coalesced into single slash
+ # character. Each path segment should follow RFC 1035 segment specification.
+ # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
+ #
+ # Once you create a variable, you cannot change the variable name.
},
],
}</pre>
@@ -320,37 +366,44 @@
<pre>Updates an existing variable with a new value.
Args:
- name: string, The name of the variable to update.
-In the format of:
-"projects/{project_id}/configs/{config_id}/variables/{variable_id}" (required)
+ name: string, The name of the variable to update, in the format:
+
+`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Variable message describes a single variable within a Configuration object.
- # name denotes the hierarchical variable name, e.g.
- # ports/serving_port within flags configuration object.
- # Value is an opaque string and only leaf variables can have values.
+{ # Describes a single variable within a RuntimeConfig resource.
+ # The name denotes the hierarchical variable name. For example,
+ # `ports/serving_port` is a valid variable name. The variable value is an
+ # opaque string and only leaf variables can have values (that is, variables
+ # that do not have any child variables).
+ "text": "A String", # The textual value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted.
+ # NB: Only one of value and string_value can be set at the same time.
"updateTime": "A String", # [Output Only] The time of the last variable update.
- "state": "A String", # [Ouput only] The current state of the variable.
- # State denotes the outcome of the Watch call and is unset by the Get/List
- # calls.
- "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
- # value must be Base64 encoded.
- "name": "A String", # Name of the variable resource.
- # It has format of
- # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
- # Where `project_id` must be a valid Google Cloud project ID, `config_id`
- # must be a valid RuntimeConfig object and `variable_id` follows Unix
- # file system file path naming.
- # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
- # Slashes are used as path element separators and are not part of the
- # `variable_id` itself, so `variable_id` must contain at least one non-slash
- # character. Multiple slashes are coalesced into single slash character.
- # Each path segment should follow RFC 1035 segment specification.
- # `len(variable_id)` must be less than 256 bytes.
- # The name is assigned by the client, but will be validated on the server
- # side to adhere to the format.
- # Name is immutable and cannot be changed.
+ "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
+ # the outcome of the `variables().watch` call and is visible through the
+ # `get` and `list` calls.
+ "value": "A String", # The binary value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted. The value must be
+ # Base64 encoded.
+ # NB: Only one of value and string_value can be set at the same time.
+ "name": "A String", # The name of the variable resource, in the format:
+ #
+ # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
+ #
+ # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
+ # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
+ # file path naming.
+ #
+ # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
+ # dashes. Slashes are used as path element separators and are not part of the
+ # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
+ # non-slash character. Multiple slashes are coalesced into single slash
+ # character. Each path segment should follow RFC 1035 segment specification.
+ # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
+ #
+ # Once you create a variable, you cannot change the variable name.
}
x__xgafv: string, V1 error format.
@@ -361,54 +414,71 @@
Returns:
An object of the form:
- { # Variable message describes a single variable within a Configuration object.
- # name denotes the hierarchical variable name, e.g.
- # ports/serving_port within flags configuration object.
- # Value is an opaque string and only leaf variables can have values.
+ { # Describes a single variable within a RuntimeConfig resource.
+ # The name denotes the hierarchical variable name. For example,
+ # `ports/serving_port` is a valid variable name. The variable value is an
+ # opaque string and only leaf variables can have values (that is, variables
+ # that do not have any child variables).
+ "text": "A String", # The textual value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted.
+ # NB: Only one of value and string_value can be set at the same time.
"updateTime": "A String", # [Output Only] The time of the last variable update.
- "state": "A String", # [Ouput only] The current state of the variable.
- # State denotes the outcome of the Watch call and is unset by the Get/List
- # calls.
- "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
- # value must be Base64 encoded.
- "name": "A String", # Name of the variable resource.
- # It has format of
- # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
- # Where `project_id` must be a valid Google Cloud project ID, `config_id`
- # must be a valid RuntimeConfig object and `variable_id` follows Unix
- # file system file path naming.
- # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
- # Slashes are used as path element separators and are not part of the
- # `variable_id` itself, so `variable_id` must contain at least one non-slash
- # character. Multiple slashes are coalesced into single slash character.
- # Each path segment should follow RFC 1035 segment specification.
- # `len(variable_id)` must be less than 256 bytes.
- # The name is assigned by the client, but will be validated on the server
- # side to adhere to the format.
- # Name is immutable and cannot be changed.
+ "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
+ # the outcome of the `variables().watch` call and is visible through the
+ # `get` and `list` calls.
+ "value": "A String", # The binary value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted. The value must be
+ # Base64 encoded.
+ # NB: Only one of value and string_value can be set at the same time.
+ "name": "A String", # The name of the variable resource, in the format:
+ #
+ # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
+ #
+ # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
+ # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
+ # file path naming.
+ #
+ # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
+ # dashes. Slashes are used as path element separators and are not part of the
+ # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
+ # non-slash character. Multiple slashes are coalesced into single slash
+ # character. Each path segment should follow RFC 1035 segment specification.
+ # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
+ #
+ # Once you create a variable, you cannot change the variable name.
}</pre>
</div>
<div class="method">
- <code class="details" id="watch">watch(name, body, x__xgafv=None)</code>
- <pre>WatchVariable watches for a variable to change and then returns the new
-value or times out.
-If variable is deleted while being watched, VariableState will be DELETED
-and the Value will contain the last known value.
-If the operation deadline is set to a larger value than internal timeout
-existing, current variable value will be returned and Variable state will
-be VARIABLE_STATE_UNSPECIFIED.
+ <code class="details" id="watch">watch(name=None, body, x__xgafv=None)</code>
+ <pre>Watches a specific variable and waits for a change in the variable's value.
+When there is a change, this method returns the new value or times out.
+
+If a variable is deleted while being watched, the `variableState` state is
+set to `DELETED` and the method returns the last known variable `value`.
+
+If you set the deadline for watching to a larger value than internal timeout
+(60 seconds), the current variable value is returned and the `variableState`
+will be `VARIABLE_STATE_UNSPECIFIED`.
+
+To learn more about creating a watcher, read the
+[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)
+documentation.
Args:
- name: string, The name of the variable to retrieve. (required)
+ name: string, The name of the variable to watch, in the format:
+
+`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request for the `WatchVariable()` method.
- "newerThan": "A String", # If backend has a variable that has a newer value than this timestamp, then
- # request will return immediately with current value.
- # If not specified or variable has an older timestamp, will wait for the new
- # value.
+ "newerThan": "A String", # If specified, checks the current timestamp of the variable and if the
+ # current timestamp is newer than `newerThan` timestamp, the method returns
+ # immediately.
+ #
+ # If not specified or the variable has an older timestamp, the watcher waits
+ # for a the value to change before returning.
}
x__xgafv: string, V1 error format.
@@ -419,31 +489,38 @@
Returns:
An object of the form:
- { # Variable message describes a single variable within a Configuration object.
- # name denotes the hierarchical variable name, e.g.
- # ports/serving_port within flags configuration object.
- # Value is an opaque string and only leaf variables can have values.
+ { # Describes a single variable within a RuntimeConfig resource.
+ # The name denotes the hierarchical variable name. For example,
+ # `ports/serving_port` is a valid variable name. The variable value is an
+ # opaque string and only leaf variables can have values (that is, variables
+ # that do not have any child variables).
+ "text": "A String", # The textual value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted.
+ # NB: Only one of value and string_value can be set at the same time.
"updateTime": "A String", # [Output Only] The time of the last variable update.
- "state": "A String", # [Ouput only] The current state of the variable.
- # State denotes the outcome of the Watch call and is unset by the Get/List
- # calls.
- "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
- # value must be Base64 encoded.
- "name": "A String", # Name of the variable resource.
- # It has format of
- # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
- # Where `project_id` must be a valid Google Cloud project ID, `config_id`
- # must be a valid RuntimeConfig object and `variable_id` follows Unix
- # file system file path naming.
- # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
- # Slashes are used as path element separators and are not part of the
- # `variable_id` itself, so `variable_id` must contain at least one non-slash
- # character. Multiple slashes are coalesced into single slash character.
- # Each path segment should follow RFC 1035 segment specification.
- # `len(variable_id)` must be less than 256 bytes.
- # The name is assigned by the client, but will be validated on the server
- # side to adhere to the format.
- # Name is immutable and cannot be changed.
+ "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
+ # the outcome of the `variables().watch` call and is visible through the
+ # `get` and `list` calls.
+ "value": "A String", # The binary value of the variable. The length of the value must be less
+ # than 4096 bytes. Empty values are also accepted. The value must be
+ # Base64 encoded.
+ # NB: Only one of value and string_value can be set at the same time.
+ "name": "A String", # The name of the variable resource, in the format:
+ #
+ # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
+ #
+ # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
+ # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
+ # file path naming.
+ #
+ # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
+ # dashes. Slashes are used as path element separators and are not part of the
+ # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
+ # non-slash character. Multiple slashes are coalesced into single slash
+ # character. Each path segment should follow RFC 1035 segment specification.
+ # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
+ #
+ # Once you create a variable, you cannot change the variable name.
}</pre>
</div>