blob: 706baf26388bd210332a2a4ec5559dd755738a26 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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> . <a href="firebasehosting_v1beta1.sites.versions.html">versions</a> . <a href="firebasehosting_v1beta1.sites.versions.files.html">files</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#list">list(parent, status=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Lists the remaining files to be uploaded for the specified version.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070085 <code class="details" id="list">list(parent, status=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086 <pre>Lists the remaining files to be uploaded for the specified version.
87
88Args:
89 parent: string, Required. The parent to list files for, in the format:
Dan O'Mearadd494642020-05-01 07:42:23 -070090&lt;code&gt;sites/&lt;var&gt;site-name&lt;/var&gt;/versions/&lt;var&gt;versionID&lt;/var&gt;&lt;/code&gt; (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091 status: string, The type of files in the version that should be listed.
Dan O'Mearadd494642020-05-01 07:42:23 -070092 pageSize: integer, The page size to return. Defaults to 1000.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070093 pageToken: string, The next_page_token from a previous request, if provided. This will be the
94encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.
95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070099
100Returns:
101 An object of the form:
102
Dan O'Mearadd494642020-05-01 07:42:23 -0700103 { # The response when listing a Version's Files..
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104 "files": [ # The list path/hashes in the specified version.
105 { # A static content file that is part of a version.
106 "status": "A String", # Output only. The current status of a particular file in the specified
107 # version.
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 # &lt;br&gt;The value will be either `pending upload` or `uploaded`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109 "path": "A String", # The URI at which the file's content should display.
110 "hash": "A String", # The SHA256 content hash of the file.
111 },
112 ],
113 "nextPageToken": "A String", # The pagination token, if more results exist.
114 }</pre>
115</div>
116
117<div class="method">
118 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
119 <pre>Retrieves the next page of results.
120
121Args:
122 previous_request: The request for the previous page. (required)
123 previous_response: The response from the request for the previous page. (required)
124
125Returns:
126 A request object that you can call 'execute()' on to request the next
127 page. Returns None if there are no more items in the collection.
128 </pre>
129</div>
130
131</body></html>