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