Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / firebasehosting_v1beta1.projects.sites.html
blob: 26dd8dab8992b286e57b54f2c813f6ecd5e1975d [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -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.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.domains.html">domains()</a></code>
84</p>
85<p class="firstline">Returns the domains Resource.</p>
86
87<p class="toc_element">
88 <code><a href="firebasehosting_v1beta1.projects.sites.releases.html">releases()</a></code>
89</p>
90<p class="firstline">Returns the releases Resource.</p>
91
92<p class="toc_element">
93 <code><a href="firebasehosting_v1beta1.projects.sites.versions.html">versions()</a></code>
94</p>
95<p class="firstline">Returns the versions Resource.</p>
96
97<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]98 <code><a href="#close">close()</a></code></p>
99<p class="firstline">Close httplib2 connections.</p>
100<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
102<p class="firstline">Gets the Hosting metadata for a specific site.</p>
103<p class="toc_element">
104 <code><a href="#updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
105<p class="firstline">Sets the Hosting metadata for a specific site.</p>
106<h3>Method Details</h3>
107<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]108 <code class="details" id="close">close()</code>
109 <pre>Close httplib2 connections.</pre>
110</div>
111
112<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
114 <pre>Gets the Hosting metadata for a specific site.
115
116Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]117 name: string, Required. The site for which to get the SiteConfig, in the format: sites/ site-name/config (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122
123Returns:
124 An object of the form:
125
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]126 { # A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior
127 &quot;cloudLoggingEnabled&quot;: True or False, # Whether or not web requests made by site visitors are logged via Cloud Logging.
128 &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.
129 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130</div>
131
132<div class="method">
133 <code class="details" id="updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
134 <pre>Sets the Hosting metadata for a specific site.
135
136Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]137 name: string, Required. The site for which to update the SiteConfig, in the format: sites/ site-name/config (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 body: object, The request body.
139 The object takes the form of:
140
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]141{ # A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior
142 &quot;cloudLoggingEnabled&quot;: True or False, # Whether or not web requests made by site visitors are logged via Cloud Logging.
143 &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.
144}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]146 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]155 { # A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior
156 &quot;cloudLoggingEnabled&quot;: True or False, # Whether or not web requests made by site visitors are logged via Cloud Logging.
157 &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.
158 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159</div>
160
161</body></html>