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">
78  <code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Create a `Ruleset` from `Source`.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Delete a `Ruleset` by resource name.</p>
83<p class="toc_element">
84  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Get a `Ruleset` by name including the full `Source` contents.</p>
86<p class="toc_element">
87  <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
88<p class="firstline">List `Ruleset` metadata only and optionally filter the results by `Ruleset`</p>
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">
94    <code class="details" id="create">create(name, body, x__xgafv=None)</code>
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)
106  body: object, The request body. (required)
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    },
120    "createTime": "A String", # Time the `Ruleset` was created.
121        # Output only.
122    "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
123        # Format: `projects/{project_id}/rulesets/{ruleset_id}`
124        # Output only.
125  }
126
127  x__xgafv: string, V1 error format.
128    Allowed values
129      1 - v1 error format
130      2 - v2 error format
131
132Returns:
133  An object of the form:
134
135    { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
136        # and a creation time.
137      "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
138        "files": [ # `File` set constituting the `Source` bundle.
139          { # `File` containing source content.
140            "content": "A String", # Textual Content.
141            "name": "A String", # File name.
142            "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
143          },
144        ],
145      },
146      "createTime": "A String", # Time the `Ruleset` was created.
147          # Output only.
148      "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
149          # Format: `projects/{project_id}/rulesets/{ruleset_id}`
150          # Output only.
151    }</pre>
152</div>
153
154<div class="method">
155    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
156  <pre>Delete a `Ruleset` by resource name.
157
158If the `Ruleset` is referenced by a `Release` the operation will fail.
159
160Args:
161  name: string, Resource name for the ruleset to delete.
162
163Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
164  x__xgafv: string, V1 error format.
165    Allowed values
166      1 - v1 error format
167      2 - v2 error format
168
169Returns:
170  An object of the form:
171
172    { # A generic empty message that you can re-use to avoid defining duplicated
173      # empty messages in your APIs. A typical example is to use it as the request
174      # or the response type of an API method. For instance:
175      #
176      #     service Foo {
177      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
178      #     }
179      #
180      # The JSON representation for `Empty` is empty JSON object `{}`.
181  }</pre>
182</div>
183
184<div class="method">
185    <code class="details" id="get">get(name, x__xgafv=None)</code>
186  <pre>Get a `Ruleset` by name including the full `Source` contents.
187
188Args:
189  name: string, Resource name for the ruleset to get.
190
191Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
192  x__xgafv: string, V1 error format.
193    Allowed values
194      1 - v1 error format
195      2 - v2 error format
196
197Returns:
198  An object of the form:
199
200    { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
201        # and a creation time.
202      "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
203        "files": [ # `File` set constituting the `Source` bundle.
204          { # `File` containing source content.
205            "content": "A String", # Textual Content.
206            "name": "A String", # File name.
207            "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
208          },
209        ],
210      },
211      "createTime": "A String", # Time the `Ruleset` was created.
212          # Output only.
213      "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
214          # Format: `projects/{project_id}/rulesets/{ruleset_id}`
215          # Output only.
216    }</pre>
217</div>
218
219<div class="method">
220    <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
221  <pre>List `Ruleset` metadata only and optionally filter the results by `Ruleset`
222name.
223
224The full `Source` contents of a `Ruleset` may be retrieved with
225GetRuleset.
226
227Args:
228  name: string, Resource name for the project.
229
230Format: `projects/{project_id}` (required)
231  pageToken: string, Next page token for loading the next batch of `Ruleset` instances.
232  x__xgafv: string, V1 error format.
233    Allowed values
234      1 - v1 error format
235      2 - v2 error format
236  pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
237Note: `page_size` is just a hint and the service may choose to load less
238than `page_size` due to the size of the output. To traverse all of the
239releases, caller should iterate until the `page_token` is empty.
240  filter: string, `Ruleset` filter. The list method supports filters with restrictions on
241`Ruleset.name`.
242
243Filters on `Ruleset.create_time` should use the `date` function which
244parses strings that conform to the RFC 3339 date/time specifications.
245
246Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*`
247
248Returns:
249  An object of the form:
250
251    { # The response for FirebaseRulesService.ListRulesets.
252    "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
253        # empty, no further results remain.
254    "rulesets": [ # List of `Ruleset` instances.
255      { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
256            # and a creation time.
257          "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
258            "files": [ # `File` set constituting the `Source` bundle.
259              { # `File` containing source content.
260                "content": "A String", # Textual Content.
261                "name": "A String", # File name.
262                "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
263              },
264            ],
265          },
266          "createTime": "A String", # Time the `Ruleset` was created.
267              # Output only.
268          "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
269              # Format: `projects/{project_id}/rulesets/{ruleset_id}`
270              # Output only.
271        },
272    ],
273  }</pre>
274</div>
275
276<div class="method">
277    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
278  <pre>Retrieves the next page of results.
279
280Args:
281  previous_request: The request for the previous page. (required)
282  previous_response: The response from the request for the previous page. (required)
283
284Returns:
285  A request object that you can call 'execute()' on to request the next
286  page. Returns None if there are no more items in the collection.
287    </pre>
288</div>
289
290</body></html>