Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / firebasehosting_v1beta1.projects.sites.versions.files.html
blob: a83aa9ceb258703b9c5cea03702babbb8ba9c472 [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> . <a href="firebasehosting_v1beta1.projects.sites.versions.html">versions</a> . <a href="firebasehosting_v1beta1.projects.sites.versions.files.html">files</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#list">list(parent, pageToken=None, pageSize=None, status=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]82<p class="firstline">Lists the remaining files to be uploaded for the specified version.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
93 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, status=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]94 <pre>Lists the remaining files to be uploaded for the specified version.
95
96Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]97 parent: string, Required. The parent to list files for, in the format: sites/site-name /versions/versionID (required)
98 pageToken: string, The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]99 pageSize: integer, The page size to return. Defaults to 1000.
100 status: string, The type of files in the version that should be listed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]101 Allowed values
102 STATUS_UNSPECIFIED - The default status; should not be intentionally used.
103 EXPECTED - The file has been included in the version and is expected to be uploaded in the near future.
104 ACTIVE - The file has already been uploaded to Firebase Hosting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
109
110Returns:
111 An object of the form:
112
113 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token, if more results exist.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;files&quot;: [ # The list path/hashes in the specified version.
116 { # A static content file that is part of a version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]117 &quot;status&quot;: &quot;A String&quot;, # Output only. The current status of a particular file in the specified version. The value will be either `pending upload` or `uploaded`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118 &quot;path&quot;: &quot;A String&quot;, # The URI at which the file&#x27;s content should display.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]119 &quot;hash&quot;: &quot;A String&quot;, # The SHA256 content hash of the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 },
121 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 }</pre>
123</div>
124
125<div class="method">
126 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
127 <pre>Retrieves the next page of results.
128
129Args:
130 previous_request: The request for the previous page. (required)
131 previous_response: The response from the request for the previous page. (required)
132
133Returns:
134 A request object that you can call &#x27;execute()&#x27; on to request the next
135 page. Returns None if there are no more items in the collection.
136 </pre>
137</div>
138
139</body></html>