package google.cloud.runtimeconfig.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
RuntimeConfig API represents configuration objects and operations on those configuration objects. RuntimeConfig objects consist of Variables logically grouped in the those objects. Variables are simple key-value pairs. Variables can be watched for changes or deletions. Variable key can be hieararchical, e.g. ports/serving_port, ports/monitoring_port, etc. Variable names can be hierarchical. No variable name can be prefix of another. Config objects represent logical containers for variables, e.g. flags, passwords, etc.
rpc ListConfigs (, )
runtimeconfig.proto:43Lists all the RuntimeConfig resources within project.
message
runtimeconfig.proto:188Request for the `ListConfigs()` method.
string parent = 1
The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`.
int32 page_size = 2
Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.
string page_token = 3
Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.
message
runtimeconfig.proto:205`ListConfigs()` returns the following response. The order of returned objects is arbitrary; that is, it is not ordered in any particular way.
repeated configs = 1
A list of the configurations in the project. The order of returned objects is arbitrary; that is, it is not ordered in any particular way.
string next_page_token = 2
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
rpc GetConfig (, )
runtimeconfig.proto:50Gets information about a RuntimeConfig resource.
message
runtimeconfig.proto:219Gets a RuntimeConfig resource.
string name = 2
The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
rpc CreateConfig (, )
runtimeconfig.proto:58Creates a new RuntimeConfig resource. The configuration name must be unique within project.
message
runtimeconfig.proto:227Creates a RuntimeConfig resource.
string parent = 1
The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`.
optional config = 2
The RuntimeConfig to create.
string request_id = 3
An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.
rpc UpdateConfig (, )
runtimeconfig.proto:66Updates a RuntimeConfig resource. The configuration must exist beforehand.
message
runtimeconfig.proto:250Request message for `UpdateConfig()` method.
string name = 1
The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
optional config = 2
The config resource to update.
rpc DeleteConfig (, )
runtimeconfig.proto:74Deletes a RuntimeConfig resource.
message
runtimeconfig.proto:261Request for the `DeleteConfig()` method.
string name = 1
The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
rpc ListVariables (, )
runtimeconfig.proto:84Lists variables within given a configuration, matching any provided filters. This only lists variable names, not the values, unless `return_values` is true, in which case only variables that user has IAM permission to GetVariable will be returned.
message
runtimeconfig.proto:269Request for the `ListVariables()` method.
string parent = 1
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]`
string filter = 2
Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.
int32 page_size = 3
Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.
string page_token = 4
Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.
bool return_values = 5
The flag indicates whether the user wants to return values of variables. If true, then only those variables that user has IAM GetVariable permission will be returned along with their values.
message
runtimeconfig.proto:297Response for the `ListVariables()` method.
repeated variables = 1
A list of variables and their values. The order of returned variable objects is arbitrary.
string next_page_token = 2
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
rpc GetVariable (, )
runtimeconfig.proto:91Gets information about a single variable.
message
runtimeconfig.proto:327Request for the `GetVariable()` method.
string name = 1
The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`
rpc WatchVariable (, )
runtimeconfig.proto:111Watches 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.
message
runtimeconfig.proto:311Request for the `WatchVariable()` method.
string name = 1
The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
optional newer_than = 4
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.
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.
message
runtimeconfig.proto:335Request for the `CreateVariable()` method.
string parent = 1
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]`
optional variable = 2
The variable to create.
string request_id = 3
An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.
Updates an existing variable with a new value.
message
runtimeconfig.proto:359Request for the `UpdateVariable()` method.
string name = 1
The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`
optional variable = 2
The variable to update.
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.
message
runtimeconfig.proto:370Request for the `DeleteVariable()` method.
string name = 1
The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`
bool recursive = 2
Set to `true` to recursively delete multiple variables with the same prefix.
rpc ListWaiters (, )
runtimeconfig.proto:154List waiters within the given configuration.
message
runtimeconfig.proto:382Request for the `ListWaiters()` method.
string parent = 1
The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must by in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`
int32 page_size = 2
Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.
string page_token = 3
Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.
message
runtimeconfig.proto:400Response for the `ListWaiters()` method. Order of returned waiter objects is arbitrary.
repeated waiters = 1
Found waiters in the project.
string next_page_token = 2
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
rpc GetWaiter (, )
runtimeconfig.proto:161Gets information about a single waiter.
message
runtimeconfig.proto:413Request for the `GetWaiter()` method.
string name = 1
The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`
rpc CreateWaiter (, )
runtimeconfig.proto:172Creates a Waiter resource. This operation returns a long-running Operation resource which can be polled for completion. However, a waiter with the given name will exist (and can be retrieved) prior to the operation completing. If the operation fails, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts.
message
runtimeconfig.proto:422Request message for `CreateWaiter()` method.
string parent = 1
The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must by in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.
optional waiter = 2
The Waiter resource to create.
string request_id = 3
An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.
rpc DeleteWaiter (, )
runtimeconfig.proto:180Deletes the waiter with the specified name.
message
runtimeconfig.proto:446Request for the `DeleteWaiter()` method.
string name = 1
The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`
message
resources.proto:100The condition that a Waiter resource is waiting for.
Used in:
oneof condition
The condition oneof holds the available condition types for this EndCondition. Currently, the only available type is Cardinality.
cardinality = 1
The cardinality of the `EndCondition`.
message
resources.proto:115A Cardinality condition for the Waiter resource. A cardinality condition is met when the number of variables under a specified path prefix reaches a predefined number. For example, if you set a Cardinality condition where the `path` is set to `/foo` and the number of paths is set to 2, the following variables would meet the condition in a RuntimeConfig resource: + `/foo/variable1 = "value1"` + `/foo/variable2 = "value2"` + `/bar/variable3 = "value3"` It would not would not satisify the same condition with the `number` set to 3, however, because there is only 2 paths that start with `/foo`. Cardinality conditions are recursive; all subtrees under the specific path prefix are counted.
Used in:
string path = 1
The root of the variable subtree to monitor. For example, `/foo`.
int32 number = 2
The number variables under the `path` that must exist to meet this condition. Defaults to 1 if not specified.
message
resources.proto:33A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig service. A RuntimeConfig resource consists of metadata and a hierarchy of variables.
Used as response type in: RuntimeConfigManager.CreateConfig, RuntimeConfigManager.GetConfig, RuntimeConfigManager.UpdateConfig
Used as field type in: , ,
string name = 1
The resource name of a runtime config. The name must have the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an arbitrary name that matches RFC 1035 segment specification. The length of `[CONFIG_NAME]` must be less than 64 bytes. You pick the RuntimeConfig resource name, but the server will validate that the name adheres to this format. After you create the resource, you cannot change the resource's name.
string description = 2
An optional description of the RuntimeConfig object.
message
resources.proto:56Describes 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).
Used as response type in: RuntimeConfigManager.CreateVariable, RuntimeConfigManager.GetVariable, RuntimeConfigManager.UpdateVariable, RuntimeConfigManager.WatchVariable
Used as field type in: , ,
string name = 1
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.
oneof contents
The value of the variable. It can be either a binary or a string value. You must specify one of either `value` or `text`. Specifying both will cause the server to return an error.
bytes value = 2
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. Only one of `value` or `text` can be set.
string text = 5
The string value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. For example, `text: "my text value"`. The string must be valid UTF-8.
optional update_time = 3
[Output Only] The time of the last variable update.
VariableState state = 4
[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.
The `VariableState` describes the last known state of the variable and is used during a `variables().watch` call to distinguish the state of the variable.
Used in:
VARIABLE_STATE_UNSPECIFIED = 0
Default variable state.
UPDATED = 1
The variable was updated, while `variables().watch` was executing.
DELETED = 2
The variable was deleted, while `variables().watch` was executing.
message
resources.proto:148A Waiter resource waits for some end condition within a RuntimeConfig resource to be met before it returns. For example, assume you have a distributed system where each node writes to a Variable resource indidicating the node's readiness as part of the startup process. You then configure a Waiter resource with the success condition set to wait until some number of nodes have checked in. Afterwards, your application runs some arbitrary code after the condition has been met and the waiter returns successfully. Once created, a Waiter resource is immutable. To learn more about using waiters, read the [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter) documentation.
Used as response type in: RuntimeConfigManager.GetWaiter
Used as field type in: ,
string name = 1
The name of the Waiter resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The `[PROJECT_ID]` must be a valid Google Cloud project ID, the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the `[WAITER_NAME]` must match RFC 1035 segment specification, and the length of `[WAITER_NAME]` must be less than 64 bytes. After you create a Waiter resource, you cannot change the resource name.
optional timeout = 2
[Required] Specifies the timeout of the waiter in seconds, beginning from the instant that `waiters().create` method is called. If this time elapses before the success or failure conditions are met, the waiter fails and sets the `error` code to `DEADLINE_EXCEEDED`.
optional failure = 3
[Optional] The failure condition of this waiter. If this condition is met, `done` will be set to `true` and the `error` code will be set to `ABORTED`. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated. This value is optional; if no failure condition is set, the only failure scenario will be a timeout.
optional success = 4
[Required] The success condition. If this condition is met, `done` will be set to `true` and the `error` value will remain unset. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated.
optional create_time = 5
[Output Only] The instant at which this Waiter resource was created. Adding the value of `timeout` to this instant yields the timeout deadline for the waiter.
bool done = 6
[Output Only] If the value is `false`, it means the waiter is still waiting for one of its conditions to be met. If true, the waiter has finished. If the waiter finished due to a timeout or failure, `error` will be set.
optional error = 7
[Output Only] If the waiter ended due to a failure or timeout, this value will be set.