update API descriptions

This commit is contained in:
Sebastian Thiel
2020-07-10 09:11:32 +08:00
parent b6ee34dcff
commit 69fb05c4e1
271 changed files with 82506 additions and 23249 deletions

View File

@@ -96,7 +96,7 @@
},
"protocol": "rest",
"resources": {},
"revision": "20200211",
"revision": "20200609",
"rootUrl": "https://bigtableadmin.googleapis.com/",
"schemas": {
"Cluster": {
@@ -104,7 +104,7 @@
"id": "Cluster",
"properties": {
"defaultStorageType": {
"description": "(`CreationOnly`)\nThe type of storage used by this cluster to serve its\nparent instance's tables, unless explicitly overridden.",
"description": "Immutable. The type of storage used by this cluster to serve its\nparent instance's tables, unless explicitly overridden.",
"enum": [
"STORAGE_TYPE_UNSPECIFIED",
"SSD",
@@ -118,11 +118,11 @@
"type": "string"
},
"location": {
"description": "(`CreationOnly`)\nThe location where this cluster's nodes and storage reside. For best\nperformance, clients should be located as close as possible to this\ncluster. Currently only zones are supported, so values should be of the\nform `projects/{project}/locations/{zone}`.",
"description": "Immutable. The location where this cluster's nodes and storage reside. For best\nperformance, clients should be located as close as possible to this\ncluster. Currently only zones are supported, so values should be of the\nform `projects/{project}/locations/{zone}`.",
"type": "string"
},
"name": {
"description": "Required. (`OutputOnly`)\nThe unique name of the cluster. Values are of the form\n`projects/{project}/instances/{instance}/clusters/a-z*`.",
"description": "The unique name of the cluster. Values are of the form\n`projects/{project}/instances/{instance}/clusters/a-z*`.",
"type": "string"
},
"serveNodes": {
@@ -131,7 +131,7 @@
"type": "integer"
},
"state": {
"description": "(`OutputOnly`)\nThe current state of the cluster.",
"description": "Output only. The current state of the cluster.",
"enum": [
"STATE_NOT_KNOWN",
"READY",
@@ -261,11 +261,11 @@
"type": "object"
},
"name": {
"description": "Required. (`OutputOnly`)\nThe unique name of the instance. Values are of the form\n`projects/{project}/instances/a-z+[a-z0-9]`.",
"description": "The unique name of the instance. Values are of the form\n`projects/{project}/instances/a-z+[a-z0-9]`.",
"type": "string"
},
"state": {
"description": "(`OutputOnly`)\nThe current state of the instance.",
"description": "Output only. The current state of the instance.",
"enum": [
"STATE_NOT_KNOWN",
"READY",
@@ -288,7 +288,7 @@
"enumDescriptions": [
"The type of the instance is unspecified. If set when creating an\ninstance, a `PRODUCTION` instance will be created. If set when updating\nan instance, the type will be left unchanged.",
"An instance meant for production use. `serve_nodes` must be set\non the cluster.",
"The instance is meant for development and testing purposes only; it has\nno performance or uptime guarantees and is not covered by SLA.\nAfter a development instance is created, it can be upgraded by\nupdating the instance to type `PRODUCTION`. An instance created\nas a production instance cannot be changed to a development instance.\nWhen creating a development instance, `serve_nodes` on the cluster must\nnot be set."
"DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces\na higher minimum node count than DEVELOPMENT."
],
"type": "string"
}