Blame - docs/dyn/bigtableadmin_v2.projects.instances.clusters.html - platform/external/python/google-api-python-client

blob: 5cf5a36f59ae89e74cab7fb5c19aa63a6ab7c40b [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="bigtableadmin_v2.html">Cloud Bigtable Admin API</a> . <a href="bigtableadmin_v2.projects.html">projects</a> . <a href="bigtableadmin_v2.projects.instances.html">instances</a> . <a href="bigtableadmin_v2.projects.instances.clusters.html">clusters</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="bigtableadmin_v2.projects.instances.clusters.backups.html">backups()</a></code>
				79	</p>
				80	<p class="firstline">Returns the backups Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="#create">create(parent, body=None, clusterId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	84	<p class="firstline">Creates a cluster within an instance.</p>
				85	<p class="toc_element">
				86	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				87	<p class="firstline">Deletes a cluster from an instance.</p>
				88	<p class="toc_element">
				89	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				90	<p class="firstline">Gets information about a cluster.</p>
				91	<p class="toc_element">
				92	<code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p>
				93	<p class="firstline">Lists information about clusters in an instance.</p>
				94	<p class="toc_element">
				95	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				96	<p class="firstline">Retrieves the next page of results.</p>
				97	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	98	<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	99	<p class="firstline">Updates a cluster within an instance.</p>
				100	<h3>Method Details</h3>
				101	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	102	<code class="details" id="create">create(parent, body=None, clusterId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<pre>Creates a cluster within an instance.
				104
				105	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	106	parent: string, Required. The unique name of the instance in which to create the new cluster.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	107	Values are of the form
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	108	`projects/{project}/instances/{instance}`. (required)
				109	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	110	The object takes the form of:
				111
				112	{ # A resizable group of nodes in a particular cloud location, capable
				113	# of serving all Tables in the parent
				114	# Instance.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	115	"location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	116	# performance, clients should be located as close as possible to this
				117	# cluster. Currently only zones are supported, so values should be of the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	118	# form `projects/{project}/locations/{zone}`.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	119	"name": "A String", # The unique name of the cluster. Values are of the form
				120	# `projects/{project}/instances/{instance}/clusters/a-z*`.
				121	"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its
				122	# parent instance's tables, unless explicitly overridden.
				123	"serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
				124	# throughput and more consistent performance.
				125	"state": "A String", # Output only. The current state of the cluster.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	126	}
				127
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	128	clusterId: string, Required. The ID to be used when referring to the new cluster within its instance,
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	129	e.g., just `mycluster` rather than
				130	`projects/myproject/instances/myinstance/clusters/mycluster`.
				131	x__xgafv: string, V1 error format.
				132	Allowed values
				133	1 - v1 error format
				134	2 - v2 error format
				135
				136	Returns:
				137	An object of the form:
				138
				139	{ # This resource represents a long-running operation that is the result of a
				140	# network API call.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	141	"metadata": { # Service-specific metadata associated with the operation. It typically
				142	# contains progress information and common metadata such as create time.
				143	# Some services might not provide such metadata. Any method that returns a
				144	# long-running operation should document the metadata type, if any.
				145	"a_key": "", # Properties of the object. Contains field @type with type URL.
				146	},
				147	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
				148	# different programming environments, including REST APIs and RPC APIs. It is
				149	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				150	# three pieces of data: error code, error message, and error details.
				151	#
				152	# You can find out more about this error model and how to work with it in the
				153	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				154	"details": [ # A list of messages that carry the error details. There is a common set of
				155	# message types for APIs to use.
				156	{
				157	"a_key": "", # Properties of the object. Contains field @type with type URL.
				158	},
				159	],
				160	"message": "A String", # A developer-facing error message, which should be in English. Any
				161	# user-facing error message should be localized and sent in the
				162	# google.rpc.Status.details field, or localized by the client.
				163	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				164	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	165	"response": { # The normal response of the operation in case of success. If the original
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	166	# method returns no data on success, such as `Delete`, the response is
				167	# `google.protobuf.Empty`. If the original method is standard
				168	# `Get`/`Create`/`Update`, the response should be the resource. For other
				169	# methods, the response should have the type `XxxResponse`, where `Xxx`
				170	# is the original method name. For example, if the original method name
				171	# is `TakeSnapshot()`, the inferred response type is
				172	# `TakeSnapshotResponse`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	173	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	174	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	175	"name": "A String", # The server-assigned name, which is only unique within the same service that
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	176	# originally returns it. If you use the default HTTP mapping, the
				177	# `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	178	"done": True or False, # If the value is `false`, it means the operation is still in progress.
				179	# If `true`, the operation is completed, and either `error` or `response` is
				180	# available.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	181	}</pre>
				182	</div>
				183
				184	<div class="method">
				185	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				186	<pre>Deletes a cluster from an instance.
				187
				188	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	189	name: string, Required. The unique name of the cluster to be deleted. Values are of the form
				190	`projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	191	x__xgafv: string, V1 error format.
				192	Allowed values
				193	1 - v1 error format
				194	2 - v2 error format
				195
				196	Returns:
				197	An object of the form:
				198
				199	{ # A generic empty message that you can re-use to avoid defining duplicated
				200	# empty messages in your APIs. A typical example is to use it as the request
				201	# or the response type of an API method. For instance:
				202	#
				203	# service Foo {
				204	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				205	# }
				206	#
				207	# The JSON representation for `Empty` is empty JSON object `{}`.
				208	}</pre>
				209	</div>
				210
				211	<div class="method">
				212	<code class="details" id="get">get(name, x__xgafv=None)</code>
				213	<pre>Gets information about a cluster.
				214
				215	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	216	name: string, Required. The unique name of the requested cluster. Values are of the form
				217	`projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	218	x__xgafv: string, V1 error format.
				219	Allowed values
				220	1 - v1 error format
				221	2 - v2 error format
				222
				223	Returns:
				224	An object of the form:
				225
				226	{ # A resizable group of nodes in a particular cloud location, capable
				227	# of serving all Tables in the parent
				228	# Instance.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	229	"location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	230	# performance, clients should be located as close as possible to this
				231	# cluster. Currently only zones are supported, so values should be of the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	232	# form `projects/{project}/locations/{zone}`.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	233	"name": "A String", # The unique name of the cluster. Values are of the form
				234	# `projects/{project}/instances/{instance}/clusters/a-z*`.
				235	"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its
				236	# parent instance's tables, unless explicitly overridden.
				237	"serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
				238	# throughput and more consistent performance.
				239	"state": "A String", # Output only. The current state of the cluster.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	240	}</pre>
				241	</div>
				242
				243	<div class="method">
				244	<code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code>
				245	<pre>Lists information about clusters in an instance.
				246
				247	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	248	parent: string, Required. The unique name of the instance for which a list of clusters is requested.
				249	Values are of the form `projects/{project}/instances/{instance}`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	250	Use `{instance} = '-'` to list Clusters for all Instances in a project,
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	251	e.g., `projects/myproject/instances/-`. (required)
				252	pageToken: string, DEPRECATED: This field is unused and ignored.
				253	x__xgafv: string, V1 error format.
				254	Allowed values
				255	1 - v1 error format
				256	2 - v2 error format
				257
				258	Returns:
				259	An object of the form:
				260
				261	{ # Response message for BigtableInstanceAdmin.ListClusters.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	262	"failedLocations": [ # Locations from which Cluster information could not be retrieved,
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	263	# due to an outage or some other transient condition.
				264	# Clusters from these locations may be missing from `clusters`,
				265	# or may only have partial information returned.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	266	# Values are of the form `projects/<project>/locations/<zone_id>`
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	267	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	268	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	269	"nextPageToken": "A String", # DEPRECATED: This field is unused and ignored.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	270	"clusters": [ # The list of requested clusters.
				271	{ # A resizable group of nodes in a particular cloud location, capable
				272	# of serving all Tables in the parent
				273	# Instance.
				274	"location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best
				275	# performance, clients should be located as close as possible to this
				276	# cluster. Currently only zones are supported, so values should be of the
				277	# form `projects/{project}/locations/{zone}`.
				278	"name": "A String", # The unique name of the cluster. Values are of the form
				279	# `projects/{project}/instances/{instance}/clusters/a-z*`.
				280	"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its
				281	# parent instance's tables, unless explicitly overridden.
				282	"serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
				283	# throughput and more consistent performance.
				284	"state": "A String", # Output only. The current state of the cluster.
				285	},
				286	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	287	}</pre>
				288	</div>
				289
				290	<div class="method">
				291	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				292	<pre>Retrieves the next page of results.
				293
				294	Args:
				295	previous_request: The request for the previous page. (required)
				296	previous_response: The response from the request for the previous page. (required)
				297
				298	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	299	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	300	page. Returns None if there are no more items in the collection.
				301	</pre>
				302	</div>
				303
				304	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	305	<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	306	<pre>Updates a cluster within an instance.
				307
				308	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	309	name: string, The unique name of the cluster. Values are of the form
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	310	`projects/{project}/instances/{instance}/clusters/a-z*`. (required)
				311	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	312	The object takes the form of:
				313
				314	{ # A resizable group of nodes in a particular cloud location, capable
				315	# of serving all Tables in the parent
				316	# Instance.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	317	"location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	318	# performance, clients should be located as close as possible to this
				319	# cluster. Currently only zones are supported, so values should be of the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	320	# form `projects/{project}/locations/{zone}`.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	321	"name": "A String", # The unique name of the cluster. Values are of the form
				322	# `projects/{project}/instances/{instance}/clusters/a-z*`.
				323	"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its
				324	# parent instance's tables, unless explicitly overridden.
				325	"serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
				326	# throughput and more consistent performance.
				327	"state": "A String", # Output only. The current state of the cluster.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	328	}
				329
				330	x__xgafv: string, V1 error format.
				331	Allowed values
				332	1 - v1 error format
				333	2 - v2 error format
				334
				335	Returns:
				336	An object of the form:
				337
				338	{ # This resource represents a long-running operation that is the result of a
				339	# network API call.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame^]	340	"metadata": { # Service-specific metadata associated with the operation. It typically
				341	# contains progress information and common metadata such as create time.
				342	# Some services might not provide such metadata. Any method that returns a
				343	# long-running operation should document the metadata type, if any.
				344	"a_key": "", # Properties of the object. Contains field @type with type URL.
				345	},
				346	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
				347	# different programming environments, including REST APIs and RPC APIs. It is
				348	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				349	# three pieces of data: error code, error message, and error details.
				350	#
				351	# You can find out more about this error model and how to work with it in the
				352	# [API Design Guide](https://cloud.google.com/apis/design/errors).
				353	"details": [ # A list of messages that carry the error details. There is a common set of
				354	# message types for APIs to use.
				355	{
				356	"a_key": "", # Properties of the object. Contains field @type with type URL.
				357	},
				358	],
				359	"message": "A String", # A developer-facing error message, which should be in English. Any
				360	# user-facing error message should be localized and sent in the
				361	# google.rpc.Status.details field, or localized by the client.
				362	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				363	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	364	"response": { # The normal response of the operation in case of success. If the original
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	365	# method returns no data on success, such as `Delete`, the response is
				366	# `google.protobuf.Empty`. If the original method is standard
				367	# `Get`/`Create`/`Update`, the response should be the resource. For other
				368	# methods, the response should have the type `XxxResponse`, where `Xxx`
				369	# is the original method name. For example, if the original method name
				370	# is `TakeSnapshot()`, the inferred response type is
				371	# `TakeSnapshotResponse`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	372	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	373	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	374	"name": "A String", # The server-assigned name, which is only unique within the same service that
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	375	# originally returns it. If you use the default HTTP mapping, the
				376	# `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	377	"done": True or False, # If the value is `false`, it means the operation is still in progress.
				378	# If `true`, the operation is completed, and either `error` or `response` is
				379	# available.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	380	}</pre>
				381	</div>
				382
				383	</body></html>