Index: discovery/googleapis_beta/runtimeconfig__v1beta1.json |
diff --git a/discovery/googleapis_beta/runtimeconfig__v1beta1.json b/discovery/googleapis_beta/runtimeconfig__v1beta1.json |
index c39d409a5718186939eb95595b911a847343d438..4ec0ce9dc43923bcd7e5bc23dba492169fa8bfc0 100644 |
--- a/discovery/googleapis_beta/runtimeconfig__v1beta1.json |
+++ b/discovery/googleapis_beta/runtimeconfig__v1beta1.json |
@@ -122,7 +122,7 @@ |
"configs": { |
"methods": { |
"update": { |
- "description": "Updates the config resource object.\nRuntimeConfig object must already exist.", |
+ "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.", |
"httpMethod": "PUT", |
"id": "runtimeconfig.projects.configs.update", |
"parameterOrder": [ |
@@ -130,7 +130,7 @@ |
], |
"parameters": { |
"name": { |
- "description": "The name of the config resource to update.\nRequired. Must be a valid config resource.", |
+ "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*$", |
"required": true, |
@@ -150,7 +150,7 @@ |
] |
}, |
"get": { |
- "description": "Gets the config resource object.", |
+ "description": "Gets information about a RuntimeConfig resource.", |
"httpMethod": "GET", |
"id": "runtimeconfig.projects.configs.get", |
"parameterOrder": [ |
@@ -158,7 +158,7 @@ |
], |
"parameters": { |
"name": { |
- "description": "The name of the RuntimeConfig resource object to retrieve.", |
+ "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*$", |
"required": true, |
@@ -175,7 +175,7 @@ |
] |
}, |
"create": { |
- "description": "CreateConfig creates a new config resource object.\nThe configuration name must be unique within project.", |
+ "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.", |
"httpMethod": "POST", |
"id": "runtimeconfig.projects.configs.create", |
"parameterOrder": [ |
@@ -183,7 +183,7 @@ |
], |
"parameters": { |
"parent": { |
- "description": "The cloud project to which configuration belongs.\nRequired. Must be a valid GCP project.", |
+ "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.", |
"location": "path", |
"pattern": "^projects/[^/]*$", |
"required": true, |
@@ -203,7 +203,7 @@ |
] |
}, |
"list": { |
- "description": "Lists all the config objects within project.", |
+ "description": "Lists all the RuntimeConfig resources within project.", |
"httpMethod": "GET", |
"id": "runtimeconfig.projects.configs.list", |
"parameterOrder": [ |
@@ -211,20 +211,20 @@ |
], |
"parameters": { |
"pageSize": { |
- "description": "List pagination support.\nThe size of the page to return. We may return fewer elements.", |
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", |
"format": "int32", |
"location": "query", |
"type": "integer" |
}, |
"parent": { |
- "description": "The cloud project, whose configuration resources we want to list.\nRequired. Must be a valid GCP project.", |
+ "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.", |
"location": "path", |
"pattern": "^projects/[^/]*$", |
"required": true, |
"type": "string" |
}, |
"pageToken": { |
- "description": "The token for pagination.", |
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", |
"location": "query", |
"type": "string" |
} |
@@ -239,7 +239,7 @@ |
] |
}, |
"delete": { |
- "description": "Deletes the config object.", |
+ "description": "Deletes a RuntimeConfig resource.", |
"httpMethod": "DELETE", |
"id": "runtimeconfig.projects.configs.delete", |
"parameterOrder": [ |
@@ -247,7 +247,7 @@ |
], |
"parameters": { |
"name": { |
- "description": "The configuration resource object to delete.\nRequired. Must be a valid GCP project.", |
+ "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*$", |
"required": true, |
@@ -268,7 +268,7 @@ |
"variables": { |
"methods": { |
"watch": { |
- "description": "WatchVariable watches for a variable to change and then returns the new\nvalue or times out.\nIf variable is deleted while being watched, VariableState will be DELETED\nand the Value will contain the last known value.\nIf the operation deadline is set to a larger value than internal timeout\nexisting, current variable value will be returned and Variable state will\nbe VARIABLE_STATE_UNSPECIFIED.", |
+ "description": "Watches a specific variable and waits for a change in the variable's value.\nWhen there is a change, this method returns the new value or times out.\n\nIf a variable is deleted while being watched, the `variableState` state is\nset to `DELETED` and the method returns the last known variable `value`.\n\nIf you set the deadline for watching to a larger value than internal timeout\n(60 seconds), the current variable value is returned and the `variableState`\nwill be `VARIABLE_STATE_UNSPECIFIED`.\n\nTo learn more about creating a watcher, read the\n[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)\ndocumentation.", |
"httpMethod": "POST", |
"id": "runtimeconfig.projects.configs.variables.watch", |
"parameterOrder": [ |
@@ -276,7 +276,7 @@ |
], |
"parameters": { |
"name": { |
- "description": "The name of the variable to retrieve.", |
+ "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*/variables/.*$", |
"required": true, |
@@ -296,7 +296,7 @@ |
] |
}, |
"list": { |
- "description": "Lists variables within given RuntimeConfig object, matching optionally\nprovided filter.\nList contains only variable metadata, but not values.", |
+ "description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values.", |
"httpMethod": "GET", |
"id": "runtimeconfig.projects.configs.variables.list", |
"parameterOrder": [ |
@@ -304,25 +304,25 @@ |
], |
"parameters": { |
"pageSize": { |
- "description": "List pagination support.\nThe size of the page to return. We may return fewer elements.", |
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", |
"format": "int32", |
"location": "query", |
"type": "integer" |
}, |
"filter": { |
- "description": "List only variables matching filter prefix exactly.\ne.g. `projects/{project_id}/config/{config_id}/variables/{variable/id}`.", |
+ "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.", |
"location": "query", |
"type": "string" |
}, |
"parent": { |
- "description": "Which RuntimeConfig object to list for variables.", |
+ "description": "The path to the RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*$", |
"required": true, |
"type": "string" |
}, |
"pageToken": { |
- "description": "The token for pagination.", |
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", |
"location": "query", |
"type": "string" |
} |
@@ -337,7 +337,7 @@ |
] |
}, |
"get": { |
- "description": "Gets the variable resource object.", |
+ "description": "Gets information about a single variable.", |
"httpMethod": "GET", |
"id": "runtimeconfig.projects.configs.variables.get", |
"parameterOrder": [ |
@@ -345,7 +345,7 @@ |
], |
"parameters": { |
"name": { |
- "description": "What variable to return.", |
+ "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*/variables/.*$", |
"required": true, |
@@ -362,7 +362,7 @@ |
] |
}, |
"create": { |
- "description": "Creates a variable within the given configuration.\nCreate variable will create all required intermediate path elements.\nIt is a FAILED_PRECONDITION error to create a variable with a name that is\na prefix of an existing variable name, or that has an existing variable\nname as a prefix.", |
+ "description": "Creates a variable within the given configuration. You cannot create\na variable with a name that is a prefix of an existing variable name, or a\nname that has an existing variable name as a prefix.\n\nTo learn more about creating a variable, read the\n[Setting and Getting Data](/deployment-manager/runtime-configurator/seta-and-get-variables)\ndocumentation.", |
"httpMethod": "POST", |
"id": "runtimeconfig.projects.configs.variables.create", |
"parameterOrder": [ |
@@ -370,7 +370,7 @@ |
], |
"parameters": { |
"parent": { |
- "description": "The configuration parent, that will own the variable.\nRequired, must a valid configuration name within project_id.", |
+ "description": "The path to the RutimeConfig resource that this variable should belong to.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*$", |
"required": true, |
@@ -398,7 +398,7 @@ |
], |
"parameters": { |
"name": { |
- "description": "The name of the variable to update.\nIn the format of:\n\"projects/{project_id}/configs/{config_id}/variables/{variable_id}\"", |
+ "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*/variables/.*$", |
"required": true, |
@@ -418,7 +418,7 @@ |
] |
}, |
"delete": { |
- "description": "Deletes variable or variables.\nIf name denotes a variable, that variable is deleted. If name is a prefix\nand recursive is true, then all variables with that prefix are deleted,\nit's a FAILED_PRECONDITION to delete a prefix without recursive being true.", |
+ "description": "Deletes a variable or multiple variables.\n\nIf you specify a variable name, then that variable is deleted. If you\nspecify a prefix and `recursive` is true, then all variables with that\nprefix are deleted. You must set a `recursive` to true if you delete\nvariables by prefix.", |
"httpMethod": "DELETE", |
"id": "runtimeconfig.projects.configs.variables.delete", |
"parameterOrder": [ |
@@ -426,12 +426,12 @@ |
], |
"parameters": { |
"recursive": { |
- "description": "If recursive is false and name is a prefix of other variables, then\nthe request will fail.", |
+ "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.", |
"location": "query", |
"type": "boolean" |
}, |
"name": { |
- "description": "The name of the variable to delete.", |
+ "description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*/variables/.*$", |
"required": true, |
@@ -452,7 +452,7 @@ |
"waiters": { |
"methods": { |
"get": { |
- "description": "Gets the Waiter resource with the specified name.", |
+ "description": "Gets information about a single waiter.", |
"httpMethod": "GET", |
"id": "runtimeconfig.projects.configs.waiters.get", |
"parameterOrder": [ |
@@ -460,7 +460,7 @@ |
], |
"parameters": { |
"name": { |
- "description": "The fully-qualified name of the Waiter resource object to retrieve.", |
+ "description": "The fully-qualified name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*/waiters/[^/]*$", |
"required": true, |
@@ -477,7 +477,7 @@ |
] |
}, |
"create": { |
- "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a Waiter with the\ngiven name will exist (and can be retrieved) prior to the resultant\nOperation completing. If the resultant Operation indicates a failure, the\nfailed Waiter resource will still exist and must be deleted prior to\nsubsequent creation attempts.", |
+ "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a waiter with the\ngiven name will exist (and can be retrieved) prior to the operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts.", |
"httpMethod": "POST", |
"id": "runtimeconfig.projects.configs.waiters.create", |
"parameterOrder": [ |
@@ -485,7 +485,7 @@ |
], |
"parameters": { |
"parent": { |
- "description": "The fully-qualified name of the configuration that will own the waiter.\nRequired. Must be a valid configuration name.", |
+ "description": "The path to the configuration that will own the waiter.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*$", |
"required": true, |
@@ -505,7 +505,7 @@ |
] |
}, |
"list": { |
- "description": "List Waiters within the given RuntimeConfig resource.", |
+ "description": "List waiters within the given configuration.", |
"httpMethod": "GET", |
"id": "runtimeconfig.projects.configs.waiters.list", |
"parameterOrder": [ |
@@ -513,20 +513,20 @@ |
], |
"parameters": { |
"pageSize": { |
- "description": "List pagination support.\nThe size of the page to return. We may return fewer elements.", |
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", |
"format": "int32", |
"location": "query", |
"type": "integer" |
}, |
"parent": { |
- "description": "The fully-qualified name of the configuration to list.\nRequired. Must be a valid configuration name.", |
+ "description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*$", |
"required": true, |
"type": "string" |
}, |
"pageToken": { |
- "description": "The token for pagination.", |
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", |
"location": "query", |
"type": "string" |
} |
@@ -541,7 +541,7 @@ |
] |
}, |
"delete": { |
- "description": "Deletes the Waiter with the specified name.", |
+ "description": "Deletes the waiter with the specified name.", |
"httpMethod": "DELETE", |
"id": "runtimeconfig.projects.configs.waiters.delete", |
"parameterOrder": [ |
@@ -549,7 +549,7 @@ |
], |
"parameters": { |
"name": { |
- "description": "The Waiter resource to delete.", |
+ "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", |
"location": "path", |
"pattern": "^projects/[^/]*/configs/[^/]*/waiters/[^/]*$", |
"required": true, |
@@ -601,7 +601,7 @@ |
} |
} |
}, |
- "revision": "20160518", |
+ "revision": "20160524", |
"rootUrl": "https://runtimeconfig.googleapis.com/", |
"schemas": { |
"Status": { |
@@ -632,15 +632,14 @@ |
"type": "object" |
}, |
"ListConfigsResponse": { |
- "description": "Response for the `ListConfigs()` method.\nOrder of returned configuration objects is arbitrary.", |
"id": "ListConfigsResponse", |
"properties": { |
"nextPageToken": { |
- "description": "Pagination support.", |
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", |
"type": "string" |
}, |
"configs": { |
- "description": "Found configurations in the project.", |
+ "description": "A list of the configurations in the project. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.", |
"items": { |
"$ref": "RuntimeConfig" |
}, |
@@ -650,11 +649,11 @@ |
"type": "object" |
}, |
"Variable": { |
- "description": "Variable message describes a single variable within a Configuration object.\nname denotes the hierarchical variable name, e.g.\nports/serving_port within flags configuration object.\nValue is an opaque string and only leaf variables can have values.", |
+ "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).", |
"id": "Variable", |
"properties": { |
"value": { |
- "description": "`len(value)` must be less than 4096 bytes. Empty values are also accepted.\nvalue must be Base64 encoded.", |
+ "description": "The value of the variable. The length of the value must be less than 4096\nbytes. Empty values are also accepted. The value must be Base64 encoded.", |
"format": "byte", |
"type": "string" |
}, |
@@ -664,7 +663,7 @@ |
"type": "string" |
}, |
"state": { |
- "description": "[Ouput only] The current state of the variable.\nState denotes the outcome of the Watch call and is unset by the Get/List\ncalls.", |
+ "description": "[Ouput only] The current state of the variable. The variable state indicates\nthe outcome of the `variables().watch` call and is visible through the\n`get` and `list` calls.", |
"enum": [ |
"VARIABLE_STATE_UNSPECIFIED", |
"UPDATED", |
@@ -672,13 +671,13 @@ |
], |
"enumDescriptions": [ |
"Default variable state.", |
- "Variable had been updated, while watch was executing.", |
- "Variable had been deleted, while watch was executing." |
+ "The variable was updated, while `variables().watch` was executing.", |
+ "The variable was deleted, while `variables().watch` was executing." |
], |
"type": "string" |
}, |
"name": { |
- "description": "Name of the variable resource.\nIt has format of\n\"projects/{project_id}/configs/{config_id}/variables/{variable_id}\",\nWhere `project_id` must be a valid Google Cloud project ID, `config_id`\nmust be a valid RuntimeConfig object and `variable_id` follows Unix\nfile system file path naming.\n`variable_id` can contain ASCII letters, numbers, slashes and dashes.\nSlashes are used as path element separators and are not part of the\n`variable_id` itself, so `variable_id` must contain at least one non-slash\ncharacter. Multiple slashes are coalesced into single slash character.\nEach path segment should follow RFC 1035 segment specification.\n`len(variable_id)` must be less than 256 bytes.\nThe name is assigned by the client, but will be validated on the server\nside to adhere to the format.\nName is immutable and cannot be changed.", |
+ "description": "The name of the variable resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a\nvalid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system\nfile path naming.\n\nThe `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and\ndashes. Slashes are used as path element separators and are not part of the\n`[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one\nnon-slash character. Multiple slashes are coalesced into single slash\ncharacter. Each path segment should follow RFC 1035 segment specification.\nThe length of a `[VARIABLE_NAME]` must be less than 256 bytes.\n\nOnce you create a variable, you cannot change the variable name.", |
"type": "string" |
} |
}, |
@@ -720,52 +719,52 @@ |
"type": "object" |
}, |
"Waiter": { |
- "description": "A Waiter resource waits for some condition within a RuntimeConfig resource\nto be met. For example: each node in a distributed system startup process\nwrites a value to a Variable resource indicating its readiness. A Waiter\nconfigured with the proper `success` condition can be used to wait until\nsome number of nodes have checked in.\nOnce created, a Waiter resource is immutable.", |
+ "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource\nto be met before it returns. For example, assume you have a distributed\nsystem where each node writes to a Variable resource indidicating the node's\nreadiness as part of the startup process.\n\nYou then configure a Waiter resource with the success condition set to wait\nuntil some number of nodes have checked in. Afterwards, your application\nruns some arbitrary code after the condition has been met and the waiter\nreturns successfully.\n\nOnce created, a Waiter resource is immutable.\n\nTo learn more about using waiters, read the\n[Creating a Waiter](/deployment-manager/runtime-config/creating-a-water)\ndocumentation.", |
"id": "Waiter", |
"properties": { |
"timeout": { |
- "description": "The timeout, beginning from the instant that CreateWaiter is called. If\nthis timeout elapses prior to the success or failure conditions being met,\nthe Waiter will fail and the `error` code will be set to DEADLINE_EXCEEDED.\nRequired.", |
+ "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.", |
"format": "google-duration", |
"type": "string" |
}, |
"success": { |
"$ref": "EndCondition", |
- "description": "The success condition. If this condition is met, `done` will be set to\n`true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated. Required." |
+ "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated." |
}, |
"failure": { |
"$ref": "EndCondition", |
- "description": "The failure condition. If this condition is met, `done` will be set to\n`true` and the `error` code will be set to ABORTED. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated. This value is optional; if no failure condition\nis set, the only failure scenario will be a timeout. Optional." |
+ "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout." |
}, |
"createTime": { |
- "description": "The instant at which this Waiter was created. Adding the value of `timeout`\nto this instant yields the timeout deadline for this Waiter. Output only.", |
+ "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.", |
"format": "google-datetime", |
"type": "string" |
}, |
"name": { |
- "description": "Name of the variable resource.\nIt has format of\n\"projects/{project_id}/configs/{config_id}/waiters/{waiter_id}\",\nWhere `project_id` must be a valid Google Cloud project ID, `config_id`\nmust be a valid RuntimeConfig object and the `waiter_id` must match\nRFC 1035 segment specification, and `len(waiter_id)` must be less than\n64 bytes.\nThe name is assigned by the client, but will be validated on the server\nside to adhere to the format.\nName is immutable and cannot be changed. Required.", |
+ "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.", |
"type": "string" |
}, |
"error": { |
"$ref": "Status", |
- "description": "If the Waiter ended due to a failure or timeout, this value will be set.\nOutput only.\n" |
+ "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set.\n" |
}, |
"done": { |
- "description": "If the value is `false`, it means the Waiter is still waiting for one of\nits conditions to be met.\nIf true, the Waiter has finished. If the Waiter finished due to a timeout\nor failure, `error` will be set. Output only.", |
+ "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.", |
"type": "boolean" |
} |
}, |
"type": "object" |
}, |
"RuntimeConfig": { |
- "description": "RuntimeConfig is the primary resource in the Configuration service.\nIt consists of metadata and a hierarchy of variables.", |
+ "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata and a hierarchy of\nvariables.", |
"id": "RuntimeConfig", |
"properties": { |
"description": { |
- "description": "Description of the configuration object.\n`len(description)` must be less than 256.", |
+ "description": "An optional description of the RuntimeConfig object.\nThe length of the description must be less than 256 bytes.", |
"type": "string" |
}, |
"name": { |
- "description": "The resource name of a runtime config.\nIt has the format of \"projects/{project_id}/configs/{config_id}\",\nwhere `project_id` is a valid Google cloud project ID, and the\n`config_id` must match RFC 1035 segment specification, and\n`len(config_id)` must be less than 64 bytes.\nThe name is assigned by the client, but will be validated on the server\nside to adhere to the format.\nName is immutable and cannot be changed.", |
+ "description": "The resource name of a runtime config. The name must have the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an\narbitrary name that matches RFC 1035 segment specification. The length of\n`[CONFIG_NAME]` must be less than 64 bytes.\n\nYou pick the RuntimeConfig resource name, but the server will validate that\nthe name adheres to this format. After you create the resource, you cannot\nchange the resource's name.", |
"type": "string" |
} |
}, |
@@ -776,7 +775,7 @@ |
"id": "ListWaitersResponse", |
"properties": { |
"nextPageToken": { |
- "description": "Pagination support.", |
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", |
"type": "string" |
}, |
"waiters": { |
@@ -790,26 +789,26 @@ |
"type": "object" |
}, |
"EndCondition": { |
- "description": "A condition that a Waiter resource is waiting for. The set of possible\nconditions may expand over time.", |
+ "description": "The condition that a Waiter resource is waiting for.", |
"id": "EndCondition", |
"properties": { |
"cardinality": { |
"$ref": "Cardinality", |
- "description": "The Cardinality condition type configuration." |
+ "description": "The cardinality of the `EndCondition`." |
} |
}, |
"type": "object" |
}, |
"Cardinality": { |
- "description": "The Cardinality condition is met when the count of `Variable` resources\nunder the specified path prefix reaches the specified number.\nFor example, take the following variables in a RuntimeConfig object:\n /foo/variable1 = \"value1\"\n /foo/variable2 = \"value2\"\n /bar/variable3 = \"value3\"\n\nThese variables would satisfy a Cardinality condition with `path` set to\n\"/foo\" and `number` set to 2, but would not satisify the same condition\nwith `number` set to 3.", |
+ "description": "A Cardinality condition for the Waiter resource. A cardinality condition is\nmet when the number of variables under a specified path prefix reaches a\npredefined number. For example, if you set a Cardinality condition where\nthe `path` is set to `/foo` and the number of paths is set to 2, the\nfollowing variables would meet the condition in a RuntimeConfig resource:\n\n+ `/foo/variable1 = \"value1\"`\n+ `/foo/variable2 = \"value2\"`\n+ `/bar/variable3 = \"value3\"`\n\nIt would not would not satisify the same condition with the `number` set to\n3, however, because there is only 2 paths that start with `/foo`.\nCardinality conditions are recursive; all subtrees under the specific\npath prefix are counted.", |
"id": "Cardinality", |
"properties": { |
"path": { |
- "description": "The root of the variable subtree to monitor. Required.", |
+ "description": "The root of the variable subtree to monitor. For example, `/foo`.", |
"type": "string" |
}, |
"number": { |
- "description": "The number of decendents of `path` that must exist before this condition\nis met. Optional; defaults to 1 if not specified.", |
+ "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.", |
"format": "int32", |
"type": "integer" |
} |
@@ -827,7 +826,7 @@ |
"id": "WatchVariableRequest", |
"properties": { |
"newerThan": { |
- "description": "If backend has a variable that has a newer value than this timestamp, then\nrequest will return immediately with current value.\nIf not specified or variable has an older timestamp, will wait for the new\nvalue.", |
+ "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.", |
"format": "google-datetime", |
"type": "string" |
} |
@@ -835,18 +834,17 @@ |
"type": "object" |
}, |
"ListVariablesResponse": { |
- "description": "Response for the `ListVariables()` method.\nOrder of returned variable objects is arbitrary.", |
"id": "ListVariablesResponse", |
"properties": { |
"variables": { |
- "description": "Matched variables and their values.", |
+ "description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.", |
"items": { |
"$ref": "Variable" |
}, |
"type": "array" |
}, |
"nextPageToken": { |
- "description": "Pagination support.", |
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", |
"type": "string" |
} |
}, |