1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a domain mapping on the specified site.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the existing domain mapping on the specified site.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a domain mapping on the specified site.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the domains for the specified site.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified domain mapping, creating the mapping as if it does not exist.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a domain mapping on the specified site.
Args:
parent: string, Required. The parent to create the domain association for, in the format: sites/site-name (required)
body: object, The request body.
The object takes the form of:
{ # The intended behavior and status information of a domain.
"domainName": "A String", # Required. The domain name of the association.
"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.
"domainName": "A String", # Required. The domain name to redirect to.
"type": "A String", # Required. The redirect status code.
},
"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.
"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.
"A String",
],
"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.
},
"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.
"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.
},
"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.
"discoveredIps": [ # The IPs found at the last DNS fetch.
"A String",
],
"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
"expectedIps": [ # The list of IPs to which the domain is expected to resolve.
"A String",
],
},
"site": "A String", # Required. The site name of the association.
"status": "A String", # Output only. Additional status of the domain association.
"updateTime": "A String", # Output only. The time at which the domain was last updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The intended behavior and status information of a domain.
"domainName": "A String", # Required. The domain name of the association.
"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.
"domainName": "A String", # Required. The domain name to redirect to.
"type": "A String", # Required. The redirect status code.
},
"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.
"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.
"A String",
],
"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.
},
"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.
"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.
},
"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.
"discoveredIps": [ # The IPs found at the last DNS fetch.
"A String",
],
"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
"expectedIps": [ # The list of IPs to which the domain is expected to resolve.
"A String",
],
},
"site": "A String", # Required. The site name of the association.
"status": "A String", # Output only. Additional status of the domain association.
"updateTime": "A String", # Output only. The time at which the domain was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes the existing domain mapping on the specified site.
Args:
name: string, Required. The name of the domain association to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a domain mapping on the specified site.
Args:
name: string, Required. The name of the domain configuration to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The intended behavior and status information of a domain.
"domainName": "A String", # Required. The domain name of the association.
"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.
"domainName": "A String", # Required. The domain name to redirect to.
"type": "A String", # Required. The redirect status code.
},
"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.
"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.
"A String",
],
"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.
},
"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.
"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.
},
"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.
"discoveredIps": [ # The IPs found at the last DNS fetch.
"A String",
],
"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
"expectedIps": [ # The list of IPs to which the domain is expected to resolve.
"A String",
],
},
"site": "A String", # Required. The site name of the association.
"status": "A String", # Output only. Additional status of the domain association.
"updateTime": "A String", # Output only. The time at which the domain was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the domains for the specified site.
Args:
parent: string, Required. The parent for which to list domains, in the format: sites/ site-name (required)
pageSize: integer, The page size to return. Defaults to 50.
pageToken: string, The next_page_token from a previous request, if provided.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to listing Domains.
"domains": [ # The list of domains, if any exist.
{ # The intended behavior and status information of a domain.
"domainName": "A String", # Required. The domain name of the association.
"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.
"domainName": "A String", # Required. The domain name to redirect to.
"type": "A String", # Required. The redirect status code.
},
"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.
"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.
"A String",
],
"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.
},
"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.
"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.
},
"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.
"discoveredIps": [ # The IPs found at the last DNS fetch.
"A String",
],
"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
"expectedIps": [ # The list of IPs to which the domain is expected to resolve.
"A String",
],
},
"site": "A String", # Required. The site name of the association.
"status": "A String", # Output only. Additional status of the domain association.
"updateTime": "A String", # Output only. The time at which the domain was last updated.
},
],
"nextPageToken": "A String", # The pagination token, if more results exist.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
<pre>Updates the specified domain mapping, creating the mapping as if it does not exist.
Args:
name: string, Required. The name of the domain association to update or create, if an association doesn't already exist. (required)
body: object, The request body.
The object takes the form of:
{ # The intended behavior and status information of a domain.
"domainName": "A String", # Required. The domain name of the association.
"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.
"domainName": "A String", # Required. The domain name to redirect to.
"type": "A String", # Required. The redirect status code.
},
"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.
"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.
"A String",
],
"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.
},
"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.
"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.
},
"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.
"discoveredIps": [ # The IPs found at the last DNS fetch.
"A String",
],
"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
"expectedIps": [ # The list of IPs to which the domain is expected to resolve.
"A String",
],
},
"site": "A String", # Required. The site name of the association.
"status": "A String", # Output only. Additional status of the domain association.
"updateTime": "A String", # Output only. The time at which the domain was last updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The intended behavior and status information of a domain.
"domainName": "A String", # Required. The domain name of the association.
"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.
"domainName": "A String", # Required. The domain name to redirect to.
"type": "A String", # Required. The redirect status code.
},
"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.
"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.
"A String",
],
"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.
"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.
"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.
},
"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.
"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.
"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.
},
"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.
"discoveredIps": [ # The IPs found at the last DNS fetch.
"A String",
],
"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.
"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.
"expectedIps": [ # The list of IPs to which the domain is expected to resolve.
"A String",
],
},
"site": "A String", # Required. The site name of the association.
"status": "A String", # Output only. Additional status of the domain association.
"updateTime": "A String", # Output only. The time at which the domain was last updated.
}</pre>
</div>
</body></html>
|
