Package-level declarations

Types

Link copied to clipboard
data class ActingUserResponse(val email: String, val imageUrl: String)

Contains metadata about the user who performed an action, such as creating a release or finalizing a version.

Link copied to clipboard
data class CertDnsChallengeResponse(val domainName: String, val token: String)

Represents a DNS certificate challenge.

Link copied to clipboard
data class CertHttpChallengeResponse(val path: String, val token: String)

Represents an HTTP certificate challenge.

Link copied to clipboard
data class CloudRunRewriteResponse(val region: String, val serviceId: String, val tag: String)

A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a 404 error).

Link copied to clipboard
data class DomainProvisioningResponse(val certChallengeDiscoveredTxt: List<String>, val certChallengeDns: CertDnsChallengeResponse, val certChallengeHttp: CertHttpChallengeResponse, val certStatus: String, val discoveredIps: List<String>, val dnsFetchTime: String, val dnsStatus: String, val expectedIps: List<String>)

The current certificate provisioning status information for a domain.

Link copied to clipboard
data class DomainRedirectResponse(val domainName: String, val type: String)

Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration.

Link copied to clipboard
data class GetChannelResult(val createTime: String, val expireTime: String, val labels: Map<String, String>, val name: String, val release: ReleaseResponse, val retainedReleaseCount: Int, val ttl: String, val updateTime: String, val url: String)
Link copied to clipboard
data class GetDomainResult(val domainName: String, val domainRedirect: DomainRedirectResponse, val provisioning: DomainProvisioningResponse, val site: String, val status: String, val updateTime: String)
Link copied to clipboard
data class GetReleaseResult(val message: String, val name: String, val releaseTime: String, val releaseUser: ActingUserResponse, val type: String, val version: VersionResponse)
Link copied to clipboard
data class GetSiteResult(val appId: String, val defaultUrl: String, val labels: Map<String, String>, val name: String, val type: String)
Link copied to clipboard
data class GetVersionResult(val config: ServingConfigResponse, val createTime: String, val createUser: ActingUserResponse, val deleteTime: String, val deleteUser: ActingUserResponse, val fileCount: String, val finalizeTime: String, val finalizeUser: ActingUserResponse, val labels: Map<String, String>, val name: String, val status: String, val versionBytes: String)
Link copied to clipboard
data class HeaderResponse(val glob: String, val headers: Map<String, String>, val regex: String)

A Header specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

Link copied to clipboard
data class I18nConfigResponse(val root: String)

If provided, i18n rewrites are enabled.

Link copied to clipboard
data class RedirectResponse(val glob: String, val location: String, val regex: String, val statusCode: Int)

A Redirect specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

Link copied to clipboard
data class ReleaseResponse(val message: String, val name: String, val releaseTime: String, val releaseUser: ActingUserResponse, val type: String, val version: VersionResponse)

A Release is a particular sites.versions that is set to be public at a particular time.

Link copied to clipboard
data class RewriteResponse(val dynamicLinks: Boolean, val function: String, val functionRegion: String, val glob: String, val path: String, val regex: String, val run: CloudRunRewriteResponse)

A Rewrite 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.

Link copied to clipboard
data class ServingConfigResponse(val appAssociation: String, val cleanUrls: Boolean, val headers: List<HeaderResponse>, val i18n: I18nConfigResponse, val redirects: List<RedirectResponse>, val rewrites: List<RewriteResponse>, val trailingSlashBehavior: String)

The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific priority order.

Link copied to clipboard
data class VersionResponse(val config: ServingConfigResponse, val createTime: String, val createUser: ActingUserResponse, val deleteTime: String, val deleteUser: ActingUserResponse, val fileCount: String, val finalizeTime: String, val finalizeUser: ActingUserResponse, val labels: Map<String, String>, val name: String, val status: String, val versionBytes: String)

A Version is a configuration and a collection of static files which determine how a site is displayed.