| yoshi-code-bot | 4c9ccb0 | 2021-05-27 00:38:02 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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="firebaseappcheck_v1beta.html">Firebase App Check API</a> . <a href="firebaseappcheck_v1beta.projects.html">projects</a> . <a href="firebaseappcheck_v1beta.projects.services.html">services</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Updates the specified Service configurations atomically.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#close">close()</a></code></p> |
| 82 | <p class="firstline">Close httplib2 connections.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Gets the Service configuration for the specified service name.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Lists all Service configurations for the specified project. Only Services which were explicitly configured using UpdateService or BatchUpdateServices will be returned.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Updates the specified Service configuration.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| 97 | <code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code> |
| 98 | <pre>Updates the specified Service configurations atomically. |
| 99 | |
| 100 | Args: |
| 101 | parent: string, Required. The parent project name shared by all Service configurations being updated, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails. (required) |
| 102 | body: object, The request body. |
| 103 | The object takes the form of: |
| 104 | |
| 105 | { # Request message for the BatchUpdateServices method. |
| 106 | "requests": [ # Required. The request messages specifying the Services to update. A maximum of 100 objects can be updated in a batch. |
| 107 | { # Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method. |
| 108 | "service": { # The enforcement configuration for a Firebase service supported by App Check. # Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) |
| 109 | "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. |
| 110 | "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) |
| 111 | }, |
| 112 | "updateMask": "A String", # Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`. |
| 113 | }, |
| 114 | ], |
| 115 | "updateMask": "A String", # Optional. A comma-separated list of names of fields in the Services to update. Example: `display_name`. If this field is present, the `update_mask` field in the UpdateServiceRequest messages must all match this field, or the entire batch fails and no updates will be committed. |
| 116 | } |
| 117 | |
| 118 | x__xgafv: string, V1 error format. |
| 119 | Allowed values |
| 120 | 1 - v1 error format |
| 121 | 2 - v2 error format |
| 122 | |
| 123 | Returns: |
| 124 | An object of the form: |
| 125 | |
| 126 | { # Response message for the BatchUpdateServices method. |
| 127 | "services": [ # Service objects after the updates have been applied. |
| 128 | { # The enforcement configuration for a Firebase service supported by App Check. |
| 129 | "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. |
| 130 | "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) |
| 131 | }, |
| 132 | ], |
| 133 | }</pre> |
| 134 | </div> |
| 135 | |
| 136 | <div class="method"> |
| 137 | <code class="details" id="close">close()</code> |
| 138 | <pre>Close httplib2 connections.</pre> |
| 139 | </div> |
| 140 | |
| 141 | <div class="method"> |
| 142 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 143 | <pre>Gets the Service configuration for the specified service name. |
| 144 | |
| 145 | Args: |
| 146 | name: string, Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) (required) |
| 147 | x__xgafv: string, V1 error format. |
| 148 | Allowed values |
| 149 | 1 - v1 error format |
| 150 | 2 - v2 error format |
| 151 | |
| 152 | Returns: |
| 153 | An object of the form: |
| 154 | |
| 155 | { # The enforcement configuration for a Firebase service supported by App Check. |
| 156 | "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. |
| 157 | "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) |
| 158 | }</pre> |
| 159 | </div> |
| 160 | |
| 161 | <div class="method"> |
| 162 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 163 | <pre>Lists all Service configurations for the specified project. Only Services which were explicitly configured using UpdateService or BatchUpdateServices will be returned. |
| 164 | |
| 165 | Args: |
| 166 | parent: string, Required. The relative resource name of the parent project for which to list each associated Service, in the format: ``` projects/{project_number} ``` (required) |
| 167 | pageSize: integer, The maximum number of Services to return in the response. Only explicitly configured services are returned. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. |
| 168 | pageToken: string, Token returned from a previous call to ListServices indicating where in the set of Services to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListServices must match the call that provided the page token; if they do not match, the result is undefined. |
| 169 | x__xgafv: string, V1 error format. |
| 170 | Allowed values |
| 171 | 1 - v1 error format |
| 172 | 2 - v2 error format |
| 173 | |
| 174 | Returns: |
| 175 | An object of the form: |
| 176 | |
| 177 | { # Response message for the ListServices method. |
| 178 | "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListServices to find the next group of Services. Page tokens are short-lived and should not be persisted. |
| 179 | "services": [ # The Services retrieved. |
| 180 | { # The enforcement configuration for a Firebase service supported by App Check. |
| 181 | "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. |
| 182 | "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) |
| 183 | }, |
| 184 | ], |
| 185 | }</pre> |
| 186 | </div> |
| 187 | |
| 188 | <div class="method"> |
| 189 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 190 | <pre>Retrieves the next page of results. |
| 191 | |
| 192 | Args: |
| 193 | previous_request: The request for the previous page. (required) |
| 194 | previous_response: The response from the request for the previous page. (required) |
| 195 | |
| 196 | Returns: |
| 197 | A request object that you can call 'execute()' on to request the next |
| 198 | page. Returns None if there are no more items in the collection. |
| 199 | </pre> |
| 200 | </div> |
| 201 | |
| 202 | <div class="method"> |
| 203 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 204 | <pre>Updates the specified Service configuration. |
| 205 | |
| 206 | Args: |
| 207 | name: string, Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) (required) |
| 208 | body: object, The request body. |
| 209 | The object takes the form of: |
| 210 | |
| 211 | { # The enforcement configuration for a Firebase service supported by App Check. |
| 212 | "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. |
| 213 | "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) |
| 214 | } |
| 215 | |
| 216 | updateMask: string, Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`. |
| 217 | x__xgafv: string, V1 error format. |
| 218 | Allowed values |
| 219 | 1 - v1 error format |
| 220 | 2 - v2 error format |
| 221 | |
| 222 | Returns: |
| 223 | An object of the form: |
| 224 | |
| 225 | { # The enforcement configuration for a Firebase service supported by App Check. |
| 226 | "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. |
| 227 | "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) |
| 228 | }</pre> |
| 229 | </div> |
| 230 | |
| 231 | </body></html> |