Debian Codegraph @

docs/dyn/firebaserules_v1.projects.rulesets.html

raw
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">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p>
82 <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>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Get a `Ruleset` by name including the full `Source` contents.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <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>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
103 <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.
104
105 Args:
106 name: string, Required. Resource name for Project which owns this `Ruleset`. Format: `projects/{project_id}` (required)
107 body: object, The request body.
108 The object takes the form of:
109
110 { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
111 &quot;attachmentPoint&quot;: &quot;A String&quot;, # 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/
112 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the `Ruleset` was created.
113 &quot;metadata&quot;: { # Metadata for a Ruleset. # Output only. The metadata for this ruleset.
114 &quot;services&quot;: [ # Services that this ruleset has declarations for (e.g., &quot;cloud.firestore&quot;). There may be 0+ of these.
115 &quot;A String&quot;,
116 ],
117 },
118 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
119 &quot;source&quot;: { # `Source` is one or more `File` messages comprising a logical set of rules. # Required. `Source` for the `Ruleset`.
120 &quot;files&quot;: [ # Required. `File` set constituting the `Source` bundle.
121 { # `File` containing source content.
122 &quot;content&quot;: &quot;A String&quot;, # Required. Textual Content.
123 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint (e.g. github sha) associated with the `File`.
124 &quot;name&quot;: &quot;A String&quot;, # Required. File name.
125 },
126 ],
127 },
128 }
129
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135 Returns:
136 An object of the form:
137
138 { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
139 &quot;attachmentPoint&quot;: &quot;A String&quot;, # 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/
140 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the `Ruleset` was created.
141 &quot;metadata&quot;: { # Metadata for a Ruleset. # Output only. The metadata for this ruleset.
142 &quot;services&quot;: [ # Services that this ruleset has declarations for (e.g., &quot;cloud.firestore&quot;). There may be 0+ of these.
143 &quot;A String&quot;,
144 ],
145 },
146 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
147 &quot;source&quot;: { # `Source` is one or more `File` messages comprising a logical set of rules. # Required. `Source` for the `Ruleset`.
148 &quot;files&quot;: [ # Required. `File` set constituting the `Source` bundle.
149 { # `File` containing source content.
150 &quot;content&quot;: &quot;A String&quot;, # Required. Textual Content.
151 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint (e.g. github sha) associated with the `File`.
152 &quot;name&quot;: &quot;A String&quot;, # Required. File name.
153 },
154 ],
155 },
156 }</pre>
157 </div>
158
159 <div class="method">
160 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
161 <pre>Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail.
162
163 Args:
164 name: string, Required. Resource name for the ruleset to delete. Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170 Returns:
171 An object of the form:
172
173 { # 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); }
174 }</pre>
175 </div>
176
177 <div class="method">
178 <code class="details" id="get">get(name, x__xgafv=None)</code>
179 <pre>Get a `Ruleset` by name including the full `Source` contents.
180
181 Args:
182 name: string, Required. Resource name for the ruleset to get. Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
183 x__xgafv: string, V1 error format.
184 Allowed values
185 1 - v1 error format
186 2 - v2 error format
187
188 Returns:
189 An object of the form:
190
191 { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
192 &quot;attachmentPoint&quot;: &quot;A String&quot;, # 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/
193 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the `Ruleset` was created.
194 &quot;metadata&quot;: { # Metadata for a Ruleset. # Output only. The metadata for this ruleset.
195 &quot;services&quot;: [ # Services that this ruleset has declarations for (e.g., &quot;cloud.firestore&quot;). There may be 0+ of these.
196 &quot;A String&quot;,
197 ],
198 },
199 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
200 &quot;source&quot;: { # `Source` is one or more `File` messages comprising a logical set of rules. # Required. `Source` for the `Ruleset`.
201 &quot;files&quot;: [ # Required. `File` set constituting the `Source` bundle.
202 { # `File` containing source content.
203 &quot;content&quot;: &quot;A String&quot;, # Required. Textual Content.
204 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint (e.g. github sha) associated with the `File`.
205 &quot;name&quot;: &quot;A String&quot;, # Required. File name.
206 },
207 ],
208 },
209 }</pre>
210 </div>
211
212 <div class="method">
213 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
214 <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.
215
216 Args:
217 name: string, Required. Resource name for the project. Format: `projects/{project_id}` (required)
218 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 &gt; date(&quot;2017-01-01T00:00:00Z&quot;) AND name=UUID-*`
219 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.
220 pageToken: string, Optional. Next page token for loading the next batch of `Ruleset` instances.
221 x__xgafv: string, V1 error format.
222 Allowed values
223 1 - v1 error format
224 2 - v2 error format
225
226 Returns:
227 An object of the form:
228
229 { # The response for FirebaseRulesService.ListRulesets.
230 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
231 &quot;rulesets&quot;: [ # List of `Ruleset` instances.
232 { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
233 &quot;attachmentPoint&quot;: &quot;A String&quot;, # 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/
234 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time the `Ruleset` was created.
235 &quot;metadata&quot;: { # Metadata for a Ruleset. # Output only. The metadata for this ruleset.
236 &quot;services&quot;: [ # Services that this ruleset has declarations for (e.g., &quot;cloud.firestore&quot;). There may be 0+ of these.
237 &quot;A String&quot;,
238 ],
239 },
240 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
241 &quot;source&quot;: { # `Source` is one or more `File` messages comprising a logical set of rules. # Required. `Source` for the `Ruleset`.
242 &quot;files&quot;: [ # Required. `File` set constituting the `Source` bundle.
243 { # `File` containing source content.
244 &quot;content&quot;: &quot;A String&quot;, # Required. Textual Content.
245 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint (e.g. github sha) associated with the `File`.
246 &quot;name&quot;: &quot;A String&quot;, # Required. File name.
247 },
248 ],
249 },
250 },
251 ],
252 }</pre>
253 </div>
254
255 <div class="method">
256 <code class="details" id="list_next">list_next()</code>
257 <pre>Retrieves the next page of results.
258
259 Args:
260 previous_request: The request for the previous page. (required)
261 previous_response: The response from the request for the previous page. (required)
262
263 Returns:
264 A request object that you can call &#x27;execute()&#x27; on to request the next
265 page. Returns None if there are no more items in the collection.
266 </pre>
267 </div>
268
269 </body></html>