Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0d561ef2b7642e281eb69a81167e45d98d1621a4 / . / docs / dyn / firebaserules_v1.projects.releases.html
blob: d5dbfda97c210303d2987e47803da0c3aedfaf6a [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">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.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]85<p class="firstline">Delete a `Release` by resource name.</p>
86<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]88<p class="firstline">Get a `Release` by name.</p>
89<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90 <code><a href="#getExecutable">getExecutable(name, executableVersion=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Get the `Release` executable to use when enforcing rules.</p>
92<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]93 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94<p class="firstline">List the `Release` values for a project. This list may optionally be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any combination thereof.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100<p class="firstline">Update a `Release` via PATCH. Only updates to the `ruleset_name` and `test_suite_name` fields will be honored. `Release` rename is not supported. To create a `Release` use the CreateRelease method.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]108 <code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109 <pre>Create a `Release`. Release names should reflect the developer&#x27;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 &#x27;live&#x27; 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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]110
111Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112 name: string, Resource name for the project which owns this `Release`. Format: `projects/{project_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]113 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]114 The object takes the form of:
115
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]116{ # `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`.
117 &quot;name&quot;: &quot;A String&quot;, # 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}`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]118 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated. Output only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]119 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created. Output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]120 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]121 }
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]122
123 x__xgafv: string, V1 error format.
124 Allowed values
125 1 - v1 error format
126 2 - v2 error format
127
128Returns:
129 An object of the form:
130
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]131 { # `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`.
132 &quot;name&quot;: &quot;A String&quot;, # 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}`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]133 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated. Output only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]134 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created. Output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]135 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]136 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]137</div>
138
139<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]140 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]141 <pre>Delete a `Release` by resource name.
142
143Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]144 name: string, Resource name for the `Release` to delete. Format: `projects/{project_id}/releases/{release_id}` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
149
150Returns:
151 An object of the form:
152
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]153 { # 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 `{}`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]154 }</pre>
155</div>
156
157<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]158 <code class="details" id="get">get(name, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]159 <pre>Get a `Release` by name.
160
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]161Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]162 name: string, Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_id}` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168Returns:
169 An object of the form:
170
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]171 { # `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`.
172 &quot;name&quot;: &quot;A String&quot;, # 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}`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]173 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated. Output only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]174 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created. Output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]175 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]176 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]177</div>
178
179<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 <code class="details" id="getExecutable">getExecutable(name, executableVersion=None, x__xgafv=None)</code>
181 <pre>Get the `Release` executable to use when enforcing rules.
182
183Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]184 name: string, Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_id}` (required)
185 executableVersion: string, The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1.
186 Allowed values
187 RELEASE_EXECUTABLE_VERSION_UNSPECIFIED - Executable format unspecified. Defaults to FIREBASE_RULES_EXECUTABLE_V1
188 FIREBASE_RULES_EXECUTABLE_V1 - Firebase Rules syntax &#x27;rules2&#x27; executable versions: Custom AST for use with Java clients.
189 FIREBASE_RULES_EXECUTABLE_V2 - CEL-based executable for use with C++ clients.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 x__xgafv: string, V1 error format.
191 Allowed values
192 1 - v1 error format
193 2 - v2 error format
194
195Returns:
196 An object of the form:
197
198 { # The response for FirebaseRulesService.GetReleaseExecutable
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]199 &quot;updateTime&quot;: &quot;A String&quot;, # Timestamp for the most recent `Release.update_time`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]200 &quot;executable&quot;: &quot;A String&quot;, # Executable view of the `Ruleset` referenced by the `Release`.
201 &quot;rulesetName&quot;: &quot;A String&quot;, # `Ruleset` name associated with the `Release` executable.
202 &quot;syncTime&quot;: &quot;A String&quot;, # Optional, indicates the freshness of the result. The response is guaranteed to be the latest within an interval up to the sync_time (inclusive).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]203 &quot;executableVersion&quot;: &quot;A String&quot;, # The Rules runtime version of the executable.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]204 &quot;language&quot;: &quot;A String&quot;, # `Language` used to generate the executable bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 }</pre>
206</div>
207
208<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]209 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]210 <pre>List the `Release` values for a project. This list may optionally be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any combination thereof.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]211
212Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]213 name: string, Resource name for the project. Format: `projects/{project_id}` (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]214 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 fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]215 filter: string, `Release` filter. The list method supports filters with restrictions on the `Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`. Example 1: A filter of &#x27;name=prod*&#x27; might return `Release`s with names within &#x27;projects/foo&#x27; prefixed with &#x27;prod&#x27;: 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 &#x27;projects/foo&#x27; with names prefixed with &#x27;prod&#x27; referring to the same `Ruleset` name of &#x27;uuid1234&#x27;: 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 are relative to the project. Fully qualified prefixed may also be used. e.g. `test_suite_name=projects/foo/testsuites/uuid1`
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]216 pageToken: string, Next page token for the next batch of `Release` instances.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]217 x__xgafv: string, V1 error format.
218 Allowed values
219 1 - v1 error format
220 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]221
222Returns:
223 An object of the form:
224
225 { # The response for FirebaseRulesService.ListReleases.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]226 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]227 &quot;releases&quot;: [ # List of `Release` instances.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]228 { # `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`.
229 &quot;name&quot;: &quot;A String&quot;, # 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}`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]230 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated. Output only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]231 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created. Output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]232 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]233 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]234 ],
235 }</pre>
236</div>
237
238<div class="method">
239 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
240 <pre>Retrieves the next page of results.
241
242Args:
243 previous_request: The request for the previous page. (required)
244 previous_response: The response from the request for the previous page. (required)
245
246Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]247 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]248 page. Returns None if there are no more items in the collection.
249 </pre>
250</div>
251
252<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]253 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]254 <pre>Update a `Release` via PATCH. Only updates to the `ruleset_name` and `test_suite_name` fields will be honored. `Release` rename is not supported. To create a `Release` use the CreateRelease method.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]255
256Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]257 name: string, Resource name for the project which owns this `Release`. Format: `projects/{project_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]258 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]259 The object takes the form of:
260
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]261{ # The request for FirebaseRulesService.UpdateReleasePatch.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]262 &quot;updateMask&quot;: &quot;A String&quot;, # Specifies which fields to update.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]263 &quot;release&quot;: { # `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`. # `Release` to update.
264 &quot;name&quot;: &quot;A String&quot;, # 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}`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]265 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated. Output only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]266 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created. Output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]267 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]268 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 }
270
271 x__xgafv: string, V1 error format.
272 Allowed values
273 1 - v1 error format
274 2 - v2 error format
275
276Returns:
277 An object of the form:
278
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]279 { # `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`.
280 &quot;name&quot;: &quot;A String&quot;, # 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}`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]281 &quot;updateTime&quot;: &quot;A String&quot;, # Time the release was updated. Output only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]282 &quot;createTime&quot;: &quot;A String&quot;, # Time the release was created. Output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]283 &quot;rulesetName&quot;: &quot;A String&quot;, # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]284 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]285</div>
286
287</body></html>