1153 lines
62 KiB
JSON
1153 lines
62 KiB
JSON
{
|
|
"ownerName": "Google",
|
|
"resources": {
|
|
"projects": {
|
|
"resources": {
|
|
"configs": {
|
|
"methods": {
|
|
"delete": {
|
|
"httpMethod": "DELETE",
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"name": {
|
|
"pattern": "^projects/[^/]+/configs/[^/]+$",
|
|
"location": "path",
|
|
"description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
|
|
"path": "v1beta1/{+name}",
|
|
"id": "runtimeconfig.projects.configs.delete",
|
|
"description": "Deletes a RuntimeConfig resource."
|
|
},
|
|
"list": {
|
|
"description": "Lists all the RuntimeConfig resources within project.",
|
|
"httpMethod": "GET",
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"response": {
|
|
"$ref": "ListConfigsResponse"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"pageSize": {
|
|
"location": "query",
|
|
"format": "int32",
|
|
"description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"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]`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+$",
|
|
"location": "path"
|
|
},
|
|
"pageToken": {
|
|
"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.",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs",
|
|
"path": "v1beta1/{+parent}/configs",
|
|
"id": "runtimeconfig.projects.configs.list"
|
|
},
|
|
"setIamPolicy": {
|
|
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
|
"request": {
|
|
"$ref": "SetIamPolicyRequest"
|
|
},
|
|
"response": {
|
|
"$ref": "Policy"
|
|
},
|
|
"parameterOrder": [
|
|
"resource"
|
|
],
|
|
"httpMethod": "POST",
|
|
"parameters": {
|
|
"resource": {
|
|
"pattern": "^projects/[^/]+/configs/[^/]+$",
|
|
"location": "path",
|
|
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy",
|
|
"id": "runtimeconfig.projects.configs.setIamPolicy",
|
|
"path": "v1beta1/{+resource}:setIamPolicy"
|
|
},
|
|
"create": {
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"response": {
|
|
"$ref": "RuntimeConfig"
|
|
},
|
|
"parameters": {
|
|
"requestId": {
|
|
"location": "query",
|
|
"description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"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]`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs",
|
|
"path": "v1beta1/{+parent}/configs",
|
|
"id": "runtimeconfig.projects.configs.create",
|
|
"description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.",
|
|
"request": {
|
|
"$ref": "RuntimeConfig"
|
|
}
|
|
},
|
|
"getIamPolicy": {
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy",
|
|
"path": "v1beta1/{+resource}:getIamPolicy",
|
|
"id": "runtimeconfig.projects.configs.getIamPolicy",
|
|
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
|
|
"httpMethod": "GET",
|
|
"response": {
|
|
"$ref": "Policy"
|
|
},
|
|
"parameterOrder": [
|
|
"resource"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"resource": {
|
|
"location": "path",
|
|
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+$"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"description": "Gets information about a RuntimeConfig resource.",
|
|
"httpMethod": "GET",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"response": {
|
|
"$ref": "RuntimeConfig"
|
|
},
|
|
"parameters": {
|
|
"name": {
|
|
"pattern": "^projects/[^/]+/configs/[^/]+$",
|
|
"location": "path",
|
|
"description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
|
|
"path": "v1beta1/{+name}",
|
|
"id": "runtimeconfig.projects.configs.get"
|
|
},
|
|
"update": {
|
|
"description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.",
|
|
"request": {
|
|
"$ref": "RuntimeConfig"
|
|
},
|
|
"response": {
|
|
"$ref": "RuntimeConfig"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "PUT",
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
|
|
"id": "runtimeconfig.projects.configs.update",
|
|
"path": "v1beta1/{+name}"
|
|
},
|
|
"testIamPermissions": {
|
|
"id": "runtimeconfig.projects.configs.testIamPermissions",
|
|
"path": "v1beta1/{+resource}:testIamPermissions",
|
|
"request": {
|
|
"$ref": "TestIamPermissionsRequest"
|
|
},
|
|
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
|
|
"response": {
|
|
"$ref": "TestIamPermissionsResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"resource"
|
|
],
|
|
"httpMethod": "POST",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"resource": {
|
|
"location": "path",
|
|
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+$"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions"
|
|
}
|
|
},
|
|
"resources": {
|
|
"variables": {
|
|
"methods": {
|
|
"get": {
|
|
"description": "Gets information about a single variable.",
|
|
"response": {
|
|
"$ref": "Variable"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "GET",
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
|
|
"id": "runtimeconfig.projects.configs.variables.get",
|
|
"path": "v1beta1/{+name}"
|
|
},
|
|
"watch": {
|
|
"response": {
|
|
"$ref": "Variable"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "POST",
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch",
|
|
"id": "runtimeconfig.projects.configs.variables.watch",
|
|
"path": "v1beta1/{+name}:watch",
|
|
"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.",
|
|
"request": {
|
|
"$ref": "WatchVariableRequest"
|
|
}
|
|
},
|
|
"update": {
|
|
"response": {
|
|
"$ref": "Variable"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "PUT",
|
|
"parameters": {
|
|
"name": {
|
|
"pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
|
|
"location": "path",
|
|
"description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
|
|
"id": "runtimeconfig.projects.configs.variables.update",
|
|
"path": "v1beta1/{+name}",
|
|
"description": "Updates an existing variable with a new value.",
|
|
"request": {
|
|
"$ref": "Variable"
|
|
}
|
|
},
|
|
"testIamPermissions": {
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [
|
|
"resource"
|
|
],
|
|
"response": {
|
|
"$ref": "TestIamPermissionsResponse"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"resource": {
|
|
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions",
|
|
"path": "v1beta1/{+resource}:testIamPermissions",
|
|
"id": "runtimeconfig.projects.configs.variables.testIamPermissions",
|
|
"request": {
|
|
"$ref": "TestIamPermissionsRequest"
|
|
},
|
|
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
|
|
},
|
|
"delete": {
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "DELETE",
|
|
"parameters": {
|
|
"recursive": {
|
|
"location": "query",
|
|
"description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
|
|
"location": "path",
|
|
"description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
|
|
"id": "runtimeconfig.projects.configs.variables.delete",
|
|
"path": "v1beta1/{+name}",
|
|
"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."
|
|
},
|
|
"list": {
|
|
"description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values, unless `return_values` is\ntrue, in which case only variables that user has IAM permission to GetVariable\nwill be returned.",
|
|
"response": {
|
|
"$ref": "ListVariablesResponse"
|
|
},
|
|
"httpMethod": "GET",
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"filter": {
|
|
"description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"returnValues": {
|
|
"description": "The flag indicates whether the user wants to return values of variables.\nIf true, then only those variables that user has IAM GetVariable permission\nwill be returned along with their values.",
|
|
"type": "boolean",
|
|
"location": "query"
|
|
},
|
|
"pageToken": {
|
|
"location": "query",
|
|
"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.",
|
|
"type": "string"
|
|
},
|
|
"pageSize": {
|
|
"format": "int32",
|
|
"description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
|
|
"type": "integer",
|
|
"location": "query"
|
|
},
|
|
"parent": {
|
|
"description": "The path to the RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
|
|
"id": "runtimeconfig.projects.configs.variables.list",
|
|
"path": "v1beta1/{+parent}/variables"
|
|
},
|
|
"create": {
|
|
"request": {
|
|
"$ref": "Variable"
|
|
},
|
|
"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/set-and-get-variables)\ndocumentation.",
|
|
"response": {
|
|
"$ref": "Variable"
|
|
},
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"httpMethod": "POST",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"requestId": {
|
|
"description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"parent": {
|
|
"description": "The path to the RutimeConfig resource that this variable should belong to.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
|
|
"id": "runtimeconfig.projects.configs.variables.create",
|
|
"path": "v1beta1/{+parent}/variables"
|
|
}
|
|
}
|
|
},
|
|
"waiters": {
|
|
"methods": {
|
|
"delete": {
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
|
|
"id": "runtimeconfig.projects.configs.waiters.delete",
|
|
"path": "v1beta1/{+name}",
|
|
"description": "Deletes the waiter with the specified name.",
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"httpMethod": "DELETE",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"httpMethod": "GET",
|
|
"response": {
|
|
"$ref": "Waiter"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"name": {
|
|
"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]`",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
|
|
"path": "v1beta1/{+name}",
|
|
"id": "runtimeconfig.projects.configs.waiters.get",
|
|
"description": "Gets information about a single waiter."
|
|
},
|
|
"list": {
|
|
"id": "runtimeconfig.projects.configs.waiters.list",
|
|
"path": "v1beta1/{+parent}/waiters",
|
|
"description": "List waiters within the given configuration.",
|
|
"response": {
|
|
"$ref": "ListWaitersResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"httpMethod": "GET",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"pageToken": {
|
|
"location": "query",
|
|
"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.",
|
|
"type": "string"
|
|
},
|
|
"pageSize": {
|
|
"location": "query",
|
|
"format": "int32",
|
|
"description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"location": "path",
|
|
"description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+$"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters"
|
|
},
|
|
"create": {
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"response": {
|
|
"$ref": "Operation"
|
|
},
|
|
"parameters": {
|
|
"requestId": {
|
|
"location": "query",
|
|
"description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"location": "path",
|
|
"description": "The path to the configuration that will own the waiter.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+$"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
|
|
"path": "v1beta1/{+parent}/waiters",
|
|
"id": "runtimeconfig.projects.configs.waiters.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 operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts.",
|
|
"request": {
|
|
"$ref": "Waiter"
|
|
}
|
|
},
|
|
"testIamPermissions": {
|
|
"response": {
|
|
"$ref": "TestIamPermissionsResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"resource"
|
|
],
|
|
"httpMethod": "POST",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"resource": {
|
|
"location": "path",
|
|
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
|
|
"id": "runtimeconfig.projects.configs.waiters.testIamPermissions",
|
|
"path": "v1beta1/{+resource}:testIamPermissions",
|
|
"request": {
|
|
"$ref": "TestIamPermissionsRequest"
|
|
},
|
|
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
|
|
}
|
|
}
|
|
},
|
|
"operations": {
|
|
"methods": {
|
|
"testIamPermissions": {
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
|
|
"id": "runtimeconfig.projects.configs.operations.testIamPermissions",
|
|
"path": "v1beta1/{+resource}:testIamPermissions",
|
|
"request": {
|
|
"$ref": "TestIamPermissionsRequest"
|
|
},
|
|
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
|
|
"response": {
|
|
"$ref": "TestIamPermissionsResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"resource"
|
|
],
|
|
"httpMethod": "POST",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"parameters": {
|
|
"resource": {
|
|
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
|
|
"location": "path"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
|
|
"response": {
|
|
"$ref": "Operation"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "GET",
|
|
"parameters": {
|
|
"name": {
|
|
"location": "path",
|
|
"description": "The name of the operation resource.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}",
|
|
"id": "runtimeconfig.projects.configs.operations.get",
|
|
"path": "v1beta1/{+name}"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": {
|
|
"fields": {
|
|
"description": "Selector specifying which fields to include in a partial response.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"uploadType": {
|
|
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"callback": {
|
|
"description": "JSONP",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"$.xgafv": {
|
|
"description": "V1 error format.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"v1 error format",
|
|
"v2 error format"
|
|
],
|
|
"location": "query",
|
|
"enum": [
|
|
"1",
|
|
"2"
|
|
]
|
|
},
|
|
"alt": {
|
|
"enumDescriptions": [
|
|
"Responses with Content-Type of application/json",
|
|
"Media download with context-dependent Content-Type",
|
|
"Responses with Content-Type of application/x-protobuf"
|
|
],
|
|
"location": "query",
|
|
"description": "Data format for response.",
|
|
"default": "json",
|
|
"enum": [
|
|
"json",
|
|
"media",
|
|
"proto"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"access_token": {
|
|
"description": "OAuth access token.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"quotaUser": {
|
|
"location": "query",
|
|
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
|
"type": "string"
|
|
},
|
|
"pp": {
|
|
"description": "Pretty-print response.",
|
|
"default": "true",
|
|
"type": "boolean",
|
|
"location": "query"
|
|
},
|
|
"oauth_token": {
|
|
"description": "OAuth 2.0 token for the current user.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"bearer_token": {
|
|
"description": "OAuth bearer token.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"upload_protocol": {
|
|
"location": "query",
|
|
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
|
"type": "string"
|
|
},
|
|
"prettyPrint": {
|
|
"location": "query",
|
|
"description": "Returns response with indentations and line breaks.",
|
|
"default": "true",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"version": "v1beta1",
|
|
"baseUrl": "https://runtimeconfig.googleapis.com/",
|
|
"kind": "discovery#restDescription",
|
|
"description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
|
|
"servicePath": "",
|
|
"basePath": "",
|
|
"id": "runtimeconfig:v1beta1",
|
|
"documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
|
|
"revision": "20170829",
|
|
"discoveryVersion": "v1",
|
|
"version_module": true,
|
|
"schemas": {
|
|
"RuntimeConfig": {
|
|
"description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata and a hierarchy of\nvariables.",
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"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"
|
|
},
|
|
"description": {
|
|
"description": "An optional description of the RuntimeConfig object.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "RuntimeConfig"
|
|
},
|
|
"WatchVariableRequest": {
|
|
"description": "Request for the `WatchVariable()` method.",
|
|
"type": "object",
|
|
"properties": {
|
|
"newerThan": {
|
|
"format": "google-datetime",
|
|
"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.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "WatchVariableRequest"
|
|
},
|
|
"ListWaitersResponse": {
|
|
"description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.",
|
|
"type": "object",
|
|
"properties": {
|
|
"nextPageToken": {
|
|
"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": {
|
|
"description": "Found waiters in the project.",
|
|
"items": {
|
|
"$ref": "Waiter"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"id": "ListWaitersResponse"
|
|
},
|
|
"TestIamPermissionsRequest": {
|
|
"description": "Request message for `TestIamPermissions` method.",
|
|
"type": "object",
|
|
"properties": {
|
|
"permissions": {
|
|
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"id": "TestIamPermissionsRequest"
|
|
},
|
|
"Waiter": {
|
|
"properties": {
|
|
"error": {
|
|
"description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set.",
|
|
"$ref": "Status"
|
|
},
|
|
"failure": {
|
|
"$ref": "EndCondition",
|
|
"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."
|
|
},
|
|
"success": {
|
|
"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.",
|
|
"$ref": "EndCondition"
|
|
},
|
|
"done": {
|
|
"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"
|
|
},
|
|
"createTime": {
|
|
"format": "google-datetime",
|
|
"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.",
|
|
"type": "string"
|
|
},
|
|
"timeout": {
|
|
"format": "google-duration",
|
|
"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`.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"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"
|
|
}
|
|
},
|
|
"id": "Waiter",
|
|
"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-configurator/creating-a-waiter)\ndocumentation.",
|
|
"type": "object"
|
|
},
|
|
"Policy": {
|
|
"properties": {
|
|
"etag": {
|
|
"format": "byte",
|
|
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"format": "int32",
|
|
"description": "Version of the `Policy`. The default version is 0.",
|
|
"type": "integer"
|
|
},
|
|
"bindings": {
|
|
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
|
"items": {
|
|
"$ref": "Binding"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"id": "Policy",
|
|
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
|
|
"type": "object"
|
|
},
|
|
"Variable": {
|
|
"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).",
|
|
"type": "object",
|
|
"properties": {
|
|
"text": {
|
|
"description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"format": "byte",
|
|
"description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.",
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"enum": [
|
|
"VARIABLE_STATE_UNSPECIFIED",
|
|
"UPDATED",
|
|
"DELETED"
|
|
],
|
|
"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.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"Default variable state.",
|
|
"The variable was updated, while `variables().watch` was executing.",
|
|
"The variable was deleted, while `variables().watch` was executing."
|
|
]
|
|
},
|
|
"updateTime": {
|
|
"format": "google-datetime",
|
|
"description": "[Output Only] The time of the last variable update.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"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"
|
|
}
|
|
},
|
|
"id": "Variable"
|
|
},
|
|
"Operation": {
|
|
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
|
|
"type": "object",
|
|
"properties": {
|
|
"response": {
|
|
"additionalProperties": {
|
|
"description": "Properties of the object. Contains field @type with type URL.",
|
|
"type": "any"
|
|
},
|
|
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
|
|
"type": "string"
|
|
},
|
|
"error": {
|
|
"description": "The error result of the operation in case of failure or cancellation.",
|
|
"$ref": "Status"
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": {
|
|
"description": "Properties of the object. Contains field @type with type URL.",
|
|
"type": "any"
|
|
},
|
|
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
|
|
"type": "object"
|
|
},
|
|
"done": {
|
|
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"id": "Operation"
|
|
},
|
|
"SetIamPolicyRequest": {
|
|
"description": "Request message for `SetIamPolicy` method.",
|
|
"type": "object",
|
|
"properties": {
|
|
"policy": {
|
|
"$ref": "Policy",
|
|
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
|
|
}
|
|
},
|
|
"id": "SetIamPolicyRequest"
|
|
},
|
|
"Status": {
|
|
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
|
|
"type": "string"
|
|
},
|
|
"details": {
|
|
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
|
|
"items": {
|
|
"additionalProperties": {
|
|
"description": "Properties of the object. Contains field @type with type URL.",
|
|
"type": "any"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"code": {
|
|
"format": "int32",
|
|
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"id": "Status"
|
|
},
|
|
"Binding": {
|
|
"properties": {
|
|
"members": {
|
|
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"role": {
|
|
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "Binding",
|
|
"description": "Associates `members` with a `role`.",
|
|
"type": "object"
|
|
},
|
|
"Empty": {
|
|
"properties": {},
|
|
"id": "Empty",
|
|
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
|
|
"type": "object"
|
|
},
|
|
"Cardinality": {
|
|
"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.",
|
|
"type": "object",
|
|
"properties": {
|
|
"number": {
|
|
"format": "int32",
|
|
"description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.",
|
|
"type": "integer"
|
|
},
|
|
"path": {
|
|
"description": "The root of the variable subtree to monitor. For example, `/foo`.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "Cardinality"
|
|
},
|
|
"ListConfigsResponse": {
|
|
"properties": {
|
|
"nextPageToken": {
|
|
"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": "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"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"id": "ListConfigsResponse",
|
|
"description": "`ListConfigs()` returns the following response. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.",
|
|
"type": "object"
|
|
},
|
|
"EndCondition": {
|
|
"description": "The condition that a Waiter resource is waiting for.",
|
|
"type": "object",
|
|
"properties": {
|
|
"cardinality": {
|
|
"$ref": "Cardinality",
|
|
"description": "The cardinality of the `EndCondition`."
|
|
}
|
|
},
|
|
"id": "EndCondition"
|
|
},
|
|
"TestIamPermissionsResponse": {
|
|
"properties": {
|
|
"permissions": {
|
|
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"id": "TestIamPermissionsResponse",
|
|
"description": "Response message for `TestIamPermissions` method.",
|
|
"type": "object"
|
|
},
|
|
"ListVariablesResponse": {
|
|
"properties": {
|
|
"variables": {
|
|
"description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.",
|
|
"items": {
|
|
"$ref": "Variable"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"nextPageToken": {
|
|
"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"
|
|
}
|
|
},
|
|
"id": "ListVariablesResponse",
|
|
"description": "Response for the `ListVariables()` method.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"protocol": "rest",
|
|
"icons": {
|
|
"x32": "http://www.google.com/images/icons/product/search-32.gif",
|
|
"x16": "http://www.google.com/images/icons/product/search-16.gif"
|
|
},
|
|
"canonicalName": "Cloud RuntimeConfig",
|
|
"auth": {
|
|
"oauth2": {
|
|
"scopes": {
|
|
"https://www.googleapis.com/auth/cloud-platform": {
|
|
"description": "View and manage your data across Google Cloud Platform services"
|
|
},
|
|
"https://www.googleapis.com/auth/cloudruntimeconfig": {
|
|
"description": "Manage your Google Cloud Platform services' runtime configuration"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"rootUrl": "https://runtimeconfig.googleapis.com/",
|
|
"ownerDomain": "google.com",
|
|
"name": "runtimeconfig",
|
|
"batchPath": "batch",
|
|
"fullyEncodeReservedExpansion": true,
|
|
"title": "Google Cloud Runtime Configuration API"
|
|
}
|