Show / Hide Table of Contents

Namespace Google.Apis.FirebaseHosting.v1beta1.Data

Classes

ActingUser

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

CertDnsChallenge

Represents a DNS certificate challenge.

CertHttpChallenge

Represents an HTTP certificate challenge.

CertVerification

A set of ACME challenges you can use to allow Hosting to create an SSL certificate for your domain name before directing traffic to Hosting servers. Use either the DNS or HTTP challenge; it's not necessary to provide both.

Certificate

An SSL certificate used to provide end-to-end encryption for requests against your domain name. A Certificate can be an actual SSL certificate or, for newly-created custom domains, Hosting's intent to create one.

Channel

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.

CloneVersionRequest

CloudRunRewrite

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).

CustomDomain

A CustomDomain is an entity that links a domain name to a Firebase Hosting site. Add a CustomDomain to your site to allow Hosting to serve the site's content in response to requests against your domain name.

CustomDomainMetadata

Metadata associated with aCustomDomain operation.

DnsRecord

DNS records are resource records that define how systems and services should behave when handling requests for a domain name. For example, when you add A records to your domain name's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain name (such as your Hosting site files).

DnsRecordSet

A set of DNS records relevant to the setup and maintenance of a custom domain in Firebase Hosting.

DnsUpdates

A set of DNS record updates that you should make to allow Hosting to serve secure content in response to requests against your domain name. These updates present the current state of your domain name's DNS records when Hosting last queried them, and the desired set of records that Hosting needs to see before your custom domain can be fully active.

Domain

The intended behavior and status information of a domain.

DomainProvisioning

The current certificate provisioning status information for a domain.

DomainRedirect

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.

Empty

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); }

Header

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

HttpUpdate

A file you can add to your existing, non-Hosting hosting service that confirms your intent to allow Hosting's Certificate Authorities to create an SSL certificate for your domain.

I18nConfig

If provided, i18n rewrites are enabled.

ListChannelsResponse

ListCustomDomainsResponse

The response from ListCustomDomains.

ListDomainsResponse

The response to listing Domains.

ListOperationsResponse

The response message for Operations.ListOperations.

ListReleasesResponse

ListSitesResponse

ListVersionFilesResponse

ListVersionsResponse

LiveMigrationStep

A set of updates including ACME challenges and DNS records that allow Hosting to create an SSL certificate and establish project ownership for your domain name before you direct traffic to Hosting servers. Use these updates to facilitate zero downtime migrations to Hosting from other services. After you've made the recommended updates, check your custom domain's ownershipState and certState. To avoid downtime, they should be OWNERSHIP_ACTIVE and CERT_ACTIVE, respectively, before you update your A and AAAA records.

Operation

This resource represents a long-running operation that is the result of a network API call.

PathFilter

A representation of filter path.

PopulateVersionFilesRequest

PopulateVersionFilesResponse

Redirect

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.

Release

A Release is a particular collection of configurations and files that is set to be public at a particular time.

Rewrite

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.

ServingConfig

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.

Site

A Site represents a Firebase Hosting site.

SiteConfig

A SiteConfig contains metadata associated with a specific site that controls Firebase Hosting serving behavior

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

UndeleteCustomDomainRequest

The request sent to UndeleteCustomDomain.

Version

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

VersionFile

A static content file that is part of a version.

In this article
Back to top Generated by DocFX