Method: sites.versions.files.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the remaining files to be uploaded for the specified version.
HTTP request
GET https://firebasehosting.googleapis.com/v1beta1/{parent=sites/*/versions/*}/files
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The version for which to list files, in the format:
sites/SITE_ID/versions/VERSION_ID
|
Query parameters
| Parameters |
status |
enum (Status)
The type of files that should be listed for the specified version.
|
pageSize |
integer
The maximum number of version files to return. The service may return a lower number if fewer version files exist than this maximum number.
If unspecified, defaults to 1000.
|
pageToken |
string
A token from a previous call to files.list that tells the server where to resume listing.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"files": [
{
object (VersionFile)
}
],
"nextPageToken": string
} |
| Fields |
files[] |
object (VersionFile)
The list of paths to the hashes of the files in the specified version.
|
nextPageToken |
string
The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to files.list. Page tokens are short-lived and should not be stored.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/firebase.hosting.readonly
https://www.googleapis.com/auth/firebase.hosting
https://www.googleapis.com/auth/firebase.readonly
https://www.googleapis.com/auth/firebase
https://www.googleapis.com/auth/cloud-platform.read-only
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Status
The current status of the files being added to a version.
| Enums |
STATUS_UNSPECIFIED |
The default status; should not be intentionally used. |
EXPECTED |
The file has been included in the version and is expected to be uploaded in the near future. |
ACTIVE |
The file has already been uploaded to Firebase Hosting. |
VersionFile
A static content file that is part of a version.
| JSON representation |
{
"path": string,
"hash": string,
"status": enum (Status)
} |
| Fields |
path |
string
The URI at which the file's content should display.
|
hash |
string
The SHA256 content hash of the file.
|
status |
enum (Status)
Output only. The current status of a particular file in the specified version. The value will be either pending upload or uploaded.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-09-11 UTC.
[null,null,["Last updated 2023-09-11 UTC."],[],[],null,["# Method: sites.versions.files.list\n\nLists the remaining files to be uploaded for the specified version.\n\n### HTTP request\n\n`GET https://firebasehosting.googleapis.com/v1beta1/{parent=sites/*/versions/*}/files`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The version for which to list files, in the format: `sites/`\u003cvar translate=\"no\"\u003eSITE_ID\u003c/var\u003e`/versions/`\u003cvar translate=\"no\"\u003eVERSION_ID\u003c/var\u003e |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `status` | `enum (`[Status](/docs/reference/hosting/rest/v1beta1/sites.versions.files/list#Status)`)` The type of files that should be listed for the specified version. |\n| `pageSize` | `integer` The maximum number of version files to return. The service may return a lower number if fewer version files exist than this maximum number. If unspecified, defaults to 1000. |\n| `pageToken` | `string` A token from a previous call to `files.list` that tells the server where to resume listing. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"files\": [ { object (/docs/reference/hosting/rest/v1beta1/sites.versions.files/list#VersionFile) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `files[]` | `object (`[VersionFile](/docs/reference/hosting/rest/v1beta1/sites.versions.files/list#VersionFile)`)` The list of paths to the hashes of the files in the specified version. |\n| `nextPageToken` | `string` The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to `files.list`. Page tokens are short-lived and should not be stored. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/firebase.hosting.readonly`\n- `\n https://www.googleapis.com/auth/firebase.hosting`\n- `\n https://www.googleapis.com/auth/firebase.readonly`\n- `\n https://www.googleapis.com/auth/firebase`\n- `\n https://www.googleapis.com/auth/cloud-platform.read-only`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\nStatus\n------\n\nThe current status of the files being added to a version.\n\n| Enums ||\n|----------------------|----------------------------------------------------------------------------------------------|\n| `STATUS_UNSPECIFIED` | The default status; should not be intentionally used. |\n| `EXPECTED` | The file has been included in the version and is expected to be uploaded in the near future. |\n| `ACTIVE` | The file has already been uploaded to Firebase Hosting. |\n\nVersionFile\n-----------\n\nA static content file that is part of a version.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"path\": string, \"hash\": string, \"status\": enum (/docs/reference/hosting/rest/v1beta1/sites.versions.files/list#Status) } ``` |\n\n| Fields ||\n|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `path` | `string` The URI at which the file's content should display. |\n| `hash` | `string` The SHA256 content hash of the file. |\n| `status` | `enum (`[Status](/docs/reference/hosting/rest/v1beta1/sites.versions.files/list#Status)`)` Output only. The current status of a particular file in the specified version. The value will be either `pending upload` or `uploaded`. |"]]
