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

blob: 54ebf26c1141cd1a1d00c53a4a46d3bec4512523 [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.tables.html">tables</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="#checkConsistency">checkConsistency(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	79	<p class="firstline">Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.</p>
				80	<p class="toc_element">
				81	<code><a href="#close">close()</a></code></p>
				82	<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	83	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	84	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	85	<p class="firstline">Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	86	<p class="toc_element">
				87	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Permanently deletes a specified table and all of its data.</p>
				89	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	90	<code><a href="#dropRowRange">dropRowRange(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<p class="firstline">Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#generateConsistencyToken">generateConsistencyToken(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<p class="firstline">Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	95	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	96	<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Gets metadata information about the specified table.</p>
				98	<p class="toc_element">
				99	<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<p class="firstline">Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	101	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	102	<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<p class="firstline">Lists all tables served from a specified instance.</p>
				104	<p class="toc_element">
				105	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				106	<p class="firstline">Retrieves the next page of results.</p>
				107	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	108	<code><a href="#modifyColumnFamilies">modifyColumnFamilies(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	109	<p class="firstline">Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	110	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	111	<code><a href="#restore">restore(parent, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	50e1b7a	2021-06-03 00:48:27 -0700	[diff] [blame]	112	<p class="firstline">Create a new table by restoring from a completed backup. The new table must be in the same project as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.</p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	113	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	114	<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	115	<p class="firstline">Sets the access control policy on a Table resource. Replaces any existing policy.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	116	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	117	<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	118	<p class="firstline">Returns permissions that the caller has on the specified table resource.</p>
				119	<h3>Method Details</h3>
				120	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	121	<code class="details" id="checkConsistency">checkConsistency(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	122	<pre>Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	123
				124	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	125	name: string, Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	126	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	127	The object takes the form of:
				128
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	129	{ # Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	130	"consistencyToken": "A String", # Required. The token created using GenerateConsistencyToken for the Table.
				131	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	132
				133	x__xgafv: string, V1 error format.
				134	Allowed values
				135	1 - v1 error format
				136	2 - v2 error format
				137
				138	Returns:
				139	An object of the form:
				140
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	141	{ # Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	142	"consistent": True or False, # True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request.
				143	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	144	</div>
				145
				146	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	147	<code class="details" id="close">close()</code>
				148	<pre>Close httplib2 connections.</pre>
				149	</div>
				150
				151	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	152	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	153	<pre>Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	154
				155	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	156	parent: string, Required. The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	157	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	158	The object takes the form of:
				159
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	160	{ # Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	161	"initialSplits": [ # The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, `s1` and `s2`, three tablets will be created, spanning the key ranges: `[, s1), [s1, s2), [s2, )`. Example: * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",` `"other", "zz"]` * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]` * Key assignment: - Tablet 1 `[, apple) => {"a"}.` - Tablet 2 `[apple, customer_1) => {"apple", "custom"}.` - Tablet 3 `[customer_1, customer_2) => {"customer_1"}.` - Tablet 4 `[customer_2, other) => {"customer_2"}.` - Tablet 5 `[other, ) => {"other", "zz"}.`
				162	{ # An initial split point for a newly created table.
				163	"key": "A String", # Row key to use as an initial tablet boundary.
				164	},
				165	],
				166	"table": { # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. # Required. The Table to create.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	167	"clusterStates": { # Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `ENCRYPTION_VIEW`, `FULL`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	168	"a_key": { # The state of a table's data in a particular cluster.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	169	"encryptionInfo": [ # Output only. The encryption information for the table in this cluster. If the encryption key protecting this resource is customer managed, then its version can be rotated in Cloud Key Management Service (Cloud KMS). The primary version of the key and its status will be reflected here when changes propagate from Cloud KMS.
				170	{ # Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.
				171	"encryptionStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
				172	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				173	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				174	{
				175	"a_key": "", # Properties of the object. Contains field @type with type URL.
				176	},
				177	],
				178	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				179	},
				180	"encryptionType": "A String", # Output only. The type of encryption used to protect this resource.
				181	"kmsKeyVersion": "A String", # Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
				182	},
				183	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	184	"replicationState": "A String", # Output only. The state of replication for the table in this cluster.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	185	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	186	},
				187	"columnFamilies": { # The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL`
				188	"a_key": { # A set of columns within a table which share a common configuration.
				189	"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
				190	"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
				191	"rules": [ # Only delete cells which would be deleted by every element of `rules`.
				192	# Object with schema name: GcRule
				193	],
				194	},
				195	"maxAge": "A String", # Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.
				196	"maxNumVersions": 42, # Delete all cells in a column except the most recent N.
				197	"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
				198	"rules": [ # Delete cells which would be deleted by any element of `rules`.
				199	# Object with schema name: GcRule
				200	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	201	},
				202	},
				203	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	204	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	205	"granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`.
				206	"name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
				207	"restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
				208	"backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
				209	"backup": "A String", # Output only. Name of the backup.
				210	"endTime": "A String", # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
				211	"sourceTable": "A String", # Output only. Name of the table the backup was created from.
				212	"startTime": "A String", # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	213	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	214	"sourceType": "A String", # The type of the restore source.
				215	},
				216	},
				217	"tableId": "A String", # Required. The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`. Maximum 50 characters.
				218	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	219
				220	x__xgafv: string, V1 error format.
				221	Allowed values
				222	1 - v1 error format
				223	2 - v2 error format
				224
				225	Returns:
				226	An object of the form:
				227
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	228	{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	229	"clusterStates": { # Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `ENCRYPTION_VIEW`, `FULL`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	230	"a_key": { # The state of a table's data in a particular cluster.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	231	"encryptionInfo": [ # Output only. The encryption information for the table in this cluster. If the encryption key protecting this resource is customer managed, then its version can be rotated in Cloud Key Management Service (Cloud KMS). The primary version of the key and its status will be reflected here when changes propagate from Cloud KMS.
				232	{ # Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.
				233	"encryptionStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
				234	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				235	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				236	{
				237	"a_key": "", # Properties of the object. Contains field @type with type URL.
				238	},
				239	],
				240	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				241	},
				242	"encryptionType": "A String", # Output only. The type of encryption used to protect this resource.
				243	"kmsKeyVersion": "A String", # Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
				244	},
				245	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	246	"replicationState": "A String", # Output only. The state of replication for the table in this cluster.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	247	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	248	},
				249	"columnFamilies": { # The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL`
				250	"a_key": { # A set of columns within a table which share a common configuration.
				251	"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
				252	"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
				253	"rules": [ # Only delete cells which would be deleted by every element of `rules`.
				254	# Object with schema name: GcRule
				255	],
				256	},
				257	"maxAge": "A String", # Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.
				258	"maxNumVersions": 42, # Delete all cells in a column except the most recent N.
				259	"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
				260	"rules": [ # Delete cells which would be deleted by any element of `rules`.
				261	# Object with schema name: GcRule
				262	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	263	},
				264	},
				265	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	266	},
				267	"granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`.
				268	"name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
				269	"restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
				270	"backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
				271	"backup": "A String", # Output only. Name of the backup.
				272	"endTime": "A String", # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
				273	"sourceTable": "A String", # Output only. Name of the table the backup was created from.
				274	"startTime": "A String", # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	275	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	276	"sourceType": "A String", # The type of the restore source.
				277	},
				278	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	279	</div>
				280
				281	<div class="method">
				282	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				283	<pre>Permanently deletes a specified table and all of its data.
				284
				285	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	286	name: string, Required. The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	287	x__xgafv: string, V1 error format.
				288	Allowed values
				289	1 - v1 error format
				290	2 - v2 error format
				291
				292	Returns:
				293	An object of the form:
				294
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	295	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	296	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	297	</div>
				298
				299	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	300	<code class="details" id="dropRowRange">dropRowRange(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	301	<pre>Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	302
				303	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	304	name: string, Required. The unique name of the table on which to drop a range of rows. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	305	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	306	The object takes the form of:
				307
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	308	{ # Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	309	"deleteAllDataFromTable": True or False, # Delete all rows in the table. Setting this to false is a no-op.
				310	"rowKeyPrefix": "A String", # Delete all rows that start with this row key prefix. Prefix cannot be zero length.
				311	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	312
				313	x__xgafv: string, V1 error format.
				314	Allowed values
				315	1 - v1 error format
				316	2 - v2 error format
				317
				318	Returns:
				319	An object of the form:
				320
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	321	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	322	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	323	</div>
				324
				325	<div class="method">
				326	<code class="details" id="generateConsistencyToken">generateConsistencyToken(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	327	<pre>Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	328
				329	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	330	name: string, Required. The unique name of the Table for which to create a consistency token. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	331	body: object, The request body.
				332	The object takes the form of:
				333
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	334	{ # Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	335	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	336
				337	x__xgafv: string, V1 error format.
				338	Allowed values
				339	1 - v1 error format
				340	2 - v2 error format
				341
				342	Returns:
				343	An object of the form:
				344
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	345	{ # Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	346	"consistencyToken": "A String", # The generated consistency token.
				347	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	348	</div>
				349
				350	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	351	<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	352	<pre>Gets metadata information about the specified table.
				353
				354	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	355	name: string, Required. The unique name of the requested table. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`. (required)
				356	view: string, The view to be applied to the returned table's fields. Defaults to `SCHEMA_VIEW` if unspecified.
				357	Allowed values
				358	VIEW_UNSPECIFIED - Uses the default view for each method as documented in its request.
				359	NAME_ONLY - Only populates `name`.
				360	SCHEMA_VIEW - Only populates `name` and fields related to the table's schema.
				361	REPLICATION_VIEW - Only populates `name` and fields related to the table's replication state.
yoshi-code-bot	9e2cde2	2021-04-29 03:48:05 -0700	[diff] [blame]	362	ENCRYPTION_VIEW - Only populates `name` and fields related to the table's encryption state.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	363	FULL - Populates all fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	364	x__xgafv: string, V1 error format.
				365	Allowed values
				366	1 - v1 error format
				367	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	368
				369	Returns:
				370	An object of the form:
				371
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	372	{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	373	"clusterStates": { # Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `ENCRYPTION_VIEW`, `FULL`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	374	"a_key": { # The state of a table's data in a particular cluster.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	375	"encryptionInfo": [ # Output only. The encryption information for the table in this cluster. If the encryption key protecting this resource is customer managed, then its version can be rotated in Cloud Key Management Service (Cloud KMS). The primary version of the key and its status will be reflected here when changes propagate from Cloud KMS.
				376	{ # Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.
				377	"encryptionStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
				378	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				379	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				380	{
				381	"a_key": "", # Properties of the object. Contains field @type with type URL.
				382	},
				383	],
				384	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				385	},
				386	"encryptionType": "A String", # Output only. The type of encryption used to protect this resource.
				387	"kmsKeyVersion": "A String", # Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
				388	},
				389	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	390	"replicationState": "A String", # Output only. The state of replication for the table in this cluster.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	391	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	392	},
				393	"columnFamilies": { # The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL`
				394	"a_key": { # A set of columns within a table which share a common configuration.
				395	"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
				396	"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
				397	"rules": [ # Only delete cells which would be deleted by every element of `rules`.
				398	# Object with schema name: GcRule
				399	],
				400	},
				401	"maxAge": "A String", # Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.
				402	"maxNumVersions": 42, # Delete all cells in a column except the most recent N.
				403	"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
				404	"rules": [ # Delete cells which would be deleted by any element of `rules`.
				405	# Object with schema name: GcRule
				406	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	407	},
				408	},
				409	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	410	},
				411	"granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`.
				412	"name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
				413	"restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
				414	"backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
				415	"backup": "A String", # Output only. Name of the backup.
				416	"endTime": "A String", # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
				417	"sourceTable": "A String", # Output only. Name of the table the backup was created from.
				418	"startTime": "A String", # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	419	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	420	"sourceType": "A String", # The type of the restore source.
				421	},
				422	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	423	</div>
				424
				425	<div class="method">
				426	<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	427	<pre>Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	428
				429	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	430	resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	431	body: object, The request body.
				432	The object takes the form of:
				433
				434	{ # Request message for `GetIamPolicy` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	435	"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
				436	"requestedPolicyVersion": 42, # Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				437	},
				438	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	439
				440	x__xgafv: string, V1 error format.
				441	Allowed values
				442	1 - v1 error format
				443	2 - v2 error format
				444
				445	Returns:
				446	An object of the form:
				447
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	448	{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	449	"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
				450	{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
				451	"auditLogConfigs": [ # The configuration for logging of each type of permission.
				452	{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
				453	"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
				454	"A String",
				455	],
				456	"logType": "A String", # The log type that this config enables.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	457	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	458	],
				459	"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
				460	},
				461	],
				462	"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
				463	{ # Associates `members` with a `role`.
				464	"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				465	"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
				466	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				467	"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
				468	"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	469	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	470	"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
				471	"A String",
				472	],
				473	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				474	},
				475	],
				476	"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
				477	"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				478	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	479	</div>
				480
				481	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	482	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	483	<pre>Lists all tables served from a specified instance.
				484
				485	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	486	parent: string, Required. The unique name of the instance for which tables should be listed. Values are of the form `projects/{project}/instances/{instance}`. (required)
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	487	pageSize: integer, Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
				488	pageToken: string, The value of `next_page_token` returned by a previous call.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	489	view: string, The view to be applied to the returned tables' fields. Only NAME_ONLY view (default) and REPLICATION_VIEW are supported.
				490	Allowed values
				491	VIEW_UNSPECIFIED - Uses the default view for each method as documented in its request.
				492	NAME_ONLY - Only populates `name`.
				493	SCHEMA_VIEW - Only populates `name` and fields related to the table's schema.
				494	REPLICATION_VIEW - Only populates `name` and fields related to the table's replication state.
yoshi-code-bot	9e2cde2	2021-04-29 03:48:05 -0700	[diff] [blame]	495	ENCRYPTION_VIEW - Only populates `name` and fields related to the table's encryption state.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	496	FULL - Populates all fields.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	497	x__xgafv: string, V1 error format.
				498	Allowed values
				499	1 - v1 error format
				500	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	501
				502	Returns:
				503	An object of the form:
				504
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	505	{ # Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	506	"nextPageToken": "A String", # Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.
				507	"tables": [ # The tables present in the requested instance.
				508	{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	509	"clusterStates": { # Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `ENCRYPTION_VIEW`, `FULL`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	510	"a_key": { # The state of a table's data in a particular cluster.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	511	"encryptionInfo": [ # Output only. The encryption information for the table in this cluster. If the encryption key protecting this resource is customer managed, then its version can be rotated in Cloud Key Management Service (Cloud KMS). The primary version of the key and its status will be reflected here when changes propagate from Cloud KMS.
				512	{ # Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.
				513	"encryptionStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
				514	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				515	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				516	{
				517	"a_key": "", # Properties of the object. Contains field @type with type URL.
				518	},
				519	],
				520	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				521	},
				522	"encryptionType": "A String", # Output only. The type of encryption used to protect this resource.
				523	"kmsKeyVersion": "A String", # Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
				524	},
				525	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	526	"replicationState": "A String", # Output only. The state of replication for the table in this cluster.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	527	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	528	},
				529	"columnFamilies": { # The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL`
				530	"a_key": { # A set of columns within a table which share a common configuration.
				531	"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
				532	"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
				533	"rules": [ # Only delete cells which would be deleted by every element of `rules`.
				534	# Object with schema name: GcRule
				535	],
				536	},
				537	"maxAge": "A String", # Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.
				538	"maxNumVersions": 42, # Delete all cells in a column except the most recent N.
				539	"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
				540	"rules": [ # Delete cells which would be deleted by any element of `rules`.
				541	# Object with schema name: GcRule
				542	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	543	},
				544	},
				545	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	546	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	547	"granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`.
				548	"name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
				549	"restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
				550	"backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
				551	"backup": "A String", # Output only. Name of the backup.
				552	"endTime": "A String", # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
				553	"sourceTable": "A String", # Output only. Name of the table the backup was created from.
				554	"startTime": "A String", # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
				555	},
				556	"sourceType": "A String", # The type of the restore source.
				557	},
				558	},
				559	],
				560	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	561	</div>
				562
				563	<div class="method">
				564	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				565	<pre>Retrieves the next page of results.
				566
				567	Args:
				568	previous_request: The request for the previous page. (required)
				569	previous_response: The response from the request for the previous page. (required)
				570
				571	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	572	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]	573	page. Returns None if there are no more items in the collection.
				574	</pre>
				575	</div>
				576
				577	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	578	<code class="details" id="modifyColumnFamilies">modifyColumnFamilies(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	579	<pre>Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	580
				581	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	582	name: string, Required. The unique name of the table whose families should be modified. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	583	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	584	The object takes the form of:
				585
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	586	{ # Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	587	"modifications": [ # Required. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).
				588	{ # A create, update, or delete of a particular column family.
				589	"create": { # A set of columns within a table which share a common configuration. # Create a new column family with the specified schema, or fail if one already exists with the given ID.
				590	"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
				591	"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
				592	"rules": [ # Only delete cells which would be deleted by every element of `rules`.
				593	# Object with schema name: GcRule
				594	],
				595	},
				596	"maxAge": "A String", # Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.
				597	"maxNumVersions": 42, # Delete all cells in a column except the most recent N.
				598	"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
				599	"rules": [ # Delete cells which would be deleted by any element of `rules`.
				600	# Object with schema name: GcRule
				601	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	602	},
				603	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	604	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	605	"drop": True or False, # Drop (delete) the column family with the given ID, or fail if no such family exists.
				606	"id": "A String", # The ID of the column family to be modified.
				607	"update": { # A set of columns within a table which share a common configuration. # Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
				608	"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
				609	"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
				610	"rules": [ # Only delete cells which would be deleted by every element of `rules`.
				611	# Object with schema name: GcRule
				612	],
				613	},
				614	"maxAge": "A String", # Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.
				615	"maxNumVersions": 42, # Delete all cells in a column except the most recent N.
				616	"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
				617	"rules": [ # Delete cells which would be deleted by any element of `rules`.
				618	# Object with schema name: GcRule
				619	],
				620	},
				621	},
				622	},
				623	},
				624	],
				625	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	626
				627	x__xgafv: string, V1 error format.
				628	Allowed values
				629	1 - v1 error format
				630	2 - v2 error format
				631
				632	Returns:
				633	An object of the form:
				634
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	635	{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	636	"clusterStates": { # Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `ENCRYPTION_VIEW`, `FULL`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	637	"a_key": { # The state of a table's data in a particular cluster.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	638	"encryptionInfo": [ # Output only. The encryption information for the table in this cluster. If the encryption key protecting this resource is customer managed, then its version can be rotated in Cloud Key Management Service (Cloud KMS). The primary version of the key and its status will be reflected here when changes propagate from Cloud KMS.
				639	{ # Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.
				640	"encryptionStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
				641	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				642	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				643	{
				644	"a_key": "", # Properties of the object. Contains field @type with type URL.
				645	},
				646	],
				647	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				648	},
				649	"encryptionType": "A String", # Output only. The type of encryption used to protect this resource.
				650	"kmsKeyVersion": "A String", # Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
				651	},
				652	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	653	"replicationState": "A String", # Output only. The state of replication for the table in this cluster.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	654	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	655	},
				656	"columnFamilies": { # The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `FULL`
				657	"a_key": { # A set of columns within a table which share a common configuration.
				658	"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
				659	"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
				660	"rules": [ # Only delete cells which would be deleted by every element of `rules`.
				661	# Object with schema name: GcRule
				662	],
				663	},
				664	"maxAge": "A String", # Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.
				665	"maxNumVersions": 42, # Delete all cells in a column except the most recent N.
				666	"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
				667	"rules": [ # Delete cells which would be deleted by any element of `rules`.
				668	# Object with schema name: GcRule
				669	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	670	},
				671	},
				672	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	673	},
				674	"granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`.
				675	"name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
				676	"restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
				677	"backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist.
				678	"backup": "A String", # Output only. Name of the backup.
				679	"endTime": "A String", # Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
				680	"sourceTable": "A String", # Output only. Name of the table the backup was created from.
				681	"startTime": "A String", # Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	682	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	683	"sourceType": "A String", # The type of the restore source.
				684	},
				685	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	686	</div>
				687
				688	<div class="method">
				689	<code class="details" id="restore">restore(parent, body=None, x__xgafv=None)</code>
