Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / firebaserules_v1.projects.releases.html
blob: 5f2be179ba5b78479e2fd963c9d4b0ba2d6350db [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]79<p class="firstline">Create a `Release`.</p>
80<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]82<p class="firstline">Delete a `Release` by resource name.</p>
83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]85<p class="firstline">Get a `Release` by name.</p>
86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]90 <code><a href="#list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Update a `Release` via PATCH.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100 <code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]101 <pre>Create a `Release`.
102
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]103Release names should reflect the developer&#x27;s deployment practices. For
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]109More than one `Release` may be &#x27;live&#x27; concurrently. Consider the following
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]122updated using the UpdateRelease method.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]123
124Args:
125 name: string, Resource name for the project which owns this `Release`.
126
127Format: `projects/{project_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]128 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]129 The object takes the form of:
130
131{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]133 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]134 # Output only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]135 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated.
136 # Output only.
137 &quot;name&quot;: &quot;A String&quot;, # Resource name for the `Release`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]161 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
162 # exist the `Release` to be created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163}
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]174 # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]175 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 # Output only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]177 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated.
178 # Output only.
179 &quot;name&quot;: &quot;A String&quot;, # Resource name for the `Release`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]203 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
204 # exist the `Release` to be created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]206</div>
207
208<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]209 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]237 <code class="details" id="get">get(name, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]238 <pre>Get a `Release` by name.
239
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]240Args:
241 name: string, Resource name of the `Release`.
242
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253 # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]254 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 # Output only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]256 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated.
257 # Output only.
258 &quot;name&quot;: &quot;A String&quot;, # Resource name for the `Release`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]282 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
283 # exist the `Release` to be created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]285</div>
286
287<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]306 &quot;syncTime&quot;: &quot;A String&quot;, # Optional, indicates the freshness of the result. The response is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 # guaranteed to be the latest within an interval up to the
308 # sync_time (inclusive).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]309 &quot;executable&quot;: &quot;A String&quot;, # Executable view of the `Ruleset` referenced by the `Release`.
310 &quot;language&quot;: &quot;A String&quot;, # `Language` used to generate the executable bytes.
311 &quot;executableVersion&quot;: &quot;A String&quot;, # The Rules runtime version of the executable.
312 &quot;updateTime&quot;: &quot;A String&quot;, # Timestamp for the most recent `Release.update_time`.
313 &quot;rulesetName&quot;: &quot;A String&quot;, # `Ruleset` name associated with the `Release` executable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314 }</pre>
315</div>
316
317<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]318 <code class="details" id="list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]319 <pre>List the `Release` values for a project. This list may optionally be
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]320filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any
321combination thereof.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]322
323Args:
324 name: string, Resource name for the project.
325
326Format: `projects/{project_id}` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]327 filter: string, `Release` filter. The list method supports filters with restrictions on the
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]328`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]329
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]330Example 1: A filter of &#x27;name=prod*&#x27; might return `Release`s with names
331within &#x27;projects/foo&#x27; prefixed with &#x27;prod&#x27;:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]332
333Name | Ruleset Name
334------------------------------|-------------
335projects/foo/releases/prod | projects/foo/rulesets/uuid1234
336projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234
337projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888
338
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]339Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]340`Release` instances for &#x27;projects/foo&#x27; with names prefixed with &#x27;prod&#x27;
341referring to the same `Ruleset` name of &#x27;uuid1234&#x27;:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]342
343Name | Ruleset Name
344------------------------------|-------------
345projects/foo/releases/prod | projects/foo/rulesets/1234
346projects/foo/releases/prod/v1 | projects/foo/rulesets/1234
347
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]348In the examples, the filter parameters refer to the search filters are
349relative to the project. Fully qualified prefixed may also be used. e.g.
350`test_suite_name=projects/foo/testsuites/uuid1`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]351 pageToken: string, Next page token for the next batch of `Release` instances.
352 pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
353Note: `page_size` is just a hint and the service may choose to load fewer
354than `page_size` results due to the size of the output. To traverse all of
355the releases, the caller should iterate until the `page_token` on the
356response is empty.
357 x__xgafv: string, V1 error format.
358 Allowed values
359 1 - v1 error format
360 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]361
362Returns:
363 An object of the form:
364
365 { # The response for FirebaseRulesService.ListReleases.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]366 &quot;releases&quot;: [ # List of `Release` instances.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]367 { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]368 # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]369 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 # Output only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]371 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated.
372 # Output only.
373 &quot;name&quot;: &quot;A String&quot;, # Resource name for the `Release`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]374 #
375 # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
376 # which affords developers a great deal of flexibility in mapping the name
377 # to the style that best fits their existing development practices. For
378 # example, a name could refer to an environment, an app, a version, or some
379 # combination of three.
380 #
381 # In the table below, for the project name `projects/foo`, the following
382 # relative release paths show how flat and structured names might be chosen
383 # to match a desired development / deployment strategy.
384 #
385 # Use Case | Flat Name | Structured Name
386 # -------------|---------------------|----------------
387 # Environments | releases/qa | releases/qa
388 # Apps | releases/app1_qa | releases/app1/qa
389 # Versions | releases/app1_v2_qa | releases/app1/v2/qa
390 #
391 # The delimiter between the release name path elements can be almost anything
392 # and it should work equally well with the release name list filter, but in
393 # many ways the structured paths provide a clearer picture of the
394 # relationship between `Release` instances.
395 #
396 # Format: `projects/{project_id}/releases/{release_id}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]397 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
398 # exist the `Release` to be created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]400 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]401 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token to retrieve the next page of results. If the value is
402 # empty, no further results remain.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]415 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]416 page. Returns None if there are no more items in the collection.
417 </pre>
418</div>
419
420<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]421 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]422 <pre>Update a `Release` via PATCH.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]423
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]427
428Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]429 name: string, Resource name for the project which owns this `Release`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]430
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431Format: `projects/{project_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]432 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]433 The object takes the form of:
434
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]435{ # The request for FirebaseRulesService.UpdateReleasePatch.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]436 &quot;updateMask&quot;: &quot;A String&quot;, # Specifies which fields to update.
437 &quot;release&quot;: { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a # `Release` to update.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]438 # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]439 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]440 # Output only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]441 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated.
442 # Output only.
443 &quot;name&quot;: &quot;A String&quot;, # Resource name for the `Release`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]444 #
445 # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
446 # which affords developers a great deal of flexibility in mapping the name
447 # to the style that best fits their existing development practices. For
448 # example, a name could refer to an environment, an app, a version, or some
449 # combination of three.
450 #
451 # In the table below, for the project name `projects/foo`, the following
452 # relative release paths show how flat and structured names might be chosen
453 # to match a desired development / deployment strategy.
454 #
455 # Use Case | Flat Name | Structured Name
456 # -------------|---------------------|----------------
457 # Environments | releases/qa | releases/qa
458 # Apps | releases/app1_qa | releases/app1/qa
459 # Versions | releases/app1_v2_qa | releases/app1/v2/qa
460 #
461 # The delimiter between the release name path elements can be almost anything
462 # and it should work equally well with the release name list filter, but in
463 # many ways the structured paths provide a clearer picture of the
464 # relationship between `Release` instances.
465 #
466 # Format: `projects/{project_id}/releases/{release_id}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]467 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
468 # exist the `Release` to be created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]482 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483 # Output only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]484 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated.
485 # Output only.
486 &quot;name&quot;: &quot;A String&quot;, # Resource name for the `Release`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]510 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
511 # exist the `Release` to be created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]512 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]513</div>
514
515</body></html>