chore: Update discovery artifacts (#1269)
* chore(accessapproval): update the api
* chore(accesscontextmanager): update the api
* chore(apigateway): update the api
* chore(area120tables): update the api
* chore(bigquerydatatransfer): update the api
* chore(billingbudgets): update the api
* chore(calendar): update the api
* chore(chat): update the api
* chore(cloudbilling): update the api
* chore(cloudfunctions): update the api
* chore(cloudkms): update the api
* chore(cloudprofiler): update the api
* chore(cloudscheduler): update the api
* chore(cloudshell): update the api
* chore(cloudtasks): update the api
* chore(composer): update the api
* chore(datalabeling): update the api
* chore(datamigration): update the api
* chore(deploymentmanager): update the api
* chore(dlp): update the api
* chore(doubleclickbidmanager): update the api
* chore(drive): update the api
* chore(driveactivity): update the api
* chore(eventarc): update the api
* chore(fcm): update the api
* chore(firebaseml): update the api
* chore(firestore): update the api
* chore(gameservices): update the api
* chore(genomics): update the api
* chore(groupsmigration): update the api
* chore(iam): update the api
* chore(language): update the api
* chore(libraryagent): update the api
* chore(lifesciences): update the api
* chore(logging): update the api
* chore(monitoring): update the api
* chore(policytroubleshooter): update the api
* chore(recommendationengine): update the api
* chore(recommender): update the api
* chore(redis): update the api
* chore(runtimeconfig): update the api
* chore(script): update the api
* chore(serviceconsumermanagement): update the api
* chore(servicedirectory): update the api
* chore(servicenetworking): update the api
* chore(serviceusage): update the api
* chore(sheets): update the api
* chore(texttospeech): update the api
* chore(toolresults): update the api
* chore(transcoder): update the api
* chore(translate): update the api
* chore(vision): update the api
* chore(workflows): update the api
Co-authored-by: Yoshi Automation <yoshi-automation@google.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
diff --git a/docs/dyn/firebasehosting_v1beta1.projects.sites.channels.html b/docs/dyn/firebasehosting_v1beta1.projects.sites.channels.html
index 9079a8c..dce0f05 100644
--- a/docs/dyn/firebasehosting_v1beta1.projects.sites.channels.html
+++ b/docs/dyn/firebasehosting_v1beta1.projects.sites.channels.html
@@ -87,19 +87,19 @@
<p class="firstline">Creates a new channel in the specified site.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a channel of a site. The `live` channel cannot be deleted.</p>
+<p class="firstline">Deletes the specified channel of the specified site. The `live` channel cannot be deleted.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Retrieves information for the specified channel of a site.</p>
+<p class="firstline">Retrieves information for the specified channel of the specified site.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists the channels for the specified site. All sites have a default "live" channel.</p>
+<p class="firstline">Lists the channels for the specified site. All sites have a default `live` channel.</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 information for the specified channel of a site. This method will implicitly create a channel if it doesn't exist.</p>
+<p class="firstline">Updates information for the specified channel of the specified site. Implicitly creates the channel if it doesn't already exist.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -111,20 +111,20 @@
<pre>Creates a new channel in the specified site.
Args:
- parent: string, Required. The site in which this channel should be created. (required)
+ parent: string, Required. The site in which to create this channel, in the format: sites/ SITE_ID (required)
body: object, The request body.
The object takes the form of:
-{ # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains.
+{ # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the Firebase-provided subdomains and any connected custom domains.
"createTime": "A String", # Output only. The time at which the channel was created.
- "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field.
+ "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in the output whether it's set directly or via the `ttl` field.
"labels": { # Text labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The fully-qualified identifier of the Channel.
- "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
+ "name": "A String", # The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID
+ "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
+ "name": "A String", # Output only. The unique identifier for the release, in either of the following formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when you call [`releases.create`](sites.releases/create) or [`channels.releases.create`](sites.channels.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
@@ -189,22 +189,22 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "name": "A String", # The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
+ "preview": { # Deprecated in favor of [site channels](sites.channels). # Deprecated in favor of [site channels](sites.channels).
"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.
},
- "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
+ "status": "A String", # The deploy status of the version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
"retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels.
"ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request.
"updateTime": "A String", # Output only. The time at which the channel was last updated.
- "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs.
+ "url": "A String", # Output only. The URL at which the content of this channel's current release can be viewed. This URL is a Firebase-provided subdomain of `web.app`. The content of this channel's current release can also be viewed at the Firebase-provided subdomain of `firebaseapp.com`. If this channel is the `live` channel for the Hosting site, then the content of this channel's current release can also be viewed at any connected custom domains.
}
- channelId: string, Required. Immutable. A unique id within the site to identify the channel.
+ channelId: string, Required. Immutable. A unique ID within the site that identifies the channel.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -213,16 +213,16 @@
Returns:
An object of the form:
- { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains.
+ { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the Firebase-provided subdomains and any connected custom domains.
"createTime": "A String", # Output only. The time at which the channel was created.
- "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field.
+ "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in the output whether it's set directly or via the `ttl` field.
"labels": { # Text labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The fully-qualified identifier of the Channel.
- "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
+ "name": "A String", # The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID
+ "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
+ "name": "A String", # Output only. The unique identifier for the release, in either of the following formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when you call [`releases.create`](sites.releases/create) or [`channels.releases.create`](sites.channels.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
@@ -287,28 +287,28 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "name": "A String", # The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
+ "preview": { # Deprecated in favor of [site channels](sites.channels). # Deprecated in favor of [site channels](sites.channels).
"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.
},
- "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
+ "status": "A String", # The deploy status of the version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
"retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels.
"ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request.
"updateTime": "A String", # Output only. The time at which the channel was last updated.
- "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs.
+ "url": "A String", # Output only. The URL at which the content of this channel's current release can be viewed. This URL is a Firebase-provided subdomain of `web.app`. The content of this channel's current release can also be viewed at the Firebase-provided subdomain of `firebaseapp.com`. If this channel is the `live` channel for the Hosting site, then the content of this channel's current release can also be viewed at any connected custom domains.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
- <pre>Deletes a channel of a site. The `live` channel cannot be deleted.
+ <pre>Deletes the specified channel of the specified site. The `live` channel cannot be deleted.
Args:
- name: string, Required. The fully-qualified identifier for the site. (required)
+ name: string, Required. The fully-qualified resource name for the channel, in the format: sites/SITE_ID/channels/CHANNEL_ID (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -323,10 +323,10 @@
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Retrieves information for the specified channel of a site.
+ <pre>Retrieves information for the specified channel of the specified site.
Args:
- name: string, Required. The fully-qualified identifier for the channel. (required)
+ name: string, Required. The fully-qualified resource name for the channel, in the format: sites/SITE_ID/channels/CHANNEL_ID (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -335,16 +335,16 @@
Returns:
An object of the form:
- { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains.
+ { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the Firebase-provided subdomains and any connected custom domains.
"createTime": "A String", # Output only. The time at which the channel was created.
- "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field.
+ "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in the output whether it's set directly or via the `ttl` field.
"labels": { # Text labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The fully-qualified identifier of the Channel.
- "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
+ "name": "A String", # The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID
+ "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
+ "name": "A String", # Output only. The unique identifier for the release, in either of the following formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when you call [`releases.create`](sites.releases/create) or [`channels.releases.create`](sites.channels.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
@@ -409,30 +409,30 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "name": "A String", # The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
+ "preview": { # Deprecated in favor of [site channels](sites.channels). # Deprecated in favor of [site channels](sites.channels).
"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.
},
- "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
+ "status": "A String", # The deploy status of the version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
"retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels.
"ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request.
"updateTime": "A String", # Output only. The time at which the channel was last updated.
- "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs.
+ "url": "A String", # Output only. The URL at which the content of this channel's current release can be viewed. This URL is a Firebase-provided subdomain of `web.app`. The content of this channel's current release can also be viewed at the Firebase-provided subdomain of `firebaseapp.com`. If this channel is the `live` channel for the Hosting site, then the content of this channel's current release can also be viewed at any connected custom domains.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists the channels for the specified site. All sites have a default "live" channel.
+ <pre>Lists the channels for the specified site. All sites have a default `live` channel.
Args:
- parent: string, Required. The site from which to list channels. (required)
- pageSize: integer, The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 channels will be returned. The maximum value is 100; valuupdateses above 100 will be coerced to 100
- pageToken: string, The next_page_token from a previous request, if provided.
+ parent: string, Required. The site for which to list channels, in the format: sites/SITE_ID (required)
+ pageSize: integer, The maximum number of channels to return. The service may return a lower number if fewer channels exist than this maximum number. If unspecified, defaults to 10. The maximum value is 100; values above 100 will be coerced to 100.
+ pageToken: string, A token from a previous call to `ListChannels` that tells the server where to resume listing.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -441,18 +441,18 @@
Returns:
An object of the form:
- { # The response returned by ListChannels.
+ {
"channels": [ # The list of channels.
- { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains.
+ { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the Firebase-provided subdomains and any connected custom domains.
"createTime": "A String", # Output only. The time at which the channel was created.
- "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field.
+ "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in the output whether it's set directly or via the `ttl` field.
"labels": { # Text labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The fully-qualified identifier of the Channel.
- "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
+ "name": "A String", # The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID
+ "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
+ "name": "A String", # Output only. The unique identifier for the release, in either of the following formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when you call [`releases.create`](sites.releases/create) or [`channels.releases.create`](sites.channels.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
@@ -517,22 +517,22 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "name": "A String", # The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
+ "preview": { # Deprecated in favor of [site channels](sites.channels). # Deprecated in favor of [site channels](sites.channels).
"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.
},
- "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
+ "status": "A String", # The deploy status of the version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
"retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels.
"ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request.
"updateTime": "A String", # Output only. The time at which the channel was last updated.
- "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs.
+ "url": "A String", # Output only. The URL at which the content of this channel's current release can be viewed. This URL is a Firebase-provided subdomain of `web.app`. The content of this channel's current release can also be viewed at the Firebase-provided subdomain of `firebaseapp.com`. If this channel is the `live` channel for the Hosting site, then the content of this channel's current release can also be viewed at any connected custom domains.
},
],
- "nextPageToken": "A String", # If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.channels/list) call to continue with the next set of releases.
+ "nextPageToken": "A String", # The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to `ListChannels`. Page tokens are short-lived and should not be stored.
}</pre>
</div>
@@ -552,23 +552,23 @@
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
- <pre>Updates information for the specified channel of a site. This method will implicitly create a channel if it doesn't exist.
+ <pre>Updates information for the specified channel of the specified site. Implicitly creates the channel if it doesn't already exist.
Args:
- name: string, The fully-qualified identifier of the Channel. (required)
+ name: string, The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID (required)
body: object, The request body.
The object takes the form of:
-{ # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains.
+{ # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the Firebase-provided subdomains and any connected custom domains.
"createTime": "A String", # Output only. The time at which the channel was created.
- "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field.
+ "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in the output whether it's set directly or via the `ttl` field.
"labels": { # Text labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The fully-qualified identifier of the Channel.
- "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
+ "name": "A String", # The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID
+ "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
+ "name": "A String", # Output only. The unique identifier for the release, in either of the following formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when you call [`releases.create`](sites.releases/create) or [`channels.releases.create`](sites.channels.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
@@ -633,19 +633,19 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "name": "A String", # The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
+ "preview": { # Deprecated in favor of [site channels](sites.channels). # Deprecated in favor of [site channels](sites.channels).
"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.
},
- "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
+ "status": "A String", # The deploy status of the version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
"retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels.
"ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request.
"updateTime": "A String", # Output only. The time at which the channel was last updated.
- "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs.
+ "url": "A String", # Output only. The URL at which the content of this channel's current release can be viewed. This URL is a Firebase-provided subdomain of `web.app`. The content of this channel's current release can also be viewed at the Firebase-provided subdomain of `firebaseapp.com`. If this channel is the `live` channel for the Hosting site, then the content of this channel's current release can also be viewed at any connected custom domains.
}
updateMask: string, A comma-separated list of fields to be updated in this request.
@@ -657,16 +657,16 @@
Returns:
An object of the form:
- { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains.
+ { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the Firebase-provided subdomains and any connected custom domains.
"createTime": "A String", # Output only. The time at which the channel was created.
- "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field.
+ "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in the output whether it's set directly or via the `ttl` field.
"labels": { # Text labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The fully-qualified identifier of the Channel.
- "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
+ "name": "A String", # The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID
+ "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
+ "name": "A String", # Output only. The unique identifier for the release, in either of the following formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when you call [`releases.create`](sites.releases/create) or [`channels.releases.create`](sites.channels.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
@@ -731,19 +731,19 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
- "preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
+ "name": "A String", # The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
+ "preview": { # Deprecated in favor of [site channels](sites.channels). # Deprecated in favor of [site channels](sites.channels).
"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.
},
- "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
+ "status": "A String", # The deploy status of the version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
"retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels.
"ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request.
"updateTime": "A String", # Output only. The time at which the channel was last updated.
- "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs.
+ "url": "A String", # Output only. The URL at which the content of this channel's current release can be viewed. This URL is a Firebase-provided subdomain of `web.app`. The content of this channel's current release can also be viewed at the Firebase-provided subdomain of `firebaseapp.com`. If this channel is the `live` channel for the Hosting site, then the content of this channel's current release can also be viewed at any connected custom domains.
}</pre>
</div>