Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / firebaserules_v1.projects.rulesets.html
blob: 12eee950c86bca8a86edf80d35a1d154cf32ba2d [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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'Mearadd494642020-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 Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]79<p class="firstline">Create a `Ruleset` from `Source`.</p>
80<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-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 Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
Sai Cheemalapatie833b792017-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 Parrott0a471d32016-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'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94 <code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]95 <pre>Create a `Ruleset` from `Source`.
96
97The `Ruleset` is given a unique generated name which is returned to the
98caller. `Source` containing syntactic or semantics errors will result in an
99error response indicating the first error encountered. For a detailed view
100of `Source` issues, use TestRuleset.
101
102Args:
103 name: string, Resource name for Project which owns this `Ruleset`.
104
105Format: `projects/{project_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 body: object, The request body.
Jon Wayne Parrott0a471d32016-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
110 # and a creation time.
111 "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
112 "files": [ # `File` set constituting the `Source` bundle.
113 { # `File` containing source content.
114 "content": "A String", # Textual Content.
115 "name": "A String", # File name.
116 "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
117 },
118 ],
119 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]120 "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
121 # Format: `projects/{project_id}/rulesets/{ruleset_id}`
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]122 # Output only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 "createTime": "A String", # Time the `Ruleset` was created.
124 # Output only.
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 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]132 }
133
134 x__xgafv: string, V1 error format.
135 Allowed values
136 1 - v1 error format
137 2 - v2 error format
138
139Returns:
140 An object of the form:
141
142 { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
143 # and a creation time.
144 "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
145 "files": [ # `File` set constituting the `Source` bundle.
146 { # `File` containing source content.
147 "content": "A String", # Textual Content.
148 "name": "A String", # File name.
149 "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
150 },
151 ],
152 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]153 "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
154 # Format: `projects/{project_id}/rulesets/{ruleset_id}`
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]155 # Output only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]156 "createTime": "A String", # Time the `Ruleset` was created.
157 # Output only.
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 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]165 }</pre>
166</div>
167
168<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]169 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]170 <pre>Delete a `Ruleset` by resource name.
171
172If the `Ruleset` is referenced by a `Release` the operation will fail.
173
174Args:
175 name: string, Resource name for the ruleset to delete.
176
177Format: `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
183Returns:
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 Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]199 <code class="details" id="get">get(name, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]200 <pre>Get a `Ruleset` by name including the full `Source` contents.
201
202Args:
203 name: string, Resource name for the ruleset to get.
204
205Format: `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
211Returns:
212 An object of the form:
213
214 { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
215 # and a creation time.
216 "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
217 "files": [ # `File` set constituting the `Source` bundle.
218 { # `File` containing source content.
219 "content": "A String", # Textual Content.
220 "name": "A String", # File name.
221 "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
222 },
223 ],
224 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]225 "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
226 # Format: `projects/{project_id}/rulesets/{ruleset_id}`
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]227 # Output only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]228 "createTime": "A String", # Time the `Ruleset` was created.
229 # Output only.
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 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]237 }</pre>
238</div>
239
240<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]242 <pre>List `Ruleset` metadata only and optionally filter the results by `Ruleset`
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]243name.
244
245The full `Source` contents of a `Ruleset` may be retrieved with
246GetRuleset.
247
248Args:
249 name: string, Resource name for the project.
250
251Format: `projects/{project_id}` (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 pageToken: string, Next page token for loading the next batch of `Ruleset` instances.
253 x__xgafv: string, V1 error format.
254 Allowed values
255 1 - v1 error format
256 2 - v2 error format
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]257 pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
258Note: `page_size` is just a hint and the service may choose to load less
259than `page_size` due to the size of the output. To traverse all of the
260releases, caller should iterate until the `page_token` is empty.
261 filter: string, `Ruleset` filter. The list method supports filters with restrictions on
262`Ruleset.name`.
263
264Filters on `Ruleset.create_time` should use the `date` function which
265parses strings that conform to the RFC 3339 date/time specifications.
266
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]267Example: `create_time &gt; date("2017-01-01T00:00:00Z") AND name=UUID-*`
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]268
269Returns:
270 An object of the form:
271
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]272 { # The response for FirebaseRulesService.ListRulesets.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]273 "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
274 # empty, no further results remain.
275 "rulesets": [ # List of `Ruleset` instances.
276 { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
277 # and a creation time.
278 "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
279 "files": [ # `File` set constituting the `Source` bundle.
280 { # `File` containing source content.
281 "content": "A String", # Textual Content.
282 "name": "A String", # File name.
283 "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
284 },
285 ],
286 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]287 "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
288 # Format: `projects/{project_id}/rulesets/{ruleset_id}`
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]289 # Output only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]290 "createTime": "A String", # Time the `Ruleset` was created.
291 # Output only.
292 "metadata": { # Metadata for a Ruleset. # The metadata for this ruleset.
293 # Output only.
294 "services": [ # Services that this ruleset has declarations for (e.g.,
295 # "cloud.firestore"). There may be 0+ of these.
296 "A String",
297 ],
298 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]299 },
300 ],
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
308Args:
309 previous_request: The request for the previous page. (required)
310 previous_response: The response from the request for the previous page. (required)
311
312Returns:
313 A request object that you can call 'execute()' on to request the next
314 page. Returns None if there are no more items in the collection.
315 </pre>
316</div>
317
318</body></html>