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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p> 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 relationships reflect a `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> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Delete a `Release` by resource name.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Get a `Release` by name.</p> 89<p class="toc_element"> 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"> 93 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 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> 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"> 99 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Update a `Release` via PATCH. Only updates to `ruleset_name` will be honored. `Release` rename is not supported. To create a `Release` use the CreateRelease method.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="create">create(name, body=None, x__xgafv=None)</code> 109 <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 relationships reflect a `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. 110 111Args: 112 name: string, Required. Resource name for the project which owns this `Release`. Format: `projects/{project_id}` (required) 113 body: object, The request body. 114 The object takes the form of: 115 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 "createTime": "A String", # Output only. Time the release was created. 118 "name": "A String", # Format: `projects/{project_id}/releases/{release_id}` 119 "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created. 120 "updateTime": "A String", # Output only. Time the release was updated. 121} 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 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 "createTime": "A String", # Output only. Time the release was created. 133 "name": "A String", # Format: `projects/{project_id}/releases/{release_id}` 134 "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created. 135 "updateTime": "A String", # Output only. Time the release was updated. 136}</pre> 137</div> 138 139<div class="method"> 140 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 141 <pre>Delete a `Release` by resource name. 142 143Args: 144 name: string, Required. Resource name for the `Release` to delete. Format: `projects/{project_id}/releases/{release_id}` (required) 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 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 `{}`. 154}</pre> 155</div> 156 157<div class="method"> 158 <code class="details" id="get">get(name, x__xgafv=None)</code> 159 <pre>Get a `Release` by name. 160 161Args: 162 name: string, Required. Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_id}` (required) 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 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 "createTime": "A String", # Output only. Time the release was created. 173 "name": "A String", # Format: `projects/{project_id}/releases/{release_id}` 174 "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created. 175 "updateTime": "A String", # Output only. Time the release was updated. 176}</pre> 177</div> 178 179<div class="method"> 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: 184 name: string, Required. 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 'rules2' executable versions: Custom AST for use with Java clients. 189 FIREBASE_RULES_EXECUTABLE_V2 - CEL-based executable for use with C++ clients. 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 199 "executable": "A String", # Executable view of the `Ruleset` referenced by the `Release`. 200 "executableVersion": "A String", # The Rules runtime version of the executable. 201 "language": "A String", # `Language` used to generate the executable bytes. 202 "rulesetName": "A String", # `Ruleset` name associated with the `Release` executable. 203 "syncTime": "A String", # Optional, indicates the freshness of the result. The response is guaranteed to be the latest within an interval up to the sync_time (inclusive). 204 "updateTime": "A String", # Timestamp for the most recent `Release.update_time`. 205}</pre> 206</div> 207 208<div class="method"> 209 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 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. 211 212Args: 213 name: string, Required. Resource name for the project. Format: `projects/{project_id}` (required) 214 filter: string, `Release` filter. The list method supports filters with restrictions on the `Release.name`, and `Release.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 are relative to the project. Fully qualified prefixed may also be used. 215 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. 216 pageToken: string, Next page token for the next batch of `Release` instances. 217 x__xgafv: string, V1 error format. 218 Allowed values 219 1 - v1 error format 220 2 - v2 error format 221 222Returns: 223 An object of the form: 224 225 { # The response for FirebaseRulesService.ListReleases. 226 "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain. 227 "releases": [ # List of `Release` instances. 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 "createTime": "A String", # Output only. Time the release was created. 230 "name": "A String", # Format: `projects/{project_id}/releases/{release_id}` 231 "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created. 232 "updateTime": "A String", # Output only. Time the release was updated. 233 }, 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: 247 A request object that you can call 'execute()' on to request the next 248 page. Returns None if there are no more items in the collection. 249 </pre> 250</div> 251 252<div class="method"> 253 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code> 254 <pre>Update a `Release` via PATCH. Only updates to `ruleset_name` will be honored. `Release` rename is not supported. To create a `Release` use the CreateRelease method. 255 256Args: 257 name: string, Required. Resource name for the project which owns this `Release`. Format: `projects/{project_id}` (required) 258 body: object, The request body. 259 The object takes the form of: 260 261{ # The request for FirebaseRulesService.UpdateRelease. 262 "release": { # `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. 263 "createTime": "A String", # Output only. Time the release was created. 264 "name": "A String", # Format: `projects/{project_id}/releases/{release_id}` 265 "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created. 266 "updateTime": "A String", # Output only. Time the release was updated. 267 }, 268 "updateMask": "A String", # Specifies which fields to update. 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 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 "createTime": "A String", # Output only. Time the release was created. 281 "name": "A String", # Format: `projects/{project_id}/releases/{release_id}` 282 "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created. 283 "updateTime": "A String", # Output only. Time the release was updated. 284}</pre> 285</div> 286 287</body></html>