yoshi-code-bot	50e1b7a	2021-06-03 00:48:27 -0700	[diff] [blame]	690	<pre>Create a new table by restoring from a completed backup. The new table must be in the same project as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	691
				692	Args:
yoshi-code-bot	50e1b7a	2021-06-03 00:48:27 -0700	[diff] [blame]	693	parent: string, Required. The name of the instance in which to create the restored table. This instance must be in the same project as the source backup. Values are of the form `projects//instances/`. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	694	body: object, The request body.
				695	The object takes the form of:
				696
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	697	{ # The request for RestoreTable.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	698	"backup": "A String", # Name of the backup from which to restore. Values are of the form `projects//instances//clusters//backups/`.
				699	"tableId": "A String", # Required. The id of the table to create and restore to. This table must not already exist. The `table_id` appended to `parent` forms the full table name of the form `projects//instances//tables/`.
				700	}
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	701
				702	x__xgafv: string, V1 error format.
				703	Allowed values
				704	1 - v1 error format
				705	2 - v2 error format
				706
				707	Returns:
				708	An object of the form:
				709
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	710	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	711	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				712	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				713	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				714	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				715	{
				716	"a_key": "", # Properties of the object. Contains field @type with type URL.
				717	},
				718	],
				719	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
				720	},
				721	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				722	"a_key": "", # Properties of the object. Contains field @type with type URL.
				723	},
				724	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				725	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				726	"a_key": "", # Properties of the object. Contains field @type with type URL.
				727	},
				728	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	729	</div>
				730
				731	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	732	<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	733	<pre>Sets the access control policy on a Table resource. Replaces any existing policy.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	734
				735	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	736	resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	737	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	738	The object takes the form of:
				739
				740	{ # Request message for `SetIamPolicy` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	741	"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
				742	"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
				743	{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
				744	"auditLogConfigs": [ # The configuration for logging of each type of permission.
				745	{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
				746	"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
				747	"A String",
				748	],
				749	"logType": "A String", # The log type that this config enables.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	750	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	751	],
				752	"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
				753	},
				754	],
				755	"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
				756	{ # Associates `members` with a `role`.
				757	"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				758	"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
				759	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				760	"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
				761	"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	762	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	763	"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
				764	"A String",
				765	],
				766	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				767	},
				768	],
				769	"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
				770	"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				771	},
				772	"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
				773	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	774
				775	x__xgafv: string, V1 error format.
				776	Allowed values
				777	1 - v1 error format
				778	2 - v2 error format
				779
				780	Returns:
				781	An object of the form:
				782
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	783	{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	784	"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
				785	{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
				786	"auditLogConfigs": [ # The configuration for logging of each type of permission.
				787	{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
				788	"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
				789	"A String",
				790	],
				791	"logType": "A String", # The log type that this config enables.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	792	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	793	],
				794	"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
				795	},
				796	],
				797	"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
				798	{ # Associates `members` with a `role`.
				799	"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				800	"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
				801	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				802	"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
				803	"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	804	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	805	"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
				806	"A String",
				807	],
				808	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
				809	},
				810	],
				811	"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
				812	"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
				813	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	814	</div>
				815
				816	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	817	<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	818	<pre>Returns permissions that the caller has on the specified table resource.
				819
				820	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	821	resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	822	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	823	The object takes the form of:
				824
				825	{ # Request message for `TestIamPermissions` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	826	"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
				827	"A String",
				828	],
				829	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	830
				831	x__xgafv: string, V1 error format.
				832	Allowed values
				833	1 - v1 error format
				834	2 - v2 error format
				835
				836	Returns:
				837	An object of the form:
				838
				839	{ # Response message for `TestIamPermissions` method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	840	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				841	"A String",
				842	],
				843	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	844	</div>
				845
				846	</body></html>