| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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.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"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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, pageToken=None, pageSize=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> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 97 | <p class="firstline">Updates the specified domain mapping, creating the mapping as if it does not exist.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 100 | <code class="details" id="close">close()</code> |
| 101 | <pre>Close httplib2 connections.</pre> |
| 102 | </div> |
| 103 | |
| 104 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | |
| 108 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 109 | parent: string, Required. The parent to create the domain association for, in the format: sites/site-name (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 110 | body: object, The request body. |
| 111 | The object takes the form of: |
| 112 | |
| 113 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 114 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 115 | "site": "A String", # Required. The site name of the association. |
| 116 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 117 | "type": "A String", # Required. The redirect status code. |
| 118 | "domainName": "A String", # Required. The domain name to redirect to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 119 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 120 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 121 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 122 | "A String", |
| 123 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 124 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. |
| 125 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 126 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. |
| 127 | "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 128 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 129 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 130 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 131 | "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. |
| 132 | }, |
| 133 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. |
| 134 | "A String", |
| 135 | ], |
| 136 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 137 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 138 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 139 | "A String", |
| 140 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 142 | "status": "A String", # Output only. Additional status of the domain association. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 143 | "domainName": "A String", # Required. The domain name of the association. |
| 144 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 145 | |
| 146 | x__xgafv: string, V1 error format. |
| 147 | Allowed values |
| 148 | 1 - v1 error format |
| 149 | 2 - v2 error format |
| 150 | |
| 151 | Returns: |
| 152 | An object of the form: |
| 153 | |
| 154 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 155 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 156 | "site": "A String", # Required. The site name of the association. |
| 157 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 158 | "type": "A String", # Required. The redirect status code. |
| 159 | "domainName": "A String", # Required. The domain name to redirect to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 160 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 161 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 162 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 163 | "A String", |
| 164 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 165 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. |
| 166 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 167 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. |
| 168 | "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 169 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 170 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 171 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 172 | "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. |
| 173 | }, |
| 174 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. |
| 175 | "A String", |
| 176 | ], |
| 177 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 178 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 179 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 180 | "A String", |
| 181 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 182 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 183 | "status": "A String", # Output only. Additional status of the domain association. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 184 | "domainName": "A String", # Required. The domain name of the association. |
| 185 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | |
| 192 | Args: |
| 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 | |
| 199 | Returns: |
| 200 | An object of the form: |
| 201 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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 `{}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | |
| 210 | Args: |
| 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 | |
| 217 | Returns: |
| 218 | An object of the form: |
| 219 | |
| 220 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 221 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 222 | "site": "A String", # Required. The site name of the association. |
| 223 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 224 | "type": "A String", # Required. The redirect status code. |
| 225 | "domainName": "A String", # Required. The domain name to redirect to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 226 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 227 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 228 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 229 | "A String", |
| 230 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 231 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. |
| 232 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 233 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. |
| 234 | "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 235 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 236 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 237 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 238 | "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. |
| 239 | }, |
| 240 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. |
| 241 | "A String", |
| 242 | ], |
| 243 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 244 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 245 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 246 | "A String", |
| 247 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 248 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 249 | "status": "A String", # Output only. Additional status of the domain association. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 250 | "domainName": "A String", # Required. The domain name of the association. |
| 251 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 252 | </div> |
| 253 | |
| 254 | <div class="method"> |
| 255 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 256 | <pre>Lists the domains for the specified site. |
| 257 | |
| 258 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 259 | parent: string, Required. The parent for which to list domains, in the format: sites/ site-name (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 260 | pageToken: string, The next_page_token from a previous request, if provided. |
| 261 | pageSize: integer, The page size to return. Defaults to 50. |
| 262 | x__xgafv: string, V1 error format. |
| 263 | Allowed values |
| 264 | 1 - v1 error format |
| 265 | 2 - v2 error format |
| 266 | |
| 267 | Returns: |
| 268 | An object of the form: |
| 269 | |
| 270 | { # The response to listing Domains. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 271 | "nextPageToken": "A String", # The pagination token, if more results exist. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 272 | "domains": [ # The list of domains, if any exist. |
| 273 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 274 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 275 | "site": "A String", # Required. The site name of the association. |
| 276 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 277 | "type": "A String", # Required. The redirect status code. |
| 278 | "domainName": "A String", # Required. The domain name to redirect to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 279 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 280 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 281 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 282 | "A String", |
| 283 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 284 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. |
| 285 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 286 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. |
| 287 | "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 288 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 289 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 290 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 291 | "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. |
| 292 | }, |
| 293 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. |
| 294 | "A String", |
| 295 | ], |
| 296 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 297 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 298 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 299 | "A String", |
| 300 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 301 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 302 | "status": "A String", # Output only. Additional status of the domain association. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 303 | "domainName": "A String", # Required. The domain name of the association. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 304 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 305 | ], |
| 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 | |
| 313 | Args: |
| 314 | previous_request: The request for the previous page. (required) |
| 315 | previous_response: The response from the request for the previous page. (required) |
| 316 | |
| 317 | Returns: |
| 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> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 325 | <pre>Updates the specified domain mapping, creating the mapping as if it does not exist. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 326 | |
| 327 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 328 | name: string, Required. The name of the domain association to update or create, if an association doesn't already exist. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 329 | body: object, The request body. |
| 330 | The object takes the form of: |
| 331 | |
| 332 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 333 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 334 | "site": "A String", # Required. The site name of the association. |
| 335 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 336 | "type": "A String", # Required. The redirect status code. |
| 337 | "domainName": "A String", # Required. The domain name to redirect to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 338 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 339 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 340 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 341 | "A String", |
| 342 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 343 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. |
| 344 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 345 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. |
| 346 | "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 347 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 348 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 349 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 350 | "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. |
| 351 | }, |
| 352 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. |
| 353 | "A String", |
| 354 | ], |
| 355 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 356 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 357 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 358 | "A String", |
| 359 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 360 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 361 | "status": "A String", # Output only. Additional status of the domain association. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 362 | "domainName": "A String", # Required. The domain name of the association. |
| 363 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 364 | |
| 365 | x__xgafv: string, V1 error format. |
| 366 | Allowed values |
| 367 | 1 - v1 error format |
| 368 | 2 - v2 error format |
| 369 | |
| 370 | Returns: |
| 371 | An object of the form: |
| 372 | |
| 373 | { # The intended behavior and status information of a domain. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 374 | "updateTime": "A String", # Output only. The time at which the domain was last updated. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 375 | "site": "A String", # Required. The site name of the association. |
| 376 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 377 | "type": "A String", # Required. The redirect status code. |
| 378 | "domainName": "A String", # Required. The domain name to redirect to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 379 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 380 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 381 | "discoveredIps": [ # The IPs found at the last DNS fetch. |
| 382 | "A String", |
| 383 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 384 | "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain. |
| 385 | "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate. |
| 386 | "token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge. |
| 387 | "path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 388 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 389 | "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate. |
| 390 | "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied. |
| 391 | "token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge. |
| 392 | }, |
| 393 | "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch. |
| 394 | "A String", |
| 395 | ], |
| 396 | "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch. |
| 397 | "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 398 | "expectedIps": [ # The list of IPs to which the domain is expected to resolve. |
| 399 | "A String", |
| 400 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 401 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 402 | "status": "A String", # Output only. Additional status of the domain association. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 403 | "domainName": "A String", # Required. The domain name of the association. |
| 404 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 405 | </div> |
| 406 | |
| 407 | </body></html> |