Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / firebasehosting_v1beta1.sites.domains.html
blob: b96110c38b37a60a19987d838cf36a524a095577 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.sites.html">sites</a> . <a href="firebasehosting_v1beta1.sites.domains.html">domains</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
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">
87 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
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">
93 <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p>
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">
97 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
98 <pre>Creates a domain mapping on the specified site.
99
100Args:
101 parent: string, Required. The parent to create the domain association for, in the format:
102<code>sites/<var>site-name</var></code> (required)
103 body: object, The request body. (required)
104 The object takes the form of:
105
106{ # The intended behavior and status information of a domain.
107 "status": "A String", # Output only. Additional status of the domain association.
108 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
109 # the path of the redirect but replace the requested domain with the one
110 # specified in the redirect configuration.
111 "type": "A String", # Required. The redirect status code.
112 "domainName": "A String", # Required. The domain name to redirect to.
113 },
114 "domainName": "A String", # Required. The domain name of the association.
115 "site": "A String", # Required. The site name of the association.
116 "updateTime": "A String", # Output only. The time at which the domain was last updated.
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 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
120 "path": "A String", # The URL path on which to serve the specified token to satisfy the
121 # certificate challenge.
122 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate
123 # challenge.
124 },
125 "expectedIps": [ # The list of IPs to which the domain is expected to resolve.
126 "A String",
127 ],
128 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
129 # DNS fetch.
130 "A String",
131 ],
132 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
133 "discoveredIps": [ # The IPs found at the last DNS fetch.
134 "A String",
135 ],
136 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
137 "token": "A String", # The value that must be present as a TXT record on the domain name to
138 # satisfy the challenge.
139 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
140 },
141 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
142 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
143 # provisions an SSL certificate for the domain.
144 },
145 }
146
147 x__xgafv: string, V1 error format.
148 Allowed values
149 1 - v1 error format
150 2 - v2 error format
151
152Returns:
153 An object of the form:
154
155 { # The intended behavior and status information of a domain.
156 "status": "A String", # Output only. Additional status of the domain association.
157 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
158 # the path of the redirect but replace the requested domain with the one
159 # specified in the redirect configuration.
160 "type": "A String", # Required. The redirect status code.
161 "domainName": "A String", # Required. The domain name to redirect to.
162 },
163 "domainName": "A String", # Required. The domain name of the association.
164 "site": "A String", # Required. The site name of the association.
165 "updateTime": "A String", # Output only. The time at which the domain was last updated.
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 "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
170 # certificate challenge.
171 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate
172 # challenge.
173 },
174 "expectedIps": [ # The list of IPs to which the domain is expected to resolve.
175 "A String",
176 ],
177 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
178 # DNS fetch.
179 "A String",
180 ],
181 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
182 "discoveredIps": [ # The IPs found at the last DNS fetch.
183 "A String",
184 ],
185 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
186 "token": "A String", # The value that must be present as a TXT record on the domain name to
187 # satisfy the challenge.
188 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
189 },
190 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
191 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
192 # provisions an SSL certificate for the domain.
193 },
194 }</pre>
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
201Args:
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
208Returns:
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
227Args:
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
234Returns:
235 An object of the form:
236
237 { # The intended behavior and status information of a domain.
238 "status": "A String", # Output only. Additional status of the domain association.
239 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
240 # the path of the redirect but replace the requested domain with the one
241 # specified in the redirect configuration.
242 "type": "A String", # Required. The redirect status code.
243 "domainName": "A String", # Required. The domain name to redirect to.
244 },
245 "domainName": "A String", # Required. The domain name of the association.
246 "site": "A String", # Required. The site name of the association.
247 "updateTime": "A String", # Output only. The time at which the domain was last updated.
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 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
251 "path": "A String", # The URL path on which to serve the specified token to satisfy the
252 # certificate challenge.
253 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate
254 # challenge.
255 },
256 "expectedIps": [ # The list of IPs to which the domain is expected to resolve.
257 "A String",
258 ],
259 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
260 # DNS fetch.
261 "A String",
262 ],
263 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
264 "discoveredIps": [ # The IPs found at the last DNS fetch.
265 "A String",
266 ],
267 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
268 "token": "A String", # The value that must be present as a TXT record on the domain name to
269 # satisfy the challenge.
270 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
271 },
272 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
273 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
274 # provisions an SSL certificate for the domain.
275 },
276 }</pre>
277</div>
278
279<div class="method">
280 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
281 <pre>Lists the domains for the specified site.
282
283Args:
284 parent: string, Required. The parent for which to list domains, in the format:
285<code>sites/<var>site-name</var></code> (required)
286 pageToken: string, The next_page_token from a previous request, if provided.
287 x__xgafv: string, V1 error format.
288 Allowed values
289 1 - v1 error format
290 2 - v2 error format
291 pageSize: integer, The page size to return. Defaults to 50.
292
293Returns:
294 An object of the form:
295
296 {
297 "nextPageToken": "A String", # The pagination token, if more results exist.
298 "domains": [ # The list of domains, if any exist.
299 { # The intended behavior and status information of a domain.
300 "status": "A String", # Output only. Additional status of the domain association.
301 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
302 # the path of the redirect but replace the requested domain with the one
303 # specified in the redirect configuration.
304 "type": "A String", # Required. The redirect status code.
305 "domainName": "A String", # Required. The domain name to redirect to.
306 },
307 "domainName": "A String", # Required. The domain name of the association.
308 "site": "A String", # Required. The site name of the association.
309 "updateTime": "A String", # Output only. The time at which the domain was last updated.
310 "provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the
311 # health of the DNS resolution for the domain.
312 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
313 "path": "A String", # The URL path on which to serve the specified token to satisfy the
314 # certificate challenge.
315 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate
316 # challenge.
317 },
318 "expectedIps": [ # The list of IPs to which the domain is expected to resolve.
319 "A String",
320 ],
321 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
322 # DNS fetch.
323 "A String",
324 ],
325 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
326 "discoveredIps": [ # The IPs found at the last DNS fetch.
327 "A String",
328 ],
329 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
330 "token": "A String", # The value that must be present as a TXT record on the domain name to
331 # satisfy the challenge.
332 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
333 },
334 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
335 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
336 # provisions an SSL certificate for the domain.
337 },
338 },
339 ],
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
347Args:
348 previous_request: The request for the previous page. (required)
349 previous_response: The response from the request for the previous page. (required)
350
351Returns:
352 A request object that you can call 'execute()' on to request the next
353 page. Returns None if there are no more items in the collection.
354 </pre>
355</div>
356
357<div class="method">
358 <code class="details" id="update">update(name, body, x__xgafv=None)</code>
359 <pre>Updates the specified domain mapping, creating the mapping as if it does
360not exist.
361
362Args:
363 name: string, Required. The name of the domain association to update or create, if an
364association doesn't already exist. (required)
365 body: object, The request body. (required)
366 The object takes the form of:
367
368{ # The intended behavior and status information of a domain.
369 "status": "A String", # Output only. Additional status of the domain association.
370 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
371 # the path of the redirect but replace the requested domain with the one
372 # specified in the redirect configuration.
373 "type": "A String", # Required. The redirect status code.
374 "domainName": "A String", # Required. The domain name to redirect to.
375 },
376 "domainName": "A String", # Required. The domain name of the association.
377 "site": "A String", # Required. The site name of the association.
378 "updateTime": "A String", # Output only. The time at which the domain was last updated.
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 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
382 "path": "A String", # The URL path on which to serve the specified token to satisfy the
383 # certificate challenge.
384 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate
385 # challenge.
386 },
387 "expectedIps": [ # The list of IPs to which the domain is expected to resolve.
388 "A String",
389 ],
390 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
391 # DNS fetch.
392 "A String",
393 ],
394 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
395 "discoveredIps": [ # The IPs found at the last DNS fetch.
396 "A String",
397 ],
398 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
399 "token": "A String", # The value that must be present as a TXT record on the domain name to
400 # satisfy the challenge.
401 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
402 },
403 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
404 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
405 # provisions an SSL certificate for the domain.
406 },
407 }
408
409 x__xgafv: string, V1 error format.
410 Allowed values
411 1 - v1 error format
412 2 - v2 error format
413
414Returns:
415 An object of the form:
416
417 { # The intended behavior and status information of a domain.
418 "status": "A String", # Output only. Additional status of the domain association.
419 "domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.
420 # the path of the redirect but replace the requested domain with the one
421 # specified in the redirect configuration.
422 "type": "A String", # Required. The redirect status code.
423 "domainName": "A String", # Required. The domain name to redirect to.
424 },
425 "domainName": "A String", # Required. The domain name of the association.
426 "site": "A String", # Required. The site name of the association.
427 "updateTime": "A String", # Output only. The time at which the domain was last updated.
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 "certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
431 "path": "A String", # The URL path on which to serve the specified token to satisfy the
432 # certificate challenge.
433 "token": "A String", # The token to serve at the specified URL path to satisfy the certificate
434 # challenge.
435 },
436 "expectedIps": [ # The list of IPs to which the domain is expected to resolve.
437 "A String",
438 ],
439 "certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last
440 # DNS fetch.
441 "A String",
442 ],
443 "dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
444 "discoveredIps": [ # The IPs found at the last DNS fetch.
445 "A String",
446 ],
447 "certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
448 "token": "A String", # The value that must be present as a TXT record on the domain name to
449 # satisfy the challenge.
450 "domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
451 },
452 "dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
453 "certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting
454 # provisions an SSL certificate for the domain.
455 },
456 }</pre>
457</div>
458
459</body></html>