chore: update docs/dyn , add static discovery files to discovery_cache/documents (#1111)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/78f53313-0c78-4a29-8841-f031665a4c6a/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/firebasehosting_v1beta1.sites.versions.html b/docs/dyn/firebasehosting_v1beta1.sites.versions.html
index 47bbd27..95a7c02 100644
--- a/docs/dyn/firebasehosting_v1beta1.sites.versions.html
+++ b/docs/dyn/firebasehosting_v1beta1.sites.versions.html
@@ -86,13 +86,13 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body=None, versionId=None, sizeBytes=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, sizeBytes=None, versionId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new version for a site.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified version.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the versions that have been created on the specified site. Will include filtering in the future.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -137,23 +137,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
@@ -163,7 +163,7 @@
</div>
<div class="method">
- <code class="details" id="create">create(parent, body=None, versionId=None, sizeBytes=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, sizeBytes=None, versionId=None, x__xgafv=None)</code>
<pre>Creates a new version for a site.
Args:
@@ -173,73 +173,73 @@
{ # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed.
"createTime": "A String", # Output only. The time at which the version was created.
+ "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
+ "active": True or False, # If true, preview URLs are enabled for this version.
+ },
+ "name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
+ "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
+ "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
+ "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
+ "createUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "labels": { # The labels used for extra metadata and/or filtering.
+ "a_key": "A String",
+ },
"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
+ { # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
+ "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
+ },
+ ],
"appAssociation": "A String", # How to handle well known App Association files.
"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
+ "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
+ "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
+ },
"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
- "path": "A String", # The URL path to rewrite the request to.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
+ "path": "A String", # The URL path to rewrite the request to.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
},
- },
- ],
- "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
- "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
- },
- "redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
- { # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
- "location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
- "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
},
],
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
},
],
},
- "createUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
- "active": True or False, # If true, preview URLs are enabled for this version.
- "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
- },
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
- "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "labels": { # The labels used for extra metadata and/or filtering.
- "a_key": "A String",
- },
- "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
- "name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
- "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
}
- versionId: string, A unique id for the new version. This is was only specified for legacy version creations, and should be blank.
sizeBytes: string, The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads.
+ versionId: string, A unique id for the new version. This is was only specified for legacy version creations, and should be blank.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -250,69 +250,69 @@
{ # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed.
"createTime": "A String", # Output only. The time at which the version was created.
+ "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
+ "active": True or False, # If true, preview URLs are enabled for this version.
+ },
+ "name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
+ "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
+ "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
+ "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
+ "createUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "labels": { # The labels used for extra metadata and/or filtering.
+ "a_key": "A String",
+ },
"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
+ { # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
+ "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
+ },
+ ],
"appAssociation": "A String", # How to handle well known App Association files.
"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
+ "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
+ "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
+ },
"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
- "path": "A String", # The URL path to rewrite the request to.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
+ "path": "A String", # The URL path to rewrite the request to.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
},
- },
- ],
- "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
- "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
- },
- "redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
- { # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
- "location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
- "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
},
],
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
},
],
},
- "createUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
- "active": True or False, # If true, preview URLs are enabled for this version.
- "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
- },
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
- "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "labels": { # The labels used for extra metadata and/or filtering.
- "a_key": "A String",
- },
- "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
- "name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
- "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
}</pre>
</div>
@@ -335,13 +335,13 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
<pre>Lists the versions that have been created on the specified site. Will include filtering in the future.
Args:
parent: string, Required. The parent for which to list files, in the format: sites/site-name (required)
- pageSize: integer, The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100
pageToken: string, The next_page_token from a previous request, if provided.
+ pageSize: integer, The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100
filter: string, The filter string used to return a subset of versions in the response. Currently supported fields for filtering are: name, status, and create_time. Filter processing will be implemented in accordance with go/filtering.
x__xgafv: string, V1 error format.
Allowed values
@@ -356,69 +356,69 @@
"versions": [ # The list of versions, if any exist.
{ # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed.
"createTime": "A String", # Output only. The time at which the version was created.
+ "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
+ "active": True or False, # If true, preview URLs are enabled for this version.
+ },
+ "name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
+ "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
+ "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
+ "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
+ "createUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "labels": { # The labels used for extra metadata and/or filtering.
+ "a_key": "A String",
+ },
"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
+ { # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
+ "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
+ },
+ ],
"appAssociation": "A String", # How to handle well known App Association files.
"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
+ "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
+ "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
+ },
"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
- "path": "A String", # The URL path to rewrite the request to.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
+ "path": "A String", # The URL path to rewrite the request to.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
},
- },
- ],
- "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
- "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
- },
- "redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
- { # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
- "location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
- "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
},
],
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
},
],
},
- "createUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
- "active": True or False, # If true, preview URLs are enabled for this version.
- "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
- },
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
- "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "labels": { # The labels used for extra metadata and/or filtering.
- "a_key": "A String",
- },
- "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
- "name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
- "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
},
],
}</pre>
@@ -449,69 +449,69 @@
{ # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed.
"createTime": "A String", # Output only. The time at which the version was created.
+ "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
+ "active": True or False, # If true, preview URLs are enabled for this version.
+ },
+ "name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
+ "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
+ "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
+ "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
+ "createUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "labels": { # The labels used for extra metadata and/or filtering.
+ "a_key": "A String",
+ },
"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
+ { # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
+ "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
+ },
+ ],
"appAssociation": "A String", # How to handle well known App Association files.
"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
+ "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
+ "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
+ },
"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
- "path": "A String", # The URL path to rewrite the request to.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
+ "path": "A String", # The URL path to rewrite the request to.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
},
- },
- ],
- "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
- "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
- },
- "redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
- { # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
- "location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
- "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
},
],
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
},
],
},
- "createUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
- "active": True or False, # If true, preview URLs are enabled for this version.
- "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
- },
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
- "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "labels": { # The labels used for extra metadata and/or filtering.
- "a_key": "A String",
- },
- "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
- "name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
- "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
}
updateMask: string, A set of field names from your [version](../sites.versions) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`status`](../sites.versions#Version.FIELDS.status) will be used.
@@ -525,69 +525,69 @@
{ # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed.
"createTime": "A String", # Output only. The time at which the version was created.
+ "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
+ "active": True or False, # If true, preview URLs are enabled for this version.
+ },
+ "name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
+ "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
+ "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
+ "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
+ "createUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
+ "email": "A String", # The email address of the user when the user performed the action.
+ "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
+ },
+ "labels": { # The labels used for extra metadata and/or filtering.
+ "a_key": "A String",
+ },
"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
+ { # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
+ "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
+ },
+ ],
"appAssociation": "A String", # How to handle well known App Association files.
"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
+ "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
+ "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
+ },
"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
- "path": "A String", # The URL path to rewrite the request to.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
+ "path": "A String", # The URL path to rewrite the request to.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
},
- },
- ],
- "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
- "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
- },
- "redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
- { # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
- "location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
- "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
},
],
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
},
],
},
- "createUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
- "active": True or False, # If true, preview URLs are enabled for this version.
- "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
- },
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
- "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
- "imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
- "email": "A String", # The email address of the user when the user performed the action.
- },
- "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "labels": { # The labels used for extra metadata and/or filtering.
- "a_key": "A String",
- },
- "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
- "name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
- "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
}</pre>
</div>