1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a `Ruleset` from `Source`. The `Ruleset` is given a unique generated name which is returned to the caller. `Source` containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of `Source` issues, use TestRuleset.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a `Ruleset` by name including the full `Source` contents.</p>
<p class="toc_element">
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. The full `Source` contents of a `Ruleset` may be retrieved with GetRuleset.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
<pre>Create a `Ruleset` from `Source`. The `Ruleset` is given a unique generated name which is returned to the caller. `Source` containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of `Source` issues, use TestRuleset.
Args:
name: string, Required. Resource name for Project which owns this `Ruleset`. Format: `projects/{project_id}` (required)
body: object, The request body.
The object takes the form of:
{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
"attachmentPoint": "A String", # Immutable. Intended resource to which this Ruleset should be released. May be left blank to signify the resource associated with the default release. Expected format: firestore.googleapis.com/projects//databases/
"createTime": "A String", # Output only. Time the `Ruleset` was created.
"metadata": { # Metadata for a Ruleset. # Output only. The metadata for this ruleset.
"services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
"A String",
],
},
"name": "A String", # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
"source": { # `Source` is one or more `File` messages comprising a logical set of rules. # Required. `Source` for the `Ruleset`.
"files": [ # Required. `File` set constituting the `Source` bundle.
{ # `File` containing source content.
"content": "A String", # Required. Textual Content.
"fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
"name": "A String", # Required. File name.
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
"attachmentPoint": "A String", # Immutable. Intended resource to which this Ruleset should be released. May be left blank to signify the resource associated with the default release. Expected format: firestore.googleapis.com/projects//databases/
"createTime": "A String", # Output only. Time the `Ruleset` was created.
"metadata": { # Metadata for a Ruleset. # Output only. The metadata for this ruleset.
"services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
"A String",
],
},
"name": "A String", # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
"source": { # `Source` is one or more `File` messages comprising a logical set of rules. # Required. `Source` for the `Ruleset`.
"files": [ # Required. `File` set constituting the `Source` bundle.
{ # `File` containing source content.
"content": "A String", # Required. Textual Content.
"fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
"name": "A String", # Required. File name.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail.
Args:
name: string, Required. Resource name for the ruleset to delete. Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get a `Ruleset` by name including the full `Source` contents.
Args:
name: string, Required. Resource name for the ruleset to get. Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
"attachmentPoint": "A String", # Immutable. Intended resource to which this Ruleset should be released. May be left blank to signify the resource associated with the default release. Expected format: firestore.googleapis.com/projects//databases/
"createTime": "A String", # Output only. Time the `Ruleset` was created.
"metadata": { # Metadata for a Ruleset. # Output only. The metadata for this ruleset.
"services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
"A String",
],
},
"name": "A String", # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
"source": { # `Source` is one or more `File` messages comprising a logical set of rules. # Required. `Source` for the `Ruleset`.
"files": [ # Required. `File` set constituting the `Source` bundle.
{ # `File` containing source content.
"content": "A String", # Required. Textual Content.
"fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
"name": "A String", # Required. File name.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. The full `Source` contents of a `Ruleset` may be retrieved with GetRuleset.
Args:
name: string, Required. Resource name for the project. Format: `projects/{project_id}` (required)
filter: string, Optional. `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*`
pageSize: integer, Optional. Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty.
pageToken: string, Optional. Next page token for loading the next batch of `Ruleset` instances.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for FirebaseRulesService.ListRulesets.
"nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
"rulesets": [ # List of `Ruleset` instances.
{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
"attachmentPoint": "A String", # Immutable. Intended resource to which this Ruleset should be released. May be left blank to signify the resource associated with the default release. Expected format: firestore.googleapis.com/projects//databases/
"createTime": "A String", # Output only. Time the `Ruleset` was created.
"metadata": { # Metadata for a Ruleset. # Output only. The metadata for this ruleset.
"services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
"A String",
],
},
"name": "A String", # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
"source": { # `Source` is one or more `File` messages comprising a logical set of rules. # Required. `Source` for the `Ruleset`.
"files": [ # Required. `File` set constituting the `Source` bundle.
{ # `File` containing source content.
"content": "A String", # Required. Textual Content.
"fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
"name": "A String", # Required. File name.
},
],
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
