docs: update generated docs (#981)
diff --git a/docs/dyn/firebasehosting_v1beta1.projects.sites.releases.html b/docs/dyn/firebasehosting_v1beta1.projects.sites.releases.html
index dbaa054..7dd9bed 100644
--- a/docs/dyn/firebasehosting_v1beta1.projects.sites.releases.html
+++ b/docs/dyn/firebasehosting_v1beta1.projects.sites.releases.html
@@ -100,36 +100,107 @@
# that is set to be public at a particular time.
"version": { # A `Version` is the collection of configuration and # Output only. The configuration and content that was released.
# [static files](sites.versions.files) that determine how a site is displayed.
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `DELETED` the version.
+ "createUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the version.
# a release or finalizing a 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.
- },
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `FINALIZED` the version.
- # a release or finalizing a 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.
},
- "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "preview": { # Version preview configuration. If active and unexpired, # Version preview configuration for the site version. This configuration
- # specfies 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.
- # this version will be accessible via a custom URL even
- # if it is not the currently released 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.
- },
+ "name": "A String", # The unique identifier for a version, in the format:
+ # <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
+ # This name is provided in the response body when you call the
+ # [`CreateVersion`](../sites.versions/create) endpoint.
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "createTime": "A String", # Output only. The time at which the version was created.
+ "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
+ "config": { # The configuration for how incoming requests to a site should be routed and # The configuration for the behavior of the site. This configuration exists
+ # in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ # 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).
+ "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",
+ },
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request
+ # URL path.
+ },
+ ],
+ "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.
+ # <br>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:
+ # <code>"glob": "/:capture*",
+ # <br>"statusCode": 301,
+ # <br>"location": "https://example.com/foo/:capture"</code>
+ "glob": "A String", # The user-supplied
+ # [glob](/docs/hosting/full-config#glob_pattern_matching) 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.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request
+ # URL path.
+ },
+ ],
+ "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
+ "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.
+ "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.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request
+ # URL path.
+ "function": "A String", # The function to proxy requests to. Must match the exported function
+ # name exactly.
+ "run": { # A configured rewrite that directs requests to a Cloud Run service. If the # The request will be forwarded to Cloud Run.
+ # 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).
+ "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted.<br>
+ # Defaults to `us-central1` if not supplied.
+ "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
+ },
+ },
+ ],
+ "appAssociation": "A String", # How to handle well known App Association files.
+ "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
+ },
+ "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `DELETED` the version.
+ # a release or finalizing a 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.
+ },
"versionBytes": "A String", # Output only. The total stored bytesize of the version.
# <br>This value is calculated after a version is `FINALIZED`.
- "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "fileCount": "A String", # Output only. The total number of files associated with the version.
+ # <br>This value is calculated after a version is `FINALIZED`.
"status": "A String", # The deploy status of a version.
# <br>
# <br>For a successful deploy, call the
@@ -144,106 +215,39 @@
# <br>
# <br>You can also change the status of a version to `DELETED` by calling the
# [`DeleteVersion`](sites.versions/delete) endpoint.
- "config": { # The configuration for how incoming requests to a site should be routed and # The configuration for the behavior of the site. This configuration exists
- # in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
- # processed before serving content. The patterns are matched and applied
- # according to a specific
- # [priority order](/docs/hosting/full-config#hosting_priority_order).
- "redirects": [ # A list of globs that will cause the response to redirect to another
- # location.
- { # A [`redirect`](/docs/hosting/full-config#redirects) represents the
- # configuration for returning an HTTP redirect response given a matching
- # request URL path.
- "glob": "A String", # The user-supplied [glob
- # pattern](/docs/hosting/full-config#glob_pattern_matching) 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.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request
- # URL path.
- "location": "A String", # Required. The value to put in the HTTP location header of the response.
- # <br>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:
- # <code>"glob": "/:capture*",
- # <br>"statusCode": 301,
- # <br>"location": "https://example.com/foo/:capture"</code>
- },
- ],
- "headers": [ # A list of custom response headers that are added to the content if the
- # request URL path matches the glob.
- { # A [`header`](/docs/hosting/full-config#headers) defines custom headers to
- # add to a response should the request URL path match the pattern.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request
- # URL path.
- "glob": "A String", # The user-supplied [glob
- # pattern](/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",
- },
- },
- ],
- "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.
- "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
- "rewrites": [ # A list of rewrites that will act as if the service were given the
- # destination URL.
- { # A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal
- # content rewrite on the version. If the pattern matches, the request will be
- # handled as if it were to the destination path specified in the
- # configuration.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request
- # URL path.
- "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "run": { # A configured rewrite that directs requests to a Cloud Run service. If the # The request will be forwarded to Cloud Run.
- # 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).
- "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted.<br>
- # Defaults to `us-central1` if not supplied.
- "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
- },
- "glob": "A String", # The user-supplied [glob
- # pattern](/docs/hosting/full-config#glob_pattern_matching) to match
- # against the request URL path.
- "path": "A String", # The URL path to rewrite the request to.
- "function": "A String", # The function to proxy requests to. Must match the exported function
- # name exactly.
- },
- ],
+ "preview": { # Version preview configuration. If active and unexpired, # Version preview configuration for the site version. This configuration
+ # specfies 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.
+ # this version will be accessible via a custom URL even
+ # if it is not the currently released 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:
- # <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
- # This name is provided in the response body when you call the
- # [`CreateVersion`](../sites.versions/create) endpoint.
- "createUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the version.
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `FINALIZED` the version.
# a release or finalizing a 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.
+ "email": "A String", # The email address of the user when the user performed the action.
},
- "fileCount": "A String", # Output only. The total number of files associated with the version.
- # <br>This value is calculated after a version is `FINALIZED`.
},
"message": "A String", # The deploy description when the release was created. The value can be up to
# 512&nbsp;characters.
+ "type": "A String", # Explains the reason for the release.
+ # <br>Specify a value for this field only when creating a `SITE_DISABLE`
+ # type release.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the release.
# a release or finalizing a 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.
+ "email": "A String", # The email address of the user when the user performed the action.
},
- "releaseTime": "A String", # Output only. The time at which the version is set to be public.
"name": "A String", # Output only. The unique identifier for the release, in the format:
# <code>sites/<var>site-name</var>/releases/<var>releaseID</var></code>
# This name is provided in the response body when you call the
# [`CreateRelease`](sites.releases/create) endpoint.
- "type": "A String", # Explains the reason for the release.
- # <br>Specify a value for this field only when creating a `SITE_DISABLE`
- # type release.
+ "releaseTime": "A String", # Output only. The time at which the version is set to be public.
}
versionName: string, The unique identifier for a version, in the format:
@@ -266,36 +270,107 @@
# that is set to be public at a particular time.
"version": { # A `Version` is the collection of configuration and # Output only. The configuration and content that was released.
# [static files](sites.versions.files) that determine how a site is displayed.
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `DELETED` the version.
+ "createUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the version.
# a release or finalizing a 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.
- },
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `FINALIZED` the version.
- # a release or finalizing a 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.
},
- "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "preview": { # Version preview configuration. If active and unexpired, # Version preview configuration for the site version. This configuration
- # specfies 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.
- # this version will be accessible via a custom URL even
- # if it is not the currently released 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.
- },
+ "name": "A String", # The unique identifier for a version, in the format:
+ # <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
+ # This name is provided in the response body when you call the
+ # [`CreateVersion`](../sites.versions/create) endpoint.
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "createTime": "A String", # Output only. The time at which the version was created.
+ "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
+ "config": { # The configuration for how incoming requests to a site should be routed and # The configuration for the behavior of the site. This configuration exists
+ # in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ # 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).
+ "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",
+ },
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request
+ # URL path.
+ },
+ ],
+ "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.
+ # <br>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:
+ # <code>"glob": "/:capture*",
+ # <br>"statusCode": 301,
+ # <br>"location": "https://example.com/foo/:capture"</code>
+ "glob": "A String", # The user-supplied
+ # [glob](/docs/hosting/full-config#glob_pattern_matching) 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.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request
+ # URL path.
+ },
+ ],
+ "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
+ "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.
+ "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.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request
+ # URL path.
+ "function": "A String", # The function to proxy requests to. Must match the exported function
+ # name exactly.
+ "run": { # A configured rewrite that directs requests to a Cloud Run service. If the # The request will be forwarded to Cloud Run.
+ # 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).
+ "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted.<br>
+ # Defaults to `us-central1` if not supplied.
+ "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
+ },
+ },
+ ],
+ "appAssociation": "A String", # How to handle well known App Association files.
+ "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
+ },
+ "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `DELETED` the version.
+ # a release or finalizing a 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.
+ },
"versionBytes": "A String", # Output only. The total stored bytesize of the version.
# <br>This value is calculated after a version is `FINALIZED`.
- "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "fileCount": "A String", # Output only. The total number of files associated with the version.
+ # <br>This value is calculated after a version is `FINALIZED`.
"status": "A String", # The deploy status of a version.
# <br>
# <br>For a successful deploy, call the
@@ -310,106 +385,39 @@
# <br>
# <br>You can also change the status of a version to `DELETED` by calling the
# [`DeleteVersion`](sites.versions/delete) endpoint.
- "config": { # The configuration for how incoming requests to a site should be routed and # The configuration for the behavior of the site. This configuration exists
- # in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
- # processed before serving content. The patterns are matched and applied
- # according to a specific
- # [priority order](/docs/hosting/full-config#hosting_priority_order).
- "redirects": [ # A list of globs that will cause the response to redirect to another
- # location.
- { # A [`redirect`](/docs/hosting/full-config#redirects) represents the
- # configuration for returning an HTTP redirect response given a matching
- # request URL path.
- "glob": "A String", # The user-supplied [glob
- # pattern](/docs/hosting/full-config#glob_pattern_matching) 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.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request
- # URL path.
- "location": "A String", # Required. The value to put in the HTTP location header of the response.
- # <br>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:
- # <code>"glob": "/:capture*",
- # <br>"statusCode": 301,
- # <br>"location": "https://example.com/foo/:capture"</code>
- },
- ],
- "headers": [ # A list of custom response headers that are added to the content if the
- # request URL path matches the glob.
- { # A [`header`](/docs/hosting/full-config#headers) defines custom headers to
- # add to a response should the request URL path match the pattern.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request
- # URL path.
- "glob": "A String", # The user-supplied [glob
- # pattern](/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",
- },
- },
- ],
- "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.
- "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
- "rewrites": [ # A list of rewrites that will act as if the service were given the
- # destination URL.
- { # A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal
- # content rewrite on the version. If the pattern matches, the request will be
- # handled as if it were to the destination path specified in the
- # configuration.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request
- # URL path.
- "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "run": { # A configured rewrite that directs requests to a Cloud Run service. If the # The request will be forwarded to Cloud Run.
- # 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).
- "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted.<br>
- # Defaults to `us-central1` if not supplied.
- "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
- },
- "glob": "A String", # The user-supplied [glob
- # pattern](/docs/hosting/full-config#glob_pattern_matching) to match
- # against the request URL path.
- "path": "A String", # The URL path to rewrite the request to.
- "function": "A String", # The function to proxy requests to. Must match the exported function
- # name exactly.
- },
- ],
+ "preview": { # Version preview configuration. If active and unexpired, # Version preview configuration for the site version. This configuration
+ # specfies 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.
+ # this version will be accessible via a custom URL even
+ # if it is not the currently released 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:
- # <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
- # This name is provided in the response body when you call the
- # [`CreateVersion`](../sites.versions/create) endpoint.
- "createUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the version.
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `FINALIZED` the version.
# a release or finalizing a 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.
+ "email": "A String", # The email address of the user when the user performed the action.
},
- "fileCount": "A String", # Output only. The total number of files associated with the version.
- # <br>This value is calculated after a version is `FINALIZED`.
},
"message": "A String", # The deploy description when the release was created. The value can be up to
# 512&nbsp;characters.
+ "type": "A String", # Explains the reason for the release.
+ # <br>Specify a value for this field only when creating a `SITE_DISABLE`
+ # type release.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the release.
# a release or finalizing a 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.
+ "email": "A String", # The email address of the user when the user performed the action.
},
- "releaseTime": "A String", # Output only. The time at which the version is set to be public.
"name": "A String", # Output only. The unique identifier for the release, in the format:
# <code>sites/<var>site-name</var>/releases/<var>releaseID</var></code>
# This name is provided in the response body when you call the
# [`CreateRelease`](sites.releases/create) endpoint.
- "type": "A String", # Explains the reason for the release.
- # <br>Specify a value for this field only when creating a `SITE_DISABLE`
- # type release.
+ "releaseTime": "A String", # Output only. The time at which the version is set to be public.
}</pre>
</div>
@@ -437,36 +445,107 @@
# that is set to be public at a particular time.
"version": { # A `Version` is the collection of configuration and # Output only. The configuration and content that was released.
# [static files](sites.versions.files) that determine how a site is displayed.
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `DELETED` the version.
+ "createUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the version.
# a release or finalizing a 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.
- },
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `FINALIZED` the version.
- # a release or finalizing a 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.
},
- "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "preview": { # Version preview configuration. If active and unexpired, # Version preview configuration for the site version. This configuration
- # specfies 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.
- # this version will be accessible via a custom URL even
- # if it is not the currently released 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.
- },
+ "name": "A String", # The unique identifier for a version, in the format:
+ # <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
+ # This name is provided in the response body when you call the
+ # [`CreateVersion`](../sites.versions/create) endpoint.
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "createTime": "A String", # Output only. The time at which the version was created.
+ "deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
+ "config": { # The configuration for how incoming requests to a site should be routed and # The configuration for the behavior of the site. This configuration exists
+ # in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ # 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).
+ "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",
+ },
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request
+ # URL path.
+ },
+ ],
+ "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.
+ # <br>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:
+ # <code>"glob": "/:capture*",
+ # <br>"statusCode": 301,
+ # <br>"location": "https://example.com/foo/:capture"</code>
+ "glob": "A String", # The user-supplied
+ # [glob](/docs/hosting/full-config#glob_pattern_matching) 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.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request
+ # URL path.
+ },
+ ],
+ "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
+ "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.
+ "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.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request
+ # URL path.
+ "function": "A String", # The function to proxy requests to. Must match the exported function
+ # name exactly.
+ "run": { # A configured rewrite that directs requests to a Cloud Run service. If the # The request will be forwarded to Cloud Run.
+ # 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).
+ "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted.<br>
+ # Defaults to `us-central1` if not supplied.
+ "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
+ },
+ },
+ ],
+ "appAssociation": "A String", # How to handle well known App Association files.
+ "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
+ },
+ "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `DELETED` the version.
+ # a release or finalizing a 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.
+ },
"versionBytes": "A String", # Output only. The total stored bytesize of the version.
# <br>This value is calculated after a version is `FINALIZED`.
- "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "fileCount": "A String", # Output only. The total number of files associated with the version.
+ # <br>This value is calculated after a version is `FINALIZED`.
"status": "A String", # The deploy status of a version.
# <br>
# <br>For a successful deploy, call the
@@ -481,106 +560,39 @@
# <br>
# <br>You can also change the status of a version to `DELETED` by calling the
# [`DeleteVersion`](sites.versions/delete) endpoint.
- "config": { # The configuration for how incoming requests to a site should be routed and # The configuration for the behavior of the site. This configuration exists
- # in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
- # processed before serving content. The patterns are matched and applied
- # according to a specific
- # [priority order](/docs/hosting/full-config#hosting_priority_order).
- "redirects": [ # A list of globs that will cause the response to redirect to another
- # location.
- { # A [`redirect`](/docs/hosting/full-config#redirects) represents the
- # configuration for returning an HTTP redirect response given a matching
- # request URL path.
- "glob": "A String", # The user-supplied [glob
- # pattern](/docs/hosting/full-config#glob_pattern_matching) 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.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request
- # URL path.
- "location": "A String", # Required. The value to put in the HTTP location header of the response.
- # <br>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:
- # <code>"glob": "/:capture*",
- # <br>"statusCode": 301,
- # <br>"location": "https://example.com/foo/:capture"</code>
- },
- ],
- "headers": [ # A list of custom response headers that are added to the content if the
- # request URL path matches the glob.
- { # A [`header`](/docs/hosting/full-config#headers) defines custom headers to
- # add to a response should the request URL path match the pattern.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request
- # URL path.
- "glob": "A String", # The user-supplied [glob
- # pattern](/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",
- },
- },
- ],
- "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.
- "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
- "rewrites": [ # A list of rewrites that will act as if the service were given the
- # destination URL.
- { # A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal
- # content rewrite on the version. If the pattern matches, the request will be
- # handled as if it were to the destination path specified in the
- # configuration.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request
- # URL path.
- "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "run": { # A configured rewrite that directs requests to a Cloud Run service. If the # The request will be forwarded to Cloud Run.
- # 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).
- "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted.<br>
- # Defaults to `us-central1` if not supplied.
- "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
- },
- "glob": "A String", # The user-supplied [glob
- # pattern](/docs/hosting/full-config#glob_pattern_matching) to match
- # against the request URL path.
- "path": "A String", # The URL path to rewrite the request to.
- "function": "A String", # The function to proxy requests to. Must match the exported function
- # name exactly.
- },
- ],
+ "preview": { # Version preview configuration. If active and unexpired, # Version preview configuration for the site version. This configuration
+ # specfies 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.
+ # this version will be accessible via a custom URL even
+ # if it is not the currently released 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:
- # <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
- # This name is provided in the response body when you call the
- # [`CreateVersion`](../sites.versions/create) endpoint.
- "createUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the version.
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `FINALIZED` the version.
# a release or finalizing a 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.
+ "email": "A String", # The email address of the user when the user performed the action.
},
- "fileCount": "A String", # Output only. The total number of files associated with the version.
- # <br>This value is calculated after a version is `FINALIZED`.
},
"message": "A String", # The deploy description when the release was created. The value can be up to
# 512&nbsp;characters.
+ "type": "A String", # Explains the reason for the release.
+ # <br>Specify a value for this field only when creating a `SITE_DISABLE`
+ # type release.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the release.
# a release or finalizing a 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.
+ "email": "A String", # The email address of the user when the user performed the action.
},
- "releaseTime": "A String", # Output only. The time at which the version is set to be public.
"name": "A String", # Output only. The unique identifier for the release, in the format:
# <code>sites/<var>site-name</var>/releases/<var>releaseID</var></code>
# This name is provided in the response body when you call the
# [`CreateRelease`](sites.releases/create) endpoint.
- "type": "A String", # Explains the reason for the release.
- # <br>Specify a value for this field only when creating a `SITE_DISABLE`
- # type release.
+ "releaseTime": "A String", # Output only. The time at which the version is set to be public.
},
],
"nextPageToken": "A String", # If there are additional releases remaining beyond the ones in this