Blame - docs/dyn/firebaserules_v1.projects.rulesets.html - platform/external/python/google-api-python-client

blob: 40ff507195995b9dcc48ef0aa7b92f5454f68a43 [file] [log] [blame]

Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -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="firebaserules_v1.html">Firebase Rules API</a> . <a href="firebaserules_v1.projects.html">projects</a> . <a href="firebaserules_v1.projects.rulesets.html">rulesets</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="#create">create(name, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	79	<p class="firstline">Create a `Ruleset` from `Source`.</p>
				80	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	81	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	82	<p class="firstline">Delete a `Ruleset` by resource name.</p>
				83	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	84	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	85	<p class="firstline">Get a `Ruleset` by name including the full `Source` contents.</p>
				86	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	87	<code><a href="#list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	88	<p class="firstline">List `Ruleset` metadata only and optionally filter the results by `Ruleset`</p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<h3>Method Details</h3>
				93	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	94	<code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	95	<pre>Create a `Ruleset` from `Source`.
				96
				97	The `Ruleset` is given a unique generated name which is returned to the
				98	caller. `Source` containing syntactic or semantics errors will result in an
				99	error response indicating the first error encountered. For a detailed view
				100	of `Source` issues, use TestRuleset.
				101
				102	Args:
				103	name: string, Resource name for Project which owns this `Ruleset`.
				104
				105	Format: `projects/{project_id}` (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	106	body: object, The request body.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	107	The object takes the form of:
				108
				109	{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	110	# and a creation time.
				111	"createTime": "A String", # Time the `Ruleset` was created.
				112	# Output only.
				113	"name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
				114	# Format: `projects/{project_id}/rulesets/{ruleset_id}`
				115	# Output only.
				116	"source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
				117	"files": [ # `File` set constituting the `Source` bundle.
				118	{ # `File` containing source content.
				119	"content": "A String", # Textual Content.
				120	"fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
				121	"name": "A String", # File name.
				122	},
				123	],
				124	},
				125	"metadata": { # Metadata for a Ruleset. # The metadata for this ruleset.
				126	# Output only.
				127	"services": [ # Services that this ruleset has declarations for (e.g.,
				128	# "cloud.firestore"). There may be 0+ of these.
				129	"A String",
				130	],
				131	},
				132	}
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	133
				134	x__xgafv: string, V1 error format.
				135	Allowed values
				136	1 - v1 error format
				137	2 - v2 error format
				138
				139	Returns:
				140	An object of the form:
				141
				142	{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	143	# and a creation time.
				144	"createTime": "A String", # Time the `Ruleset` was created.
				145	# Output only.
				146	"name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
				147	# Format: `projects/{project_id}/rulesets/{ruleset_id}`
				148	# Output only.
				149	"source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
				150	"files": [ # `File` set constituting the `Source` bundle.
				151	{ # `File` containing source content.
				152	"content": "A String", # Textual Content.
				153	"fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
				154	"name": "A String", # File name.
				155	},
				156	],
				157	},
				158	"metadata": { # Metadata for a Ruleset. # The metadata for this ruleset.
				159	# Output only.
				160	"services": [ # Services that this ruleset has declarations for (e.g.,
				161	# "cloud.firestore"). There may be 0+ of these.
				162	"A String",
				163	],
				164	},
				165	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	166	</div>
				167
				168	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	169	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	170	<pre>Delete a `Ruleset` by resource name.
				171
				172	If the `Ruleset` is referenced by a `Release` the operation will fail.
				173
				174	Args:
				175	name: string, Resource name for the ruleset to delete.
				176
				177	Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
				178	x__xgafv: string, V1 error format.
				179	Allowed values
				180	1 - v1 error format
				181	2 - v2 error format
				182
				183	Returns:
				184	An object of the form:
				185
				186	{ # A generic empty message that you can re-use to avoid defining duplicated
				187	# empty messages in your APIs. A typical example is to use it as the request
				188	# or the response type of an API method. For instance:
				189	#
				190	# service Foo {
				191	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				192	# }
				193	#
				194	# The JSON representation for `Empty` is empty JSON object `{}`.
				195	}</pre>
				196	</div>
				197
				198	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	199	<code class="details" id="get">get(name, x__xgafv=None)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	200	<pre>Get a `Ruleset` by name including the full `Source` contents.
				201
				202	Args:
				203	name: string, Resource name for the ruleset to get.
				204
				205	Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
				206	x__xgafv: string, V1 error format.
				207	Allowed values
				208	1 - v1 error format
				209	2 - v2 error format
				210
				211	Returns:
				212	An object of the form:
				213
				214	{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	215	# and a creation time.
				216	"createTime": "A String", # Time the `Ruleset` was created.
				217	# Output only.
				218	"name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
				219	# Format: `projects/{project_id}/rulesets/{ruleset_id}`
				220	# Output only.
				221	"source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
				222	"files": [ # `File` set constituting the `Source` bundle.
				223	{ # `File` containing source content.
				224	"content": "A String", # Textual Content.
				225	"fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
				226	"name": "A String", # File name.
				227	},
				228	],
				229	},
				230	"metadata": { # Metadata for a Ruleset. # The metadata for this ruleset.
				231	# Output only.
				232	"services": [ # Services that this ruleset has declarations for (e.g.,
				233	# "cloud.firestore"). There may be 0+ of these.
				234	"A String",
				235	],
				236	},
				237	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	238	</div>
				239
				240	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	241	<code class="details" id="list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	242	<pre>List `Ruleset` metadata only and optionally filter the results by `Ruleset`
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	243	name.
				244
				245	The full `Source` contents of a `Ruleset` may be retrieved with
				246	GetRuleset.
				247
				248	Args:
				249	name: string, Resource name for the project.
				250
				251	Format: `projects/{project_id}` (required)
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	252	filter: string, `Ruleset` filter. The list method supports filters with restrictions on
				253	`Ruleset.name`.
				254
				255	Filters on `Ruleset.create_time` should use the `date` function which
				256	parses strings that conform to the RFC 3339 date/time specifications.
				257
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	258	Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*`
				259	pageToken: string, Next page token for loading the next batch of `Ruleset` instances.
				260	pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
				261	Note: `page_size` is just a hint and the service may choose to load less
				262	than `page_size` due to the size of the output. To traverse all of the
				263	releases, caller should iterate until the `page_token` is empty.
				264	x__xgafv: string, V1 error format.
				265	Allowed values
				266	1 - v1 error format
				267	2 - v2 error format
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	268
				269	Returns:
				270	An object of the form:
				271
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	272	{ # The response for FirebaseRulesService.ListRulesets.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	273	"rulesets": [ # List of `Ruleset` instances.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	274	{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	275	# and a creation time.
				276	"createTime": "A String", # Time the `Ruleset` was created.
				277	# Output only.
				278	"name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
				279	# Format: `projects/{project_id}/rulesets/{ruleset_id}`
				280	# Output only.
				281	"source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
				282	"files": [ # `File` set constituting the `Source` bundle.
				283	{ # `File` containing source content.
				284	"content": "A String", # Textual Content.
				285	"fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
				286	"name": "A String", # File name.
				287	},
				288	],
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	289	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	290	"metadata": { # Metadata for a Ruleset. # The metadata for this ruleset.
				291	# Output only.
				292	"services": [ # Services that this ruleset has declarations for (e.g.,
				293	# "cloud.firestore"). There may be 0+ of these.
				294	"A String",
				295	],
				296	},
				297	},
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	298	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	299	"nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
				300	# empty, no further results remain.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	301	}</pre>
				302	</div>
				303
				304	<div class="method">
				305	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				306	<pre>Retrieves the next page of results.
				307
				308	Args:
				309	previous_request: The request for the previous page. (required)
				310	previous_response: The response from the request for the previous page. (required)
				311
				312	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame^]	313	A request object that you can call 'execute()' on to request the next
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	314	page. Returns None if there are no more items in the collection.
				315	</pre>
				316	</div>
				317
				318	</body></html>