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> . <a href="firebasehosting_v1beta1.projects.sites.domains.html">domains</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(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a domain mapping on the specified site.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes the existing domain mapping on the specified site.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets a domain mapping on the specified site.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the domains for the specified site.</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<p class="toc_element"> 96 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates the specified domain mapping, creating the mapping as if it does not exist.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 106 <pre>Creates a domain mapping on the specified site. 107 108Args: 109 parent: string, Required. The parent to create the domain association for, in the format: sites/site-name (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # The intended behavior and status information of a domain. 114 "domainName": "A String", # Required. The domain name of the association. 115 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters. 116 "domainName": "A String", # Required. The domain name to redirect to. 117 "type": "A String", # Required. The redirect status code. 118 }, 119 "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain. 120 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. 121 "A String", 122 ], 123 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. 124 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. 125 "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. 126 }, 127 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. 128 "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. 129 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. 130 }, 131 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. 132 "discoveredIps": [ # The IPs found at the last DNS fetch. 133 "A String", 134 ], 135 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. 136 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. 137 "expectedIps": [ # The list of IPs to which the domain is expected to resolve. 138 "A String", 139 ], 140 }, 141 "site": "A String", # Required. The site name of the association. 142 "status": "A String", # Output only. Additional status of the domain association. 143 "updateTime": "A String", # Output only. The time at which the domain was last updated. 144} 145 146 x__xgafv: string, V1 error format. 147 Allowed values 148 1 - v1 error format 149 2 - v2 error format 150 151Returns: 152 An object of the form: 153 154 { # The intended behavior and status information of a domain. 155 "domainName": "A String", # Required. The domain name of the association. 156 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters. 157 "domainName": "A String", # Required. The domain name to redirect to. 158 "type": "A String", # Required. The redirect status code. 159 }, 160 "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain. 161 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. 162 "A String", 163 ], 164 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. 165 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. 166 "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. 167 }, 168 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. 169 "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. 170 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. 171 }, 172 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. 173 "discoveredIps": [ # The IPs found at the last DNS fetch. 174 "A String", 175 ], 176 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. 177 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. 178 "expectedIps": [ # The list of IPs to which the domain is expected to resolve. 179 "A String", 180 ], 181 }, 182 "site": "A String", # Required. The site name of the association. 183 "status": "A String", # Output only. Additional status of the domain association. 184 "updateTime": "A String", # Output only. The time at which the domain was last updated. 185}</pre> 186</div> 187 188<div class="method"> 189 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 190 <pre>Deletes the existing domain mapping on the specified site. 191 192Args: 193 name: string, Required. The name of the domain association to delete. (required) 194 x__xgafv: string, V1 error format. 195 Allowed values 196 1 - v1 error format 197 2 - v2 error format 198 199Returns: 200 An object of the form: 201 202 { # 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 `{}`. 203}</pre> 204</div> 205 206<div class="method"> 207 <code class="details" id="get">get(name, x__xgafv=None)</code> 208 <pre>Gets a domain mapping on the specified site. 209 210Args: 211 name: string, Required. The name of the domain configuration to get. (required) 212 x__xgafv: string, V1 error format. 213 Allowed values 214 1 - v1 error format 215 2 - v2 error format 216 217Returns: 218 An object of the form: 219 220 { # The intended behavior and status information of a domain. 221 "domainName": "A String", # Required. The domain name of the association. 222 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters. 223 "domainName": "A String", # Required. The domain name to redirect to. 224 "type": "A String", # Required. The redirect status code. 225 }, 226 "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain. 227 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. 228 "A String", 229 ], 230 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. 231 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. 232 "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. 233 }, 234 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. 235 "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. 236 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. 237 }, 238 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. 239 "discoveredIps": [ # The IPs found at the last DNS fetch. 240 "A String", 241 ], 242 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. 243 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. 244 "expectedIps": [ # The list of IPs to which the domain is expected to resolve. 245 "A String", 246 ], 247 }, 248 "site": "A String", # Required. The site name of the association. 249 "status": "A String", # Output only. Additional status of the domain association. 250 "updateTime": "A String", # Output only. The time at which the domain was last updated. 251}</pre> 252</div> 253 254<div class="method"> 255 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 256 <pre>Lists the domains for the specified site. 257 258Args: 259 parent: string, Required. The parent for which to list domains, in the format: sites/ site-name (required) 260 pageSize: integer, The page size to return. Defaults to 50. 261 pageToken: string, The next_page_token from a previous request, if provided. 262 x__xgafv: string, V1 error format. 263 Allowed values 264 1 - v1 error format 265 2 - v2 error format 266 267Returns: 268 An object of the form: 269 270 { # The response to listing Domains. 271 "domains": [ # The list of domains, if any exist. 272 { # The intended behavior and status information of a domain. 273 "domainName": "A String", # Required. The domain name of the association. 274 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters. 275 "domainName": "A String", # Required. The domain name to redirect to. 276 "type": "A String", # Required. The redirect status code. 277 }, 278 "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain. 279 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. 280 "A String", 281 ], 282 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. 283 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. 284 "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. 285 }, 286 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. 287 "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. 288 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. 289 }, 290 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. 291 "discoveredIps": [ # The IPs found at the last DNS fetch. 292 "A String", 293 ], 294 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. 295 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. 296 "expectedIps": [ # The list of IPs to which the domain is expected to resolve. 297 "A String", 298 ], 299 }, 300 "site": "A String", # Required. The site name of the association. 301 "status": "A String", # Output only. Additional status of the domain association. 302 "updateTime": "A String", # Output only. The time at which the domain was last updated. 303 }, 304 ], 305 "nextPageToken": "A String", # The pagination token, if more results exist. 306}</pre> 307</div> 308 309<div class="method"> 310 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 311 <pre>Retrieves the next page of results. 312 313Args: 314 previous_request: The request for the previous page. (required) 315 previous_response: The response from the request for the previous page. (required) 316 317Returns: 318 A request object that you can call 'execute()' on to request the next 319 page. Returns None if there are no more items in the collection. 320 </pre> 321</div> 322 323<div class="method"> 324 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> 325 <pre>Updates the specified domain mapping, creating the mapping as if it does not exist. 326 327Args: 328 name: string, Required. The name of the domain association to update or create, if an association doesn't already exist. (required) 329 body: object, The request body. 330 The object takes the form of: 331 332{ # The intended behavior and status information of a domain. 333 "domainName": "A String", # Required. The domain name of the association. 334 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters. 335 "domainName": "A String", # Required. The domain name to redirect to. 336 "type": "A String", # Required. The redirect status code. 337 }, 338 "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain. 339 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. 340 "A String", 341 ], 342 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. 343 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. 344 "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. 345 }, 346 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. 347 "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. 348 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. 349 }, 350 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. 351 "discoveredIps": [ # The IPs found at the last DNS fetch. 352 "A String", 353 ], 354 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. 355 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. 356 "expectedIps": [ # The list of IPs to which the domain is expected to resolve. 357 "A String", 358 ], 359 }, 360 "site": "A String", # Required. The site name of the association. 361 "status": "A String", # Output only. Additional status of the domain association. 362 "updateTime": "A String", # Output only. The time at which the domain was last updated. 363} 364 365 x__xgafv: string, V1 error format. 366 Allowed values 367 1 - v1 error format 368 2 - v2 error format 369 370Returns: 371 An object of the form: 372 373 { # The intended behavior and status information of a domain. 374 "domainName": "A String", # Required. The domain name of the association. 375 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters. 376 "domainName": "A String", # Required. The domain name to redirect to. 377 "type": "A String", # Required. The redirect status code. 378 }, 379 "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain. 380 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. 381 "A String", 382 ], 383 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. 384 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. 385 "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. 386 }, 387 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. 388 "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. 389 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. 390 }, 391 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. 392 "discoveredIps": [ # The IPs found at the last DNS fetch. 393 "A String", 394 ], 395 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. 396 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. 397 "expectedIps": [ # The list of IPs to which the domain is expected to resolve. 398 "A String", 399 ], 400 }, 401 "site": "A String", # Required. The site name of the association. 402 "status": "A String", # Output only. Additional status of the domain association. 403 "updateTime": "A String", # Output only. The time at which the domain was last updated. 404}</pre> 405</div> 406 407</body></html>