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="firebasehosting_v1beta1.html">Firebase Hosting API</a> . <a href="firebasehosting_v1beta1.projects.html">projects</a> . <a href="firebasehosting_v1beta1.projects.sites.html">sites</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="firebasehosting_v1beta1.projects.sites.channels.html">channels()</a></code> 79</p> 80<p class="firstline">Returns the channels Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="firebasehosting_v1beta1.projects.sites.domains.html">domains()</a></code> 84</p> 85<p class="firstline">Returns the domains Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="firebasehosting_v1beta1.projects.sites.releases.html">releases()</a></code> 89</p> 90<p class="firstline">Returns the releases Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="firebasehosting_v1beta1.projects.sites.versions.html">versions()</a></code> 94</p> 95<p class="firstline">Returns the versions Resource.</p> 96 97<p class="toc_element"> 98 <code><a href="#close">close()</a></code></p> 99<p class="firstline">Close httplib2 connections.</p> 100<p class="toc_element"> 101 <code><a href="#create">create(parent, body=None, siteId=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Creates a new Hosting Site in the specified parent Firebase project. Note that Hosting sites can take several minutes to propagate through Firebase systems.</p> 103<p class="toc_element"> 104 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 105<p class="firstline">Deletes the specified Hosting Site from the specified parent Firebase project.</p> 106<p class="toc_element"> 107 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 108<p class="firstline">Gets the specified Hosting Site.</p> 109<p class="toc_element"> 110 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p> 111<p class="firstline">Gets the Hosting metadata for a specific site.</p> 112<p class="toc_element"> 113 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 114<p class="firstline">Lists each Hosting Site associated with the specified parent Firebase project.</p> 115<p class="toc_element"> 116 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 117<p class="firstline">Retrieves the next page of results.</p> 118<p class="toc_element"> 119 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 120<p class="firstline">Updates attributes of the specified Hosting Site.</p> 121<p class="toc_element"> 122 <code><a href="#updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 123<p class="firstline">Sets the Hosting metadata for a specific site.</p> 124<h3>Method Details</h3> 125<div class="method"> 126 <code class="details" id="close">close()</code> 127 <pre>Close httplib2 connections.</pre> 128</div> 129 130<div class="method"> 131 <code class="details" id="create">create(parent, body=None, siteId=None, x__xgafv=None)</code> 132 <pre>Creates a new Hosting Site in the specified parent Firebase project. Note that Hosting sites can take several minutes to propagate through Firebase systems. 133 134Args: 135 parent: string, Required. The Firebase project in which to create a Hosting site, in the format: projects/PROJECT_IDENTIFIER Refer to the `Site` [`name`](../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required) 136 body: object, The request body. 137 The object takes the form of: 138 139{ # A `Site` represents a Firebase Hosting site. 140 "appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site. 141 "defaultUrl": "A String", # Output only. The default URL for the Hosting site. 142 "labels": { # Optional. User-specified labels for the Hosting site. 143 "a_key": "A String", 144 }, 145 "name": "A String", # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project's [`ProjectNumber`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). 146 "type": "A String", # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`. 147} 148 149 siteId: string, Required. Immutable. A globally unique identifier for the Hosting site. This identifier is used to construct the Firebase-provisioned subdomains for the site, so it must also be a valid domain name label. 150 x__xgafv: string, V1 error format. 151 Allowed values 152 1 - v1 error format 153 2 - v2 error format 154 155Returns: 156 An object of the form: 157 158 { # A `Site` represents a Firebase Hosting site. 159 "appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site. 160 "defaultUrl": "A String", # Output only. The default URL for the Hosting site. 161 "labels": { # Optional. User-specified labels for the Hosting site. 162 "a_key": "A String", 163 }, 164 "name": "A String", # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project's [`ProjectNumber`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). 165 "type": "A String", # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`. 166}</pre> 167</div> 168 169<div class="method"> 170 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 171 <pre>Deletes the specified Hosting Site from the specified parent Firebase project. 172 173Args: 174 name: string, Required. The fully-qualified resource name for the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to the `Site` [`name`](../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required) 175 x__xgafv: string, V1 error format. 176 Allowed values 177 1 - v1 error format 178 2 - v2 error format 179 180Returns: 181 An object of the form: 182 183 { # 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 `{}`. 184}</pre> 185</div> 186 187<div class="method"> 188 <code class="details" id="get">get(name, x__xgafv=None)</code> 189 <pre>Gets the specified Hosting Site. 190 191Args: 192 name: string, Required. The fully-qualified resource name for the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to the `Site` [`name`](../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIER values. Since a SITE_ID is a globally unique identifier, you can also use the unique sub-collection resource access pattern, in the format: projects/-/sites/SITE_ID (required) 193 x__xgafv: string, V1 error format. 194 Allowed values 195 1 - v1 error format 196 2 - v2 error format 197 198Returns: 199 An object of the form: 200 201 { # A `Site` represents a Firebase Hosting site. 202 "appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site. 203 "defaultUrl": "A String", # Output only. The default URL for the Hosting site. 204 "labels": { # Optional. User-specified labels for the Hosting site. 205 "a_key": "A String", 206 }, 207 "name": "A String", # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project's [`ProjectNumber`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). 208 "type": "A String", # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`. 209}</pre> 210</div> 211 212<div class="method"> 213 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code> 214 <pre>Gets the Hosting metadata for a specific site. 215 216Args: 217 name: string, Required. The site for which to get the SiteConfig, in the format: sites/ site-name/config (required) 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 { # A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior 227 "cloudLoggingEnabled": True or False, # Whether or not web requests made by site visitors are logged via Cloud Logging. 228 "maxVersions": "A String", # The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default. 229}</pre> 230</div> 231 232<div class="method"> 233 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 234 <pre>Lists each Hosting Site associated with the specified parent Firebase project. 235 236Args: 237 parent: string, Required. The Firebase project for which to list sites, in the format: projects/PROJECT_IDENTIFIER Refer to the `Site` [`name`](../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required) 238 pageSize: integer, Optional. The maximum number of sites to return. The service may return a lower number if fewer sites exist than this maximum number. If unspecified, defaults to 40. 239 pageToken: string, Optional. A token from a previous call to `ListSites` that tells the server where to resume listing. 240 x__xgafv: string, V1 error format. 241 Allowed values 242 1 - v1 error format 243 2 - v2 error format 244 245Returns: 246 An object of the form: 247 248 { 249 "nextPageToken": "A String", # The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to `ListSites`. Page tokens are short-lived and should not be stored. 250 "sites": [ # A list of Site objects associated with the specified Firebase project. 251 { # A `Site` represents a Firebase Hosting site. 252 "appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site. 253 "defaultUrl": "A String", # Output only. The default URL for the Hosting site. 254 "labels": { # Optional. User-specified labels for the Hosting site. 255 "a_key": "A String", 256 }, 257 "name": "A String", # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project's [`ProjectNumber`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). 258 "type": "A String", # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`. 259 }, 260 ], 261}</pre> 262</div> 263 264<div class="method"> 265 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 266 <pre>Retrieves the next page of results. 267 268Args: 269 previous_request: The request for the previous page. (required) 270 previous_response: The response from the request for the previous page. (required) 271 272Returns: 273 A request object that you can call 'execute()' on to request the next 274 page. Returns None if there are no more items in the collection. 275 </pre> 276</div> 277 278<div class="method"> 279 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 280 <pre>Updates attributes of the specified Hosting Site. 281 282Args: 283 name: string, Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project's [`ProjectNumber`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). (required) 284 body: object, The request body. 285 The object takes the form of: 286 287{ # A `Site` represents a Firebase Hosting site. 288 "appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site. 289 "defaultUrl": "A String", # Output only. The default URL for the Hosting site. 290 "labels": { # Optional. User-specified labels for the Hosting site. 291 "a_key": "A String", 292 }, 293 "name": "A String", # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project's [`ProjectNumber`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). 294 "type": "A String", # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`. 295} 296 297 updateMask: string, A set of field names from your Site that you want to update. 298 x__xgafv: string, V1 error format. 299 Allowed values 300 1 - v1 error format 301 2 - v2 error format 302 303Returns: 304 An object of the form: 305 306 { # A `Site` represents a Firebase Hosting site. 307 "appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site. 308 "defaultUrl": "A String", # Output only. The default URL for the Hosting site. 309 "labels": { # Optional. User-specified labels for the Hosting site. 310 "a_key": "A String", 311 }, 312 "name": "A String", # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project's [`ProjectNumber`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). 313 "type": "A String", # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`. 314}</pre> 315</div> 316 317<div class="method"> 318 <code class="details" id="updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</code> 319 <pre>Sets the Hosting metadata for a specific site. 320 321Args: 322 name: string, Required. The site for which to update the SiteConfig, in the format: sites/ site-name/config (required) 323 body: object, The request body. 324 The object takes the form of: 325 326{ # A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior 327 "cloudLoggingEnabled": True or False, # Whether or not web requests made by site visitors are logged via Cloud Logging. 328 "maxVersions": "A String", # The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default. 329} 330 331 updateMask: string, A set of field names from your [site configuration](../sites.SiteConfig) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used. 332 x__xgafv: string, V1 error format. 333 Allowed values 334 1 - v1 error format 335 2 - v2 error format 336 337Returns: 338 An object of the form: 339 340 { # A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior 341 "cloudLoggingEnabled": True or False, # Whether or not web requests made by site visitors are logged via Cloud Logging. 342 "maxVersions": "A String", # The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default. 343}</pre> 344</div> 345 346</body></html>