Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / firebasehosting_v1beta1.sites.html
blob: 2587ac419b990d8fbb39c8cbe328c829a2e56916 [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="firebasehosting_v1beta1.sites.channels.html">channels()</a></code>
79</p>
80<p class="firstline">Returns the channels Resource.</p>
81
82<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83 <code><a href="firebasehosting_v1beta1.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.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.sites.versions.html">versions()</a></code>
94</p>
95<p class="firstline">Returns the versions Resource.</p>
96
97<p class="toc_element">
98 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
99<p class="firstline">Gets the Hosting metadata for a specific site.</p>
100<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]101 <code><a href="#updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102<p class="firstline">Sets the Hosting metadata for a specific site.</p>
103<h3>Method Details</h3>
104<div class="method">
105 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
106 <pre>Gets the Hosting metadata for a specific site.
107
108Args:
109 name: string, Required. The site for which to get the SiteConfig, in the format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110&lt;code&gt;sites/&lt;var&gt;site-name&lt;/var&gt;/config&lt;/code&gt; (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116Returns:
117 An object of the form:
118
119 { # A `SiteConfig` contains metadata associated with a specific site that
120 # controls Firebase Hosting serving behavior
121 "maxVersions": "A String", # The number of FINALIZED versions that will be held for a site before
122 # automatic deletion. When a new version is deployed, content for versions
123 # in storage in excess of this number will be deleted, and will no longer be
124 # billed for storage usage. Oldest versions will be deleted first; sites are
125 # created with an unlimited number of max_versions by default.
126 }</pre>
127</div>
128
129<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130 <code class="details" id="updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 <pre>Sets the Hosting metadata for a specific site.
132
133Args:
134 name: string, Required. The site for which to update the SiteConfig, in the format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135&lt;code&gt;sites/&lt;var&gt;site-name&lt;/var&gt;/config&lt;/code&gt; (required)
136 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137 The object takes the form of:
138
139{ # A `SiteConfig` contains metadata associated with a specific site that
140 # controls Firebase Hosting serving behavior
141 "maxVersions": "A String", # The number of FINALIZED versions that will be held for a site before
142 # automatic deletion. When a new version is deployed, content for versions
143 # in storage in excess of this number will be deleted, and will no longer be
144 # billed for storage usage. Oldest versions will be deleted first; sites are
145 # created with an unlimited number of max_versions by default.
146 }
147
148 updateMask: string, A set of field names from your [site configuration](../sites.SiteConfig)
149that you want to update.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]150&lt;br&gt;A field will be overwritten if, and only if, it's in the mask.
151&lt;br&gt;If a mask is not provided then a default mask of only
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152[`max_versions`](../sites.SiteConfig.max_versions) will be used.
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158Returns:
159 An object of the form:
160
161 { # A `SiteConfig` contains metadata associated with a specific site that
162 # controls Firebase Hosting serving behavior
163 "maxVersions": "A String", # The number of FINALIZED versions that will be held for a site before
164 # automatic deletion. When a new version is deployed, content for versions
165 # in storage in excess of this number will be deleted, and will no longer be
166 # billed for storage usage. Oldest versions will be deleted first; sites are
167 # created with an unlimited number of max_versions by default.
168 }</pre>
169</div>
170
171</body></html>