Debian Codegraph @

docs/dyn/firebasehosting_v1beta1.projects.sites.html

raw
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></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="firebasehosting_v1beta1.projects.sites.channels.html">channels()</a></code>
79 </p>
80 <p class="firstline">Returns the channels Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="firebasehosting_v1beta1.projects.sites.customDomains.html">customDomains()</a></code>
84 </p>
85 <p class="firstline">Returns the customDomains Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="firebasehosting_v1beta1.projects.sites.domains.html">domains()</a></code>
89 </p>
90 <p class="firstline">Returns the domains Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="firebasehosting_v1beta1.projects.sites.releases.html">releases()</a></code>
94 </p>
95 <p class="firstline">Returns the releases Resource.</p>
96
97 <p class="toc_element">
98 <code><a href="firebasehosting_v1beta1.projects.sites.versions.html">versions()</a></code>
99 </p>
100 <p class="firstline">Returns the versions Resource.</p>
101
102 <p class="toc_element">
103 <code><a href="#close">close()</a></code></p>
104 <p class="firstline">Close httplib2 connections.</p>
105 <p class="toc_element">
106 <code><a href="#create">create(parent, body=None, siteId=None, validateOnly=None, x__xgafv=None)</a></code></p>
107 <p class="firstline">Creates a new Hosting Site in the specified parent Firebase project. Note that Hosting sites can take several minutes to propagate through Firebase systems.</p>
108 <p class="toc_element">
109 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
110 <p class="firstline">Deletes the specified Hosting Site from the specified parent Firebase project.</p>
111 <p class="toc_element">
112 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
113 <p class="firstline">Gets the specified Hosting Site.</p>
114 <p class="toc_element">
115 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
116 <p class="firstline">Gets the Hosting metadata for a specific site.</p>
117 <p class="toc_element">
118 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
119 <p class="firstline">Lists each Hosting Site associated with the specified parent Firebase project.</p>
120 <p class="toc_element">
121 <code><a href="#list_next">list_next()</a></code></p>
122 <p class="firstline">Retrieves the next page of results.</p>
123 <p class="toc_element">
124 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
125 <p class="firstline">Updates attributes of the specified Hosting Site.</p>
126 <p class="toc_element">
127 <code><a href="#updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
128 <p class="firstline">Sets the Hosting metadata for a specific site.</p>
129 <h3>Method Details</h3>
130 <div class="method">
131 <code class="details" id="close">close()</code>
132 <pre>Close httplib2 connections.</pre>
133 </div>
134
135 <div class="method">
136 <code class="details" id="create">create(parent, body=None, siteId=None, validateOnly=None, x__xgafv=None)</code>
137 <pre>Creates a new Hosting Site in the specified parent Firebase project. Note that Hosting sites can take several minutes to propagate through Firebase systems.
138
139 Args:
140 parent: string, Required. The Firebase project in which to create a Hosting site, in the format: projects/PROJECT_IDENTIFIER Refer to the `Site` [`name`](../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
141 body: object, The request body.
142 The object takes the form of:
143
144 { # A `Site` represents a Firebase Hosting site.
145 &quot;appId&quot;: &quot;A String&quot;, # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site.
146 &quot;defaultUrl&quot;: &quot;A String&quot;, # Output only. The default URL for the Hosting site.
147 &quot;labels&quot;: { # Optional. User-specified labels for the Hosting site.
148 &quot;a_key&quot;: &quot;A String&quot;,
149 },
150 &quot;name&quot;: &quot;A String&quot;, # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project&#x27;s [`ProjectNumber`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510).
151 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`.
152 }
153
154 siteId: string, Required. Immutable. A globally unique identifier for the Hosting site. This identifier is used to construct the Firebase-provisioned subdomains for the site, so it must also be a valid domain name label.
155 validateOnly: boolean, Optional. If set, validates that the site_id is available and that the request would succeed, returning the expected resulting site or error.
156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
160
161 Returns:
162 An object of the form:
163
164 { # A `Site` represents a Firebase Hosting site.
165 &quot;appId&quot;: &quot;A String&quot;, # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site.
166 &quot;defaultUrl&quot;: &quot;A String&quot;, # Output only. The default URL for the Hosting site.
167 &quot;labels&quot;: { # Optional. User-specified labels for the Hosting site.
168 &quot;a_key&quot;: &quot;A String&quot;,
169 },
170 &quot;name&quot;: &quot;A String&quot;, # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project&#x27;s [`ProjectNumber`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510).
171 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`.
172 }</pre>
173 </div>
174
175 <div class="method">
176 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
177 <pre>Deletes the specified Hosting Site from the specified parent Firebase project.
178
179 Args:
180 name: string, Required. The fully-qualified resource name for the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to the `Site` [`name`](../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186 Returns:
187 An object of the form:
188
189 { # 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); }
190 }</pre>
191 </div>
192
193 <div class="method">
194 <code class="details" id="get">get(name, x__xgafv=None)</code>
195 <pre>Gets the specified Hosting Site.
196
197 Args:
198 name: string, Required. The fully-qualified resource name for the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to the `Site` [`name`](../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIER values. Since a SITE_ID is a globally unique identifier, you can also use the unique sub-collection resource access pattern, in the format: projects/-/sites/SITE_ID (required)
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204 Returns:
205 An object of the form:
206
207 { # A `Site` represents a Firebase Hosting site.
208 &quot;appId&quot;: &quot;A String&quot;, # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site.
209 &quot;defaultUrl&quot;: &quot;A String&quot;, # Output only. The default URL for the Hosting site.
210 &quot;labels&quot;: { # Optional. User-specified labels for the Hosting site.
211 &quot;a_key&quot;: &quot;A String&quot;,
212 },
213 &quot;name&quot;: &quot;A String&quot;, # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project&#x27;s [`ProjectNumber`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510).
214 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`.
215 }</pre>
216 </div>
217
218 <div class="method">
219 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
220 <pre>Gets the Hosting metadata for a specific site.
221
222 Args:
223 name: string, Required. The site for which to get the SiteConfig, in the format: sites/ site-name/config (required)
224 x__xgafv: string, V1 error format.
225 Allowed values
226 1 - v1 error format
227 2 - v2 error format
228
229 Returns:
230 An object of the form:
231
232 { # A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior
233 &quot;cloudLoggingEnabled&quot;: True or False, # Whether or not web requests made by site visitors are logged via Cloud Logging.
234 &quot;maxVersions&quot;: &quot;A String&quot;, # The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default.
235 }</pre>
236 </div>
237
238 <div class="method">
239 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
240 <pre>Lists each Hosting Site associated with the specified parent Firebase project.
241
242 Args:
243 parent: string, Required. The Firebase project for which to list sites, in the format: projects/PROJECT_IDENTIFIER Refer to the `Site` [`name`](../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
244 pageSize: integer, Optional. The maximum number of sites to return. The service may return a lower number if fewer sites exist than this maximum number. If unspecified, defaults to 40.
245 pageToken: string, Optional. A token from a previous call to `ListSites` that tells the server where to resume listing.
246 x__xgafv: string, V1 error format.
247 Allowed values
248 1 - v1 error format
249 2 - v2 error format
250
251 Returns:
252 An object of the form:
253
254 {
255 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to `ListSites`. Page tokens are short-lived and should not be stored.
256 &quot;sites&quot;: [ # A list of Site objects associated with the specified Firebase project.
257 { # A `Site` represents a Firebase Hosting site.
258 &quot;appId&quot;: &quot;A String&quot;, # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site.
259 &quot;defaultUrl&quot;: &quot;A String&quot;, # Output only. The default URL for the Hosting site.
260 &quot;labels&quot;: { # Optional. User-specified labels for the Hosting site.
261 &quot;a_key&quot;: &quot;A String&quot;,
262 },
263 &quot;name&quot;: &quot;A String&quot;, # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project&#x27;s [`ProjectNumber`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510).
264 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`.
265 },
266 ],
267 }</pre>
268 </div>
269
270 <div class="method">
271 <code class="details" id="list_next">list_next()</code>
272 <pre>Retrieves the next page of results.
273
274 Args:
275 previous_request: The request for the previous page. (required)
276 previous_response: The response from the request for the previous page. (required)
277
278 Returns:
279 A request object that you can call &#x27;execute()&#x27; on to request the next
280 page. Returns None if there are no more items in the collection.
281 </pre>
282 </div>
283
284 <div class="method">
285 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
286 <pre>Updates attributes of the specified Hosting Site.
287
288 Args:
289 name: string, Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project&#x27;s [`ProjectNumber`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). (required)
290 body: object, The request body.
291 The object takes the form of:
292
293 { # A `Site` represents a Firebase Hosting site.
294 &quot;appId&quot;: &quot;A String&quot;, # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site.
295 &quot;defaultUrl&quot;: &quot;A String&quot;, # Output only. The default URL for the Hosting site.
296 &quot;labels&quot;: { # Optional. User-specified labels for the Hosting site.
297 &quot;a_key&quot;: &quot;A String&quot;,
298 },
299 &quot;name&quot;: &quot;A String&quot;, # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project&#x27;s [`ProjectNumber`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510).
300 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`.
301 }
302
303 updateMask: string, A set of field names from your Site that you want to update.
304 x__xgafv: string, V1 error format.
305 Allowed values
306 1 - v1 error format
307 2 - v2 error format
308
309 Returns:
310 An object of the form:
311
312 { # A `Site` represents a Firebase Hosting site.
313 &quot;appId&quot;: &quot;A String&quot;, # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the Hosting site.
314 &quot;defaultUrl&quot;: &quot;A String&quot;, # Output only. The default URL for the Hosting site.
315 &quot;labels&quot;: { # Optional. User-specified labels for the Hosting site.
316 &quot;a_key&quot;: &quot;A String&quot;,
317 },
318 &quot;name&quot;: &quot;A String&quot;, # Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project&#x27;s [`ProjectNumber`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510).
319 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of Hosting site. Every Firebase project has a `DEFAULT_SITE`, which is created when Hosting is provisioned for the project. All additional sites are `USER_SITE`.
320 }</pre>
321 </div>
322
323 <div class="method">
324 <code class="details" id="updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
325 <pre>Sets the Hosting metadata for a specific site.
326
327 Args:
328 name: string, Required. The site for which to update the SiteConfig, in the format: sites/ site-name/config (required)
329 body: object, The request body.
330 The object takes the form of:
331
332 { # A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior
333 &quot;cloudLoggingEnabled&quot;: True or False, # Whether or not web requests made by site visitors are logged via Cloud Logging.
334 &quot;maxVersions&quot;: &quot;A String&quot;, # The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default.
335 }
336
337 updateMask: string, A set of field names from your [site configuration](../sites.SiteConfig) that you want to update. A field will be overwritten if, and only if, it&#x27;s in the mask. If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used.
338 x__xgafv: string, V1 error format.
339 Allowed values
340 1 - v1 error format
341 2 - v2 error format
342
343 Returns:
344 An object of the form:
345
346 { # A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior
347 &quot;cloudLoggingEnabled&quot;: True or False, # Whether or not web requests made by site visitors are logged via Cloud Logging.
348 &quot;maxVersions&quot;: &quot;A String&quot;, # The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default.
349 }</pre>
350 </div>
351
352 </body></html>