Blame - docs/dyn/area120tables_v1alpha1.tables.rows.html - platform/external/python/google-api-python-client

blob: eb8def4c3bcb1190f70fd5091f7844ebe3e19426 [file] [log] [blame]

Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -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="area120tables_v1alpha1.html">Area120 Tables API</a> . <a href="area120tables_v1alpha1.tables.html">tables</a> . <a href="area120tables_v1alpha1.tables.rows.html">rows</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Creates multiple rows.</p>
				80	<p class="toc_element">
				81	<code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Updates multiple rows.</p>
				83	<p class="toc_element">
				84	<code><a href="#close">close()</a></code></p>
				85	<p class="firstline">Close httplib2 connections.</p>
				86	<p class="toc_element">
				87	<code><a href="#create">create(parent, body=None, view=None, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Creates a row.</p>
				89	<p class="toc_element">
				90	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				91	<p class="firstline">Deletes a row.</p>
				92	<p class="toc_element">
				93	<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
				94	<p class="firstline">Gets a row. Returns NOT_FOUND if the row does not exist in the table.</p>
				95	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	96	<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	97	<p class="firstline">Lists rows in a table. Returns NOT_FOUND if the table does not exist.</p>
				98	<p class="toc_element">
				99	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				100	<p class="firstline">Retrieves the next page of results.</p>
				101	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	102	<code><a href="#patch">patch(name, body=None, updateMask=None, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	103	<p class="firstline">Updates a row.</p>
				104	<h3>Method Details</h3>
				105	<div class="method">
				106	<code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>
				107	<pre>Creates multiple rows.
				108
				109	Args:
				110	parent: string, Required. The parent table where the rows will be created. Format: tables/{table} (required)
				111	body: object, The request body.
				112	The object takes the form of:
				113
				114	{ # Request message for TablesService.BatchCreateRows.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	115	"requests": [ # Required. The request message specifying the rows to create. A maximum of 500 rows can be created in a single batch.
				116	{ # Request message for TablesService.CreateRow.
				117	"parent": "A String", # Required. The parent table where this row will be created. Format: tables/{table}
				118	"row": { # A single row in a table. # Required. The row to create.
				119	"name": "A String", # The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.
				120	"values": { # The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.
				121	"a_key": "",
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	122	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	123	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	124	"view": "A String", # Optional. Column key to use for values in the row. Defaults to user entered name.
				125	},
				126	],
				127	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	128
				129	x__xgafv: string, V1 error format.
				130	Allowed values
				131	1 - v1 error format
				132	2 - v2 error format
				133
				134	Returns:
				135	An object of the form:
				136
				137	{ # Response message for TablesService.BatchCreateRows.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	138	"rows": [ # The created rows.
				139	{ # A single row in a table.
				140	"name": "A String", # The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.
				141	"values": { # The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.
				142	"a_key": "",
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	143	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	144	},
				145	],
				146	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	147	</div>
				148
				149	<div class="method">
				150	<code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
				151	<pre>Updates multiple rows.
				152
				153	Args:
				154	parent: string, Required. The parent table shared by all rows being updated. Format: tables/{table} (required)
				155	body: object, The request body.
				156	The object takes the form of:
				157
				158	{ # Request message for TablesService.BatchUpdateRows.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	159	"requests": [ # Required. The request messages specifying the rows to update. A maximum of 500 rows can be modified in a single batch.
				160	{ # Request message for TablesService.UpdateRow.
				161	"row": { # A single row in a table. # Required. The row to update.
				162	"name": "A String", # The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.
				163	"values": { # The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.
				164	"a_key": "",
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	165	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	166	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	167	"updateMask": "A String", # The list of fields to update.
				168	"view": "A String", # Optional. Column key to use for values in the row. Defaults to user entered name.
				169	},
				170	],
				171	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	172
				173	x__xgafv: string, V1 error format.
				174	Allowed values
				175	1 - v1 error format
				176	2 - v2 error format
				177
				178	Returns:
				179	An object of the form:
				180
				181	{ # Response message for TablesService.BatchUpdateRows.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	182	"rows": [ # The updated rows.
				183	{ # A single row in a table.
				184	"name": "A String", # The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.
				185	"values": { # The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.
				186	"a_key": "",
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	187	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	188	},
				189	],
				190	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	191	</div>
				192
				193	<div class="method">
				194	<code class="details" id="close">close()</code>
				195	<pre>Close httplib2 connections.</pre>
				196	</div>
				197
				198	<div class="method">
				199	<code class="details" id="create">create(parent, body=None, view=None, x__xgafv=None)</code>
				200	<pre>Creates a row.
				201
				202	Args:
				203	parent: string, Required. The parent table where this row will be created. Format: tables/{table} (required)
				204	body: object, The request body.
				205	The object takes the form of:
				206
				207	{ # A single row in a table.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	208	"name": "A String", # The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.
				209	"values": { # The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.
				210	"a_key": "",
				211	},
				212	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	213
				214	view: string, Optional. Column key to use for values in the row. Defaults to user entered name.
				215	Allowed values
				216	VIEW_UNSPECIFIED - Defaults to user entered text.
				217	COLUMN_ID_VIEW - Uses internally generated column id to identify values.
				218	x__xgafv: string, V1 error format.
				219	Allowed values
				220	1 - v1 error format
				221	2 - v2 error format
				222
				223	Returns:
				224	An object of the form:
				225
				226	{ # A single row in a table.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	227	"name": "A String", # The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.
				228	"values": { # The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.
				229	"a_key": "",
				230	},
				231	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	232	</div>
				233
				234	<div class="method">
				235	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				236	<pre>Deletes a row.
				237
				238	Args:
				239	name: string, Required. The name of the row to delete. Format: tables/{table}/rows/{row} (required)
				240	x__xgafv: string, V1 error format.
				241	Allowed values
				242	1 - v1 error format
				243	2 - v2 error format
				244
				245	Returns:
				246	An object of the form:
				247
				248	{ # 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^]	249	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	250	</div>
				251
				252	<div class="method">
				253	<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
				254	<pre>Gets a row. Returns NOT_FOUND if the row does not exist in the table.
				255
				256	Args:
				257	name: string, Required. The name of the row to retrieve. Format: tables/{table}/rows/{row} (required)
				258	view: string, Optional. Column key to use for values in the row. Defaults to user entered name.
				259	Allowed values
				260	VIEW_UNSPECIFIED - Defaults to user entered text.
				261	COLUMN_ID_VIEW - Uses internally generated column id to identify values.
				262	x__xgafv: string, V1 error format.
				263	Allowed values
				264	1 - v1 error format
				265	2 - v2 error format
				266
				267	Returns:
				268	An object of the form:
				269
				270	{ # A single row in a table.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	271	"name": "A String", # The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.
				272	"values": { # The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.
				273	"a_key": "",
				274	},
				275	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	276	</div>
				277
				278	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	279	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	280	<pre>Lists rows in a table. Returns NOT_FOUND if the table does not exist.
				281
				282	Args:
				283	parent: string, Required. The parent table. Format: tables/{table} (required)
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	284	pageSize: integer, The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.
				285	pageToken: string, A page token, received from a previous `ListRows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRows` must match the call that provided the page token.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	286	view: string, Optional. Column key to use for values in the row. Defaults to user entered name.
				287	Allowed values
				288	VIEW_UNSPECIFIED - Defaults to user entered text.
				289	COLUMN_ID_VIEW - Uses internally generated column id to identify values.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	290	x__xgafv: string, V1 error format.
				291	Allowed values
				292	1 - v1 error format
				293	2 - v2 error format
				294
				295	Returns:
				296	An object of the form:
				297
				298	{ # Response message for TablesService.ListRows.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	299	"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
				300	"rows": [ # The rows from the specified table.
				301	{ # A single row in a table.
				302	"name": "A String", # The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.
				303	"values": { # The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.
				304	"a_key": "",
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	305	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	306	},
				307	],
				308	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	309	</div>
				310
				311	<div class="method">
				312	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				313	<pre>Retrieves the next page of results.
				314
				315	Args:
				316	previous_request: The request for the previous page. (required)
				317	previous_response: The response from the request for the previous page. (required)
				318
				319	Returns:
				320	A request object that you can call 'execute()' on to request the next
				321	page. Returns None if there are no more items in the collection.
				322	</pre>
				323	</div>
				324
				325	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	326	<code class="details" id="patch">patch(name, body=None, updateMask=None, view=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	327	<pre>Updates a row.
				328
				329	Args:
				330	name: string, The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row. (required)
				331	body: object, The request body.
				332	The object takes the form of:
				333
				334	{ # A single row in a table.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	335	"name": "A String", # The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.
				336	"values": { # The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.
				337	"a_key": "",
				338	},
				339	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	340
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	341	updateMask: string, The list of fields to update.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	342	view: string, Optional. Column key to use for values in the row. Defaults to user entered name.
				343	Allowed values
				344	VIEW_UNSPECIFIED - Defaults to user entered text.
				345	COLUMN_ID_VIEW - Uses internally generated column id to identify values.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	346	x__xgafv: string, V1 error format.
				347	Allowed values
				348	1 - v1 error format
				349	2 - v2 error format
				350
				351	Returns:
				352	An object of the form:
				353
				354	{ # A single row in a table.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	355	"name": "A String", # The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.
				356	"values": { # The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.
				357	"a_key": "",
				358	},
				359	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	360	</div>
				361
				362	</body></html>