| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="firebasehosting_v1beta1.html">Firebase Hosting API</a> . <a href="firebasehosting_v1beta1.sites.html">sites</a> . <a href="firebasehosting_v1beta1.sites.versions.html">versions</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="firebasehosting_v1beta1.sites.versions.files.html">files()</a></code> |
| </p> |
| <p class="firstline">Returns the files Resource.</p> |
| |
| <p class="toc_element"> |
| <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, 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.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the specified metadata for a version. Note that this method will</p> |
| <p class="toc_element"> |
| <code><a href="#populateFiles">populateFiles(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Adds content files to a version.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <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: |
| parent: string, Required. The parent to create the version for, in the format: |
| <code>sites/<var>site-name</var></code> (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A `Version` is the collection of configuration and |
| # [static files](sites.versions.files) that determine how a site is displayed. |
| "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. |
| "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. |
| }, |
| "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", |
| }, |
| "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`. |
| "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 |
| # [`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. |
| # <br> |
| # <br>Note that if you leave the version in the `CREATED` state for more |
| # than 12&nbsp;hours, the system will automatically mark the version as |
| # `ABANDONED`. |
| # <br> |
| # <br>You can also change the status of a version to `DELETED` by calling the |
| # [`DeleteVersion`](sites.versions/delete) endpoint. |
| "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. |
| }, |
| "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. |
| "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. |
| }, |
| } |
| |
| 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 only specified for legacy version |
| creations. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A `Version` is the collection of configuration and |
| # [static files](sites.versions.files) that determine how a site is displayed. |
| "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. |
| "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. |
| }, |
| "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", |
| }, |
| "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`. |
| "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 |
| # [`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. |
| # <br> |
| # <br>Note that if you leave the version in the `CREATED` state for more |
| # than 12&nbsp;hours, the system will automatically mark the version as |
| # `ABANDONED`. |
| # <br> |
| # <br>You can also change the status of a version to `DELETED` by calling the |
| # [`DeleteVersion`](sites.versions/delete) endpoint. |
| "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. |
| }, |
| "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. |
| "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. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes the specified version. |
| |
| Args: |
| name: string, Required. The name of the version to be deleted, in the format: |
| <code>sites/<var>site-name</var>/versions/<var>versionID</var></code> (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated |
| # empty messages in your APIs. A typical example is to use it as the request |
| # or the response type of an API method. For instance: |
| # |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <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: |
| <code>sites/<var>site-name</var></code> (required) |
| 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 |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "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. |
| "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. |
| "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. |
| }, |
| "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", |
| }, |
| "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`. |
| "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 |
| # [`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. |
| # <br> |
| # <br>Note that if you leave the version in the `CREATED` state for more |
| # than 12&nbsp;hours, the system will automatically mark the version as |
| # `ABANDONED`. |
| # <br> |
| # <br>You can also change the status of a version to `DELETED` by calling the |
| # [`DeleteVersion`](sites.versions/delete) endpoint. |
| "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. |
| }, |
| "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. |
| "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. |
| }, |
| }, |
| ], |
| "nextPageToken": "A String", # The pagination token, if more results exist |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates the specified metadata for a version. Note that this method will |
| fail with `FAILED_PRECONDITION` in the event of an invalid state |
| transition. The only valid transition for a version is currently from a |
| `CREATED` status to a `FINALIZED` status. |
| Use [`DeleteVersion`](../sites.versions/delete) to set the status of a |
| version to `DELETED`. |
| |
| Args: |
| name: 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. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A `Version` is the collection of configuration and |
| # [static files](sites.versions.files) that determine how a site is displayed. |
| "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. |
| "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. |
| }, |
| "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", |
| }, |
| "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`. |
| "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 |
| # [`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. |
| # <br> |
| # <br>Note that if you leave the version in the `CREATED` state for more |
| # than 12&nbsp;hours, the system will automatically mark the version as |
| # `ABANDONED`. |
| # <br> |
| # <br>You can also change the status of a version to `DELETED` by calling the |
| # [`DeleteVersion`](sites.versions/delete) endpoint. |
| "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. |
| }, |
| "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. |
| "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. |
| }, |
| } |
| |
| updateMask: string, A set of field names from your [version](../sites.versions) that you want |
| to update. |
| <br>A field will be overwritten if, and only if, it's in the mask. |
| <br>If a mask is not provided then a default mask of only |
| [`status`](../sites.versions#Version.FIELDS.status) will be used. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A `Version` is the collection of configuration and |
| # [static files](sites.versions.files) that determine how a site is displayed. |
| "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. |
| "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. |
| }, |
| "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", |
| }, |
| "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`. |
| "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 |
| # [`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. |
| # <br> |
| # <br>Note that if you leave the version in the `CREATED` state for more |
| # than 12&nbsp;hours, the system will automatically mark the version as |
| # `ABANDONED`. |
| # <br> |
| # <br>You can also change the status of a version to `DELETED` by calling the |
| # [`DeleteVersion`](sites.versions/delete) endpoint. |
| "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. |
| }, |
| "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. |
| "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. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="populateFiles">populateFiles(parent, body=None, x__xgafv=None)</code> |
| <pre>Adds content files to a version. |
| Each file must be under 2 GB. |
| |
| Args: |
| parent: string, Required. The version to add files to, in the format: |
| <code>sites/<var>site-name</var>/versions/<var>versionID</var></code> (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The request to populate a Version's Files. |
| "files": { # A set of file paths to the hashes corresponding to assets that should be |
| # added to the version. Note that a file path to an empty hash will remove |
| # the path from the version. Calculate a hash by Gzipping the file then |
| # taking the SHA256 hash of the newly compressed file. |
| "a_key": "A String", |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "uploadRequiredHashes": [ # The content hashes of the specified files that need to be uploaded to the |
| # specified endpoint. |
| "A String", |
| ], |
| "uploadUrl": "A String", # The URL to which the files should be uploaded, in the format: |
| # <br>"https://upload-firebasehosting.googleapis.com/upload/sites/<var>site-name</var>/versions/<var>versionID</var>/files". |
| # <br>Perform a multipart `POST` of the Gzipped file contents to the URL |
| # using a forward slash and the hash of the file appended to the end. |
| }</pre> |
| </div> |
| |
| </body></html> |
