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.rulesets.html">rulesets</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 `Ruleset` from `Source`. The `Ruleset` is given a unique generated name which is returned to the caller. `Source` containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of `Source` issues, use TestRuleset.</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 `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail.</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 `Ruleset` by name including the full `Source` contents.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. The full `Source` contents of a `Ruleset` may be retrieved with GetRuleset.</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<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(name, body=None, x__xgafv=None)</code> 103 <pre>Create a `Ruleset` from `Source`. The `Ruleset` is given a unique generated name which is returned to the caller. `Source` containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of `Source` issues, use TestRuleset. 104 105Args: 106 name: string, Required. Resource name for Project which owns this `Ruleset`. Format: `projects/{project_id}` (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time. 111 "createTime": "A String", # Output only. Time the `Ruleset` was created. 112 "metadata": { # Metadata for a Ruleset. # Output only. The metadata for this ruleset. 113 "services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these. 114 "A String", 115 ], 116 }, 117 "name": "A String", # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` 118 "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`. 119 "files": [ # `File` set constituting the `Source` bundle. 120 { # `File` containing source content. 121 "content": "A String", # Textual Content. 122 "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`. 123 "name": "A String", # File name. 124 }, 125 ], 126 }, 127} 128 129 x__xgafv: string, V1 error format. 130 Allowed values 131 1 - v1 error format 132 2 - v2 error format 133 134Returns: 135 An object of the form: 136 137 { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time. 138 "createTime": "A String", # Output only. Time the `Ruleset` was created. 139 "metadata": { # Metadata for a Ruleset. # Output only. The metadata for this ruleset. 140 "services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these. 141 "A String", 142 ], 143 }, 144 "name": "A String", # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` 145 "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`. 146 "files": [ # `File` set constituting the `Source` bundle. 147 { # `File` containing source content. 148 "content": "A String", # Textual Content. 149 "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`. 150 "name": "A String", # File name. 151 }, 152 ], 153 }, 154}</pre> 155</div> 156 157<div class="method"> 158 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 159 <pre>Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail. 160 161Args: 162 name: string, Required. Resource name for the ruleset to delete. Format: `projects/{project_id}/rulesets/{ruleset_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 { # 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 `{}`. 172}</pre> 173</div> 174 175<div class="method"> 176 <code class="details" id="get">get(name, x__xgafv=None)</code> 177 <pre>Get a `Ruleset` by name including the full `Source` contents. 178 179Args: 180 name: string, Required. Resource name for the ruleset to get. Format: `projects/{project_id}/rulesets/{ruleset_id}` (required) 181 x__xgafv: string, V1 error format. 182 Allowed values 183 1 - v1 error format 184 2 - v2 error format 185 186Returns: 187 An object of the form: 188 189 { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time. 190 "createTime": "A String", # Output only. Time the `Ruleset` was created. 191 "metadata": { # Metadata for a Ruleset. # Output only. The metadata for this ruleset. 192 "services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these. 193 "A String", 194 ], 195 }, 196 "name": "A String", # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` 197 "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`. 198 "files": [ # `File` set constituting the `Source` bundle. 199 { # `File` containing source content. 200 "content": "A String", # Textual Content. 201 "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`. 202 "name": "A String", # File name. 203 }, 204 ], 205 }, 206}</pre> 207</div> 208 209<div class="method"> 210 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 211 <pre>List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. The full `Source` contents of a `Ruleset` may be retrieved with GetRuleset. 212 213Args: 214 name: string, Required. Resource name for the project. Format: `projects/{project_id}` (required) 215 filter: string, `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*` 216 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. 217 pageToken: string, Next page token for loading the next batch of `Ruleset` instances. 218 x__xgafv: string, V1 error format. 219 Allowed values 220 1 - v1 error format 221 2 - v2 error format 222 223Returns: 224 An object of the form: 225 226 { # The response for FirebaseRulesService.ListRulesets. 227 "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain. 228 "rulesets": [ # List of `Ruleset` instances. 229 { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time. 230 "createTime": "A String", # Output only. Time the `Ruleset` was created. 231 "metadata": { # Metadata for a Ruleset. # Output only. The metadata for this ruleset. 232 "services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these. 233 "A String", 234 ], 235 }, 236 "name": "A String", # Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` 237 "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`. 238 "files": [ # `File` set constituting the `Source` bundle. 239 { # `File` containing source content. 240 "content": "A String", # Textual Content. 241 "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`. 242 "name": "A String", # File name. 243 }, 244 ], 245 }, 246 }, 247 ], 248}</pre> 249</div> 250 251<div class="method"> 252 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 253 <pre>Retrieves the next page of results. 254 255Args: 256 previous_request: The request for the previous page. (required) 257 previous_response: The response from the request for the previous page. (required) 258 259Returns: 260 A request object that you can call 'execute()' on to request the next 261 page. Returns None if there are no more items in the collection. 262 </pre> 263</div> 264 265</body></html>