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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
|
<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.releases.html">releases</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(name=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Create a `Release`.</p>
<p class="toc_element">
<code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a `Release` by resource name.</p>
<p class="toc_element">
<code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a `Release` by name.</p>
<p class="toc_element">
<code><a href="#list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List the `Release` values for a project. This list may optionally be</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(name=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Update a `Release`.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(name=None, body, x__xgafv=None)</code>
<pre>Create a `Release`.
Release names should reflect the developer's deployment practices. For
example, the release name may include the environment name, application
name, application version, or any other name meaningful to the developer.
Once a `Release` refers to a `Ruleset`, the rules can be enforced by
Firebase Rules-enabled services.
More than one `Release` may be 'live' concurrently. Consider the following
three `Release` names for `projects/foo` and the `Ruleset` to which they
refer.
Release Name | Ruleset Name
--------------------------------|-------------
projects/foo/releases/prod | projects/foo/rulesets/uuid123
projects/foo/releases/prod/beta | projects/foo/rulesets/uuid123
projects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456
The table reflects the `Ruleset` rollout in progress. The `prod` and
`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`
refers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be
updated using the UpdateRelease method, and the custom `Release` name
may be referenced by specifying the `X-Firebase-Rules-Release-Name` header.
Args:
name: string, Resource name for the project which owns this `Release`.
Format: `projects/{project_id}` (required)
body: object, The request body. (required)
The object takes the form of:
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
# @OutputOnly
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
"createTime": "A String", # Time the release was created.
# @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
# to the style that best fits their existing development practices. For
# example, a name could refer to an environment, an app, a version, or some
# combination of three.
#
# In the table below, for the project name `projects/foo`, the following
# relative release paths show how flat and structured names might be chosen
# to match a desired development / deployment strategy.
#
# Use Case | Flat Name | Structured Name
# -------------|---------------------|----------------
# Environments | releases/qa | releases/qa
# Apps | releases/app1_qa | releases/app1/qa
# Versions | releases/app1_v2_qa | releases/app1/v2/qa
#
# The delimiter between the release name path elements can be almost anything
# and it should work equally well with the release name list filter, but in
# many ways the structured paths provide a clearer picture of the
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
# @OutputOnly
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
"createTime": "A String", # Time the release was created.
# @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
# to the style that best fits their existing development practices. For
# example, a name could refer to an environment, an app, a version, or some
# combination of three.
#
# In the table below, for the project name `projects/foo`, the following
# relative release paths show how flat and structured names might be chosen
# to match a desired development / deployment strategy.
#
# Use Case | Flat Name | Structured Name
# -------------|---------------------|----------------
# Environments | releases/qa | releases/qa
# Apps | releases/app1_qa | releases/app1/qa
# Versions | releases/app1_v2_qa | releases/app1/v2/qa
#
# The delimiter between the release name path elements can be almost anything
# and it should work equally well with the release name list filter, but in
# many ways the structured paths provide a clearer picture of the
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
<pre>Delete a `Release` by resource name.
Args:
name: string, Resource name for the `Release` to delete.
Format: `projects/{project_id}/releases/{release_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);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name=None, x__xgafv=None)</code>
<pre>Get a `Release` by name.
Args:
name: string, Resource name of the `Release`.
Format: `projects/{project_id}/releases/{release_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
# @OutputOnly
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
"createTime": "A String", # Time the release was created.
# @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
# to the style that best fits their existing development practices. For
# example, a name could refer to an environment, an app, a version, or some
# combination of three.
#
# In the table below, for the project name `projects/foo`, the following
# relative release paths show how flat and structured names might be chosen
# to match a desired development / deployment strategy.
#
# Use Case | Flat Name | Structured Name
# -------------|---------------------|----------------
# Environments | releases/qa | releases/qa
# Apps | releases/app1_qa | releases/app1/qa
# Versions | releases/app1_v2_qa | releases/app1/v2/qa
#
# The delimiter between the release name path elements can be almost anything
# and it should work equally well with the release name list filter, but in
# many ways the structured paths provide a clearer picture of the
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>List the `Release` values for a project. This list may optionally be
filtered by `Release` name or `Ruleset` id or both.
Args:
name: string, Resource name for the project.
Format: `projects/{project_id}` (required)
pageSize: integer, 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.
filter: string, `Release` filter. The list method supports filters with restrictions on the
`Release` `name` and also on the `Ruleset` `ruleset_name`.
Example 1) A filter of 'name=prod*' might return `Release`s with names
within 'projects/foo' prefixed with 'prod':
Name | Ruleset Name
------------------------------|-------------
projects/foo/releases/prod | projects/foo/rulesets/uuid1234
projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234
projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888
Example 2) A filter of `name=prod* ruleset_name=uuid1234` would return only
`Release` instances for 'projects/foo' with names prefixed with 'prod'
referring to the same `Ruleset` name of 'uuid1234':
Name | Ruleset Name
------------------------------|-------------
projects/foo/releases/prod | projects/foo/rulesets/1234
projects/foo/releases/prod/v1 | projects/foo/rulesets/1234
In the examples, the filter parameters refer to the search filters for
release and ruleset names are relative to the project releases and rulesets
collections. Fully qualified prefixed may also be used. e.g.
`name=projects/foo/releases/prod* ruleset_name=projects/foo/rulesets/uuid1`
pageToken: string, Next page token for the next batch of `Release` 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.ListReleases.
"nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
# empty, no further results remain.
"releases": [ # List of `Release` instances.
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
# @OutputOnly
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
"createTime": "A String", # Time the release was created.
# @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
# to the style that best fits their existing development practices. For
# example, a name could refer to an environment, an app, a version, or some
# combination of three.
#
# In the table below, for the project name `projects/foo`, the following
# relative release paths show how flat and structured names might be chosen
# to match a desired development / deployment strategy.
#
# Use Case | Flat Name | Structured Name
# -------------|---------------------|----------------
# Environments | releases/qa | releases/qa
# Apps | releases/app1_qa | releases/app1/qa
# Versions | releases/app1_v2_qa | releases/app1/v2/qa
#
# The delimiter between the release name path elements can be almost anything
# and it should work equally well with the release name list filter, but in
# many ways the structured paths provide a clearer picture of the
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
<div class="method">
<code class="details" id="update">update(name=None, body, x__xgafv=None)</code>
<pre>Update a `Release`.
Only updates to the `ruleset_name` field will be honored. `Release` rename
is not supported. To create a `Release` use the CreateRelease method
instead.
Args:
name: string, Resource name for the `Release`.
`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
which affords developers a great deal of flexibility in mapping the name
to the style that best fits their existing development practices. For
example, a name could refer to an environment, an app, a version, or some
combination of three.
In the table below, for the project name `projects/foo`, the following
relative release paths show how flat and structured names might be chosen
to match a desired development / deployment strategy.
Use Case | Flat Name | Structured Name
-------------|---------------------|----------------
Environments | releases/qa | releases/qa
Apps | releases/app1_qa | releases/app1/qa
Versions | releases/app1_v2_qa | releases/app1/v2/qa
The delimiter between the release name path elements can be almost anything
and it should work equally well with the release name list filter, but in
many ways the structured paths provide a clearer picture of the
relationship between `Release` instances.
Format: `projects/{project_id}/releases/{release_id}` (required)
body: object, The request body. (required)
The object takes the form of:
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
# @OutputOnly
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
"createTime": "A String", # Time the release was created.
# @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
# to the style that best fits their existing development practices. For
# example, a name could refer to an environment, an app, a version, or some
# combination of three.
#
# In the table below, for the project name `projects/foo`, the following
# relative release paths show how flat and structured names might be chosen
# to match a desired development / deployment strategy.
#
# Use Case | Flat Name | Structured Name
# -------------|---------------------|----------------
# Environments | releases/qa | releases/qa
# Apps | releases/app1_qa | releases/app1/qa
# Versions | releases/app1_v2_qa | releases/app1/v2/qa
#
# The delimiter between the release name path elements can be almost anything
# and it should work equally well with the release name list filter, but in
# many ways the structured paths provide a clearer picture of the
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
# @OutputOnly
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
"createTime": "A String", # Time the release was created.
# @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
# to the style that best fits their existing development practices. For
# example, a name could refer to an environment, an app, a version, or some
# combination of three.
#
# In the table below, for the project name `projects/foo`, the following
# relative release paths show how flat and structured names might be chosen
# to match a desired development / deployment strategy.
#
# Use Case | Flat Name | Structured Name
# -------------|---------------------|----------------
# Environments | releases/qa | releases/qa
# Apps | releases/app1_qa | releases/app1/qa
# Versions | releases/app1_v2_qa | releases/app1/v2/qa
#
# The delimiter between the release name path elements can be almost anything
# and it should work equally well with the release name list filter, but in
# many ways the structured paths provide a clearer picture of the
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
}</pre>
</div>
</body></html>
|
