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.releases.html">releases</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 `Release`.</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 `Release` 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 `Release` by name.</p>
86<p class="toc_element">
87  <code><a href="#getExecutable">getExecutable(name, executableVersion=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Get the `Release` executable to use when enforcing rules.</p>
89<p class="toc_element">
90  <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
91<p class="firstline">List the `Release` values for a project. This list may optionally be</p>
92<p class="toc_element">
93  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96  <code><a href="#patch">patch(name, body, x__xgafv=None)</a></code></p>
97<p class="firstline">Update a `Release` via PATCH.</p>
98<h3>Method Details</h3>
99<div class="method">
100    <code class="details" id="create">create(name, body, x__xgafv=None)</code>
101  <pre>Create a `Release`.
102
103Release names should reflect the developer's deployment practices. For
104example, the release name may include the environment name, application
105name, application version, or any other name meaningful to the developer.
106Once a `Release` refers to a `Ruleset`, the rules can be enforced by
107Firebase Rules-enabled services.
108
109More than one `Release` may be 'live' concurrently. Consider the following
110three `Release` names for `projects/foo` and the `Ruleset` to which they
111refer.
112
113Release Name                    | Ruleset Name
114--------------------------------|-------------
115projects/foo/releases/prod      | projects/foo/rulesets/uuid123
116projects/foo/releases/prod/beta | projects/foo/rulesets/uuid123
117projects/foo/releases/prod/v23  | projects/foo/rulesets/uuid456
118
119The table reflects the `Ruleset` rollout in progress. The `prod` and
120`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`
121refers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be
122updated using the UpdateRelease method.
123
124Args:
125  name: string, Resource name for the project which owns this `Release`.
126
127Format: `projects/{project_id}` (required)
128  body: object, The request body. (required)
129    The object takes the form of:
130
131{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
132    # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
133  "updateTime": "A String", # Time the release was updated.
134      # Output only.
135  "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
136      # exist the `Release` to be created.
137  "name": "A String", # Resource name for the `Release`.
138      #
139      # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
140      # which affords developers a great deal of flexibility in mapping the name
141      # to the style that best fits their existing development practices. For
142      # example, a name could refer to an environment, an app, a version, or some
143      # combination of three.
144      #
145      # In the table below, for the project name `projects/foo`, the following
146      # relative release paths show how flat and structured names might be chosen
147      # to match a desired development / deployment strategy.
148      #
149      # Use Case     | Flat Name           | Structured Name
150      # -------------|---------------------|----------------
151      # Environments | releases/qa         | releases/qa
152      # Apps         | releases/app1_qa    | releases/app1/qa
153      # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
154      #
155      # The delimiter between the release name path elements can be almost anything
156      # and it should work equally well with the release name list filter, but in
157      # many ways the structured paths provide a clearer picture of the
158      # relationship between `Release` instances.
159      #
160      # Format: `projects/{project_id}/releases/{release_id}`
161  "createTime": "A String", # Time the release was created.
162      # Output only.
163}
164
165  x__xgafv: string, V1 error format.
166    Allowed values
167      1 - v1 error format
168      2 - v2 error format
169
170Returns:
171  An object of the form:
172
173    { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
174      # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
175    "updateTime": "A String", # Time the release was updated.
176        # Output only.
177    "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
178        # exist the `Release` to be created.
179    "name": "A String", # Resource name for the `Release`.
180        #
181        # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
182        # which affords developers a great deal of flexibility in mapping the name
183        # to the style that best fits their existing development practices. For
184        # example, a name could refer to an environment, an app, a version, or some
185        # combination of three.
186        #
187        # In the table below, for the project name `projects/foo`, the following
188        # relative release paths show how flat and structured names might be chosen
189        # to match a desired development / deployment strategy.
190        #
191        # Use Case     | Flat Name           | Structured Name
192        # -------------|---------------------|----------------
193        # Environments | releases/qa         | releases/qa
194        # Apps         | releases/app1_qa    | releases/app1/qa
195        # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
196        #
197        # The delimiter between the release name path elements can be almost anything
198        # and it should work equally well with the release name list filter, but in
199        # many ways the structured paths provide a clearer picture of the
200        # relationship between `Release` instances.
201        #
202        # Format: `projects/{project_id}/releases/{release_id}`
203    "createTime": "A String", # Time the release was created.
204        # Output only.
205  }</pre>
206</div>
207
208<div class="method">
209    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
210  <pre>Delete a `Release` by resource name.
211
212Args:
213  name: string, Resource name for the `Release` to delete.
214
215Format: `projects/{project_id}/releases/{release_id}` (required)
216  x__xgafv: string, V1 error format.
217    Allowed values
218      1 - v1 error format
219      2 - v2 error format
220
221Returns:
222  An object of the form:
223
224    { # A generic empty message that you can re-use to avoid defining duplicated
225      # empty messages in your APIs. A typical example is to use it as the request
226      # or the response type of an API method. For instance:
227      #
228      #     service Foo {
229      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
230      #     }
231      #
232      # The JSON representation for `Empty` is empty JSON object `{}`.
233  }</pre>
234</div>
235
236<div class="method">
237    <code class="details" id="get">get(name, x__xgafv=None)</code>
238  <pre>Get a `Release` by name.
239
240Args:
241  name: string, Resource name of the `Release`.
242
243Format: `projects/{project_id}/releases/{release_id}` (required)
244  x__xgafv: string, V1 error format.
245    Allowed values
246      1 - v1 error format
247      2 - v2 error format
248
249Returns:
250  An object of the form:
251
252    { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
253      # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
254    "updateTime": "A String", # Time the release was updated.
255        # Output only.
256    "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
257        # exist the `Release` to be created.
258    "name": "A String", # Resource name for the `Release`.
259        #
260        # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
261        # which affords developers a great deal of flexibility in mapping the name
262        # to the style that best fits their existing development practices. For
263        # example, a name could refer to an environment, an app, a version, or some
264        # combination of three.
265        #
266        # In the table below, for the project name `projects/foo`, the following
267        # relative release paths show how flat and structured names might be chosen
268        # to match a desired development / deployment strategy.
269        #
270        # Use Case     | Flat Name           | Structured Name
271        # -------------|---------------------|----------------
272        # Environments | releases/qa         | releases/qa
273        # Apps         | releases/app1_qa    | releases/app1/qa
274        # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
275        #
276        # The delimiter between the release name path elements can be almost anything
277        # and it should work equally well with the release name list filter, but in
278        # many ways the structured paths provide a clearer picture of the
279        # relationship between `Release` instances.
280        #
281        # Format: `projects/{project_id}/releases/{release_id}`
282    "createTime": "A String", # Time the release was created.
283        # Output only.
284  }</pre>
285</div>
286
287<div class="method">
288    <code class="details" id="getExecutable">getExecutable(name, executableVersion=None, x__xgafv=None)</code>
289  <pre>Get the `Release` executable to use when enforcing rules.
290
291Args:
292  name: string, Resource name of the `Release`.
293
294Format: `projects/{project_id}/releases/{release_id}` (required)
295  executableVersion: string, The requested runtime executable version.
296Defaults to FIREBASE_RULES_EXECUTABLE_V1.
297  x__xgafv: string, V1 error format.
298    Allowed values
299      1 - v1 error format
300      2 - v2 error format
301
302Returns:
303  An object of the form:
304
305    { # The response for FirebaseRulesService.GetReleaseExecutable
306    "executable": "A String", # Executable view of the `Ruleset` referenced by the `Release`.
307    "language": "A String", # `Language` used to generate the executable bytes.
308    "rulesetName": "A String", # `Ruleset` name associated with the `Release` executable.
309    "updateTime": "A String", # Timestamp for the most recent `Release.update_time`.
310    "syncTime": "A String", # Optional, indicates the freshness of the result. The response is
311        # guaranteed to be the latest within an interval up to the
312        # sync_time (inclusive).
313    "executableVersion": "A String", # The Rules runtime version of the executable.
314  }</pre>
315</div>
316
317<div class="method">
318    <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
319  <pre>List the `Release` values for a project. This list may optionally be
320filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any
321combination thereof.
322
323Args:
324  name: string, Resource name for the project.
325
326Format: `projects/{project_id}` (required)
327  pageToken: string, Next page token for the next batch of `Release` instances.
328  x__xgafv: string, V1 error format.
329    Allowed values
330      1 - v1 error format
331      2 - v2 error format
332  pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
333Note: `page_size` is just a hint and the service may choose to load fewer
334than `page_size` results due to the size of the output. To traverse all of
335the releases, the caller should iterate until the `page_token` on the
336response is empty.
337  filter: string, `Release` filter. The list method supports filters with restrictions on the
338`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.
339
340Example 1: A filter of 'name=prod*' might return `Release`s with names
341within 'projects/foo' prefixed with 'prod':
342
343Name                          | Ruleset Name
344------------------------------|-------------
345projects/foo/releases/prod    | projects/foo/rulesets/uuid1234
346projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234
347projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888
348
349Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only
350`Release` instances for 'projects/foo' with names prefixed with 'prod'
351referring to the same `Ruleset` name of 'uuid1234':
352
353Name                          | Ruleset Name
354------------------------------|-------------
355projects/foo/releases/prod    | projects/foo/rulesets/1234
356projects/foo/releases/prod/v1 | projects/foo/rulesets/1234
357
358In the examples, the filter parameters refer to the search filters are
359relative to the project. Fully qualified prefixed may also be used. e.g.
360`test_suite_name=projects/foo/testsuites/uuid1`
361
362Returns:
363  An object of the form:
364
365    { # The response for FirebaseRulesService.ListReleases.
366    "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
367        # empty, no further results remain.
368    "releases": [ # List of `Release` instances.
369      { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
370          # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
371        "updateTime": "A String", # Time the release was updated.
372            # Output only.
373        "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
374            # exist the `Release` to be created.
375        "name": "A String", # Resource name for the `Release`.
376            #
377            # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
378            # which affords developers a great deal of flexibility in mapping the name
379            # to the style that best fits their existing development practices. For
380            # example, a name could refer to an environment, an app, a version, or some
381            # combination of three.
382            #
383            # In the table below, for the project name `projects/foo`, the following
384            # relative release paths show how flat and structured names might be chosen
385            # to match a desired development / deployment strategy.
386            #
387            # Use Case     | Flat Name           | Structured Name
388            # -------------|---------------------|----------------
389            # Environments | releases/qa         | releases/qa
390            # Apps         | releases/app1_qa    | releases/app1/qa
391            # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
392            #
393            # The delimiter between the release name path elements can be almost anything
394            # and it should work equally well with the release name list filter, but in
395            # many ways the structured paths provide a clearer picture of the
396            # relationship between `Release` instances.
397            #
398            # Format: `projects/{project_id}/releases/{release_id}`
399        "createTime": "A String", # Time the release was created.
400            # Output only.
401      },
402    ],
403  }</pre>
404</div>
405
406<div class="method">
407    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
408  <pre>Retrieves the next page of results.
409
410Args:
411  previous_request: The request for the previous page. (required)
412  previous_response: The response from the request for the previous page. (required)
413
414Returns:
415  A request object that you can call 'execute()' on to request the next
416  page. Returns None if there are no more items in the collection.
417    </pre>
418</div>
419
420<div class="method">
421    <code class="details" id="patch">patch(name, body, x__xgafv=None)</code>
422  <pre>Update a `Release` via PATCH.
423
424Only updates to the `ruleset_name` and `test_suite_name` fields will be
425honored. `Release` rename is not supported. To create a `Release` use the
426CreateRelease method.
427
428Args:
429  name: string, Resource name for the project which owns this `Release`.
430
431Format: `projects/{project_id}` (required)
432  body: object, The request body. (required)
433    The object takes the form of:
434
435{ # The request for FirebaseRulesService.UpdateReleasePatch.
436    "release": { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a # `Release` to update.
437        # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
438      "updateTime": "A String", # Time the release was updated.
439          # Output only.
440      "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
441          # exist the `Release` to be created.
442      "name": "A String", # Resource name for the `Release`.
443          #
444          # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
445          # which affords developers a great deal of flexibility in mapping the name
446          # to the style that best fits their existing development practices. For
447          # example, a name could refer to an environment, an app, a version, or some
448          # combination of three.
449          #
450          # In the table below, for the project name `projects/foo`, the following
451          # relative release paths show how flat and structured names might be chosen
452          # to match a desired development / deployment strategy.
453          #
454          # Use Case     | Flat Name           | Structured Name
455          # -------------|---------------------|----------------
456          # Environments | releases/qa         | releases/qa
457          # Apps         | releases/app1_qa    | releases/app1/qa
458          # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
459          #
460          # The delimiter between the release name path elements can be almost anything
461          # and it should work equally well with the release name list filter, but in
462          # many ways the structured paths provide a clearer picture of the
463          # relationship between `Release` instances.
464          #
465          # Format: `projects/{project_id}/releases/{release_id}`
466      "createTime": "A String", # Time the release was created.
467          # Output only.
468    },
469    "updateMask": "A String", # Specifies which fields to update.
470  }
471
472  x__xgafv: string, V1 error format.
473    Allowed values
474      1 - v1 error format
475      2 - v2 error format
476
477Returns:
478  An object of the form:
479
480    { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
481      # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
482    "updateTime": "A String", # Time the release was updated.
483        # Output only.
484    "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
485        # exist the `Release` to be created.
486    "name": "A String", # Resource name for the `Release`.
487        #
488        # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
489        # which affords developers a great deal of flexibility in mapping the name
490        # to the style that best fits their existing development practices. For
491        # example, a name could refer to an environment, an app, a version, or some
492        # combination of three.
493        #
494        # In the table below, for the project name `projects/foo`, the following
495        # relative release paths show how flat and structured names might be chosen
496        # to match a desired development / deployment strategy.
497        #
498        # Use Case     | Flat Name           | Structured Name
499        # -------------|---------------------|----------------
500        # Environments | releases/qa         | releases/qa
501        # Apps         | releases/app1_qa    | releases/app1/qa
502        # Versions     | releases/app1_v2_qa | releases/app1/v2/qa
503        #
504        # The delimiter between the release name path elements can be almost anything
505        # and it should work equally well with the release name list filter, but in
506        # many ways the structured paths provide a clearer picture of the
507        # relationship between `Release` instances.
508        #
509        # Format: `projects/{project_id}/releases/{release_id}`
510    "createTime": "A String", # Time the release was created.
511        # Output only.
512  }</pre>
513</div>
514
515</body></html>