| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -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="firebasehosting_v1beta1.html">Firebase Hosting API</a> . <a href="firebasehosting_v1beta1.sites.html">sites</a> . <a href="firebasehosting_v1beta1.sites.domains.html">domains</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Creates a domain mapping on the specified site.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes the existing domain mapping on the specified site.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Gets a domain mapping on the specified site.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Lists the domains for the specified site.</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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Updates the specified domain mapping, creating the mapping as if it does</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 97 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <pre>Creates a domain mapping on the specified site. |
| 99 | |
| 100 | Args: |
| 101 | parent: string, Required. The parent to create the domain association for, in the format: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <code>sites/<var>site-name</var></code> (required) |
| 103 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 104 | The object takes the form of: |
| 105 | |
| 106 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 107 | "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters. |
| 108 | # the path of the redirect but replace the requested domain with the one |
| 109 | # specified in the redirect configuration. |
| 110 | "domainName": "A String", # Required. The domain name to redirect to. |
| 111 | "type": "A String", # Required. The redirect status code. |
| 112 | }, |
| 113 | "status": "A String", # Output only. Additional status of the domain association. |
| 114 | "site": "A String", # Required. The site name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 115 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 116 | "domainName": "A String", # Required. The domain name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 117 | "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the |
| 118 | # health of the DNS resolution for the domain. |
| 119 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| 120 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 121 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 122 | "token": "A String", # The value that must be present as a TXT record on the domain name to |
| 123 | # satisfy the challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 124 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 125 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting |
| 126 | # provisions an SSL certificate for the domain. |
| 127 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last |
| 128 | # DNS fetch. |
| 129 | "A String", |
| 130 | ], |
| 131 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 132 | "A String", |
| 133 | ], |
| 134 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 135 | "A String", |
| 136 | ], |
| 137 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 138 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 139 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate |
| 140 | # challenge. |
| 141 | "path": "A String", # The URL path on which to serve the specified token to satisfy the |
| 142 | # certificate challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 143 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | }, |
| 145 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 146 | |
| 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 intended behavior and status information of a domain. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 156 | "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters. |
| 157 | # the path of the redirect but replace the requested domain with the one |
| 158 | # specified in the redirect configuration. |
| 159 | "domainName": "A String", # Required. The domain name to redirect to. |
| 160 | "type": "A String", # Required. The redirect status code. |
| 161 | }, |
| 162 | "status": "A String", # Output only. Additional status of the domain association. |
| 163 | "site": "A String", # Required. The site name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 164 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 165 | "domainName": "A String", # Required. The domain name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 166 | "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the |
| 167 | # health of the DNS resolution for the domain. |
| 168 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| 169 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 170 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 171 | "token": "A String", # The value that must be present as a TXT record on the domain name to |
| 172 | # satisfy the challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 173 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 174 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting |
| 175 | # provisions an SSL certificate for the domain. |
| 176 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last |
| 177 | # DNS fetch. |
| 178 | "A String", |
| 179 | ], |
| 180 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 181 | "A String", |
| 182 | ], |
| 183 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 184 | "A String", |
| 185 | ], |
| 186 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 187 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 188 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate |
| 189 | # challenge. |
| 190 | "path": "A String", # The URL path on which to serve the specified token to satisfy the |
| 191 | # certificate challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 192 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 193 | }, |
| 194 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 195 | </div> |
| 196 | |
| 197 | <div class="method"> |
| 198 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 199 | <pre>Deletes the existing domain mapping on the specified site. |
| 200 | |
| 201 | Args: |
| 202 | name: string, Required. The name of the domain association to delete. (required) |
| 203 | x__xgafv: string, V1 error format. |
| 204 | Allowed values |
| 205 | 1 - v1 error format |
| 206 | 2 - v2 error format |
| 207 | |
| 208 | Returns: |
| 209 | An object of the form: |
| 210 | |
| 211 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 212 | # empty messages in your APIs. A typical example is to use it as the request |
| 213 | # or the response type of an API method. For instance: |
| 214 | # |
| 215 | # service Foo { |
| 216 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 217 | # } |
| 218 | # |
| 219 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 220 | }</pre> |
| 221 | </div> |
| 222 | |
| 223 | <div class="method"> |
| 224 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 225 | <pre>Gets a domain mapping on the specified site. |
| 226 | |
| 227 | Args: |
| 228 | name: string, Required. The name of the domain configuration to get. (required) |
| 229 | x__xgafv: string, V1 error format. |
| 230 | Allowed values |
| 231 | 1 - v1 error format |
| 232 | 2 - v2 error format |
| 233 | |
| 234 | Returns: |
| 235 | An object of the form: |
| 236 | |
| 237 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 238 | "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters. |
| 239 | # the path of the redirect but replace the requested domain with the one |
| 240 | # specified in the redirect configuration. |
| 241 | "domainName": "A String", # Required. The domain name to redirect to. |
| 242 | "type": "A String", # Required. The redirect status code. |
| 243 | }, |
| 244 | "status": "A String", # Output only. Additional status of the domain association. |
| 245 | "site": "A String", # Required. The site name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 246 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 247 | "domainName": "A String", # Required. The domain name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 248 | "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the |
| 249 | # health of the DNS resolution for the domain. |
| 250 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| 251 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 252 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 253 | "token": "A String", # The value that must be present as a TXT record on the domain name to |
| 254 | # satisfy the challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 255 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 256 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting |
| 257 | # provisions an SSL certificate for the domain. |
| 258 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last |
| 259 | # DNS fetch. |
| 260 | "A String", |
| 261 | ], |
| 262 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 263 | "A String", |
| 264 | ], |
| 265 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 266 | "A String", |
| 267 | ], |
| 268 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 269 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 270 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate |
| 271 | # challenge. |
| 272 | "path": "A String", # The URL path on which to serve the specified token to satisfy the |
| 273 | # certificate challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 274 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 275 | }, |
| 276 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 277 | </div> |
| 278 | |
| 279 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 280 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 281 | <pre>Lists the domains for the specified site. |
| 282 | |
| 283 | Args: |
| 284 | parent: string, Required. The parent for which to list domains, in the format: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 285 | <code>sites/<var>site-name</var></code> (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 286 | pageToken: string, The next_page_token from a previous request, if provided. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 287 | pageSize: integer, The page size to return. Defaults to 50. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 288 | x__xgafv: string, V1 error format. |
| 289 | Allowed values |
| 290 | 1 - v1 error format |
| 291 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 292 | |
| 293 | Returns: |
| 294 | An object of the form: |
| 295 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 296 | { # The response to listing Domains. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 297 | "domains": [ # The list of domains, if any exist. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 298 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 299 | "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters. |
| 300 | # the path of the redirect but replace the requested domain with the one |
| 301 | # specified in the redirect configuration. |
| 302 | "domainName": "A String", # Required. The domain name to redirect to. |
| 303 | "type": "A String", # Required. The redirect status code. |
| 304 | }, |
| 305 | "status": "A String", # Output only. Additional status of the domain association. |
| 306 | "site": "A String", # Required. The site name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 308 | "domainName": "A String", # Required. The domain name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 309 | "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the |
| 310 | # health of the DNS resolution for the domain. |
| 311 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| 312 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 313 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 314 | "token": "A String", # The value that must be present as a TXT record on the domain name to |
| 315 | # satisfy the challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 316 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 317 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting |
| 318 | # provisions an SSL certificate for the domain. |
| 319 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last |
| 320 | # DNS fetch. |
| 321 | "A String", |
| 322 | ], |
| 323 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 324 | "A String", |
| 325 | ], |
| 326 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 327 | "A String", |
| 328 | ], |
| 329 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 330 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 331 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate |
| 332 | # challenge. |
| 333 | "path": "A String", # The URL path on which to serve the specified token to satisfy the |
| 334 | # certificate challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 335 | }, |
| 336 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 337 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 338 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 339 | "nextPageToken": "A String", # The pagination token, if more results exist. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 340 | }</pre> |
| 341 | </div> |
| 342 | |
| 343 | <div class="method"> |
| 344 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 345 | <pre>Retrieves the next page of results. |
| 346 | |
| 347 | Args: |
| 348 | previous_request: The request for the previous page. (required) |
| 349 | previous_response: The response from the request for the previous page. (required) |
| 350 | |
| 351 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 352 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 353 | page. Returns None if there are no more items in the collection. |
| 354 | </pre> |
| 355 | </div> |
| 356 | |
| 357 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 358 | <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 359 | <pre>Updates the specified domain mapping, creating the mapping as if it does |
| 360 | not exist. |
| 361 | |
| 362 | Args: |
| 363 | name: string, Required. The name of the domain association to update or create, if an |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 364 | association doesn't already exist. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 365 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 366 | The object takes the form of: |
| 367 | |
| 368 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 369 | "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters. |
| 370 | # the path of the redirect but replace the requested domain with the one |
| 371 | # specified in the redirect configuration. |
| 372 | "domainName": "A String", # Required. The domain name to redirect to. |
| 373 | "type": "A String", # Required. The redirect status code. |
| 374 | }, |
| 375 | "status": "A String", # Output only. Additional status of the domain association. |
| 376 | "site": "A String", # Required. The site name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 377 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 378 | "domainName": "A String", # Required. The domain name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 379 | "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the |
| 380 | # health of the DNS resolution for the domain. |
| 381 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| 382 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 383 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 384 | "token": "A String", # The value that must be present as a TXT record on the domain name to |
| 385 | # satisfy the challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 386 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 387 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting |
| 388 | # provisions an SSL certificate for the domain. |
| 389 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last |
| 390 | # DNS fetch. |
| 391 | "A String", |
| 392 | ], |
| 393 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 394 | "A String", |
| 395 | ], |
| 396 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 397 | "A String", |
| 398 | ], |
| 399 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 400 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 401 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate |
| 402 | # challenge. |
| 403 | "path": "A String", # The URL path on which to serve the specified token to satisfy the |
| 404 | # certificate challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 405 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 406 | }, |
| 407 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 408 | |
| 409 | x__xgafv: string, V1 error format. |
| 410 | Allowed values |
| 411 | 1 - v1 error format |
| 412 | 2 - v2 error format |
| 413 | |
| 414 | Returns: |
| 415 | An object of the form: |
| 416 | |
| 417 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 418 | "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters. |
| 419 | # the path of the redirect but replace the requested domain with the one |
| 420 | # specified in the redirect configuration. |
| 421 | "domainName": "A String", # Required. The domain name to redirect to. |
| 422 | "type": "A String", # Required. The redirect status code. |
| 423 | }, |
| 424 | "status": "A String", # Output only. Additional status of the domain association. |
| 425 | "site": "A String", # Required. The site name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 426 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 427 | "domainName": "A String", # Required. The domain name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 428 | "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the |
| 429 | # health of the DNS resolution for the domain. |
| 430 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| 431 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 432 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 433 | "token": "A String", # The value that must be present as a TXT record on the domain name to |
| 434 | # satisfy the challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 435 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 436 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting |
| 437 | # provisions an SSL certificate for the domain. |
| 438 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last |
| 439 | # DNS fetch. |
| 440 | "A String", |
| 441 | ], |
| 442 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 443 | "A String", |
| 444 | ], |
| 445 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 446 | "A String", |
| 447 | ], |
| 448 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 449 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 450 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate |
| 451 | # challenge. |
| 452 | "path": "A String", # The URL path on which to serve the specified token to satisfy the |
| 453 | # certificate challenge. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 454 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 455 | }, |
| 456 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 457 | </div> |
| 458 | |
| 459 | </body></html> |