View Source API Reference google_api_firebase_hosting v0.17.1

API client metadata for GoogleApi.FirebaseHosting.V1.

API calls for all endpoints tagged Operations.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.FirebaseHosting.V1.

The request message for Operations.CancelOperation.

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.

Metadata associated with aCustomDomain operation.

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

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

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.

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

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.

The response message for Operations.ListOperations.

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.

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

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.

API client metadata for GoogleApi.FirebaseHosting.V1beta1.

API calls for all endpoints tagged Projects.

API calls for all endpoints tagged Sites.

Handle Tesla connections for GoogleApi.FirebaseHosting.V1beta1.

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

Represents a DNS certificate challenge.

Represents an HTTP certificate challenge.

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.

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.

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.

Attributes

• exclude (type: GoogleApi.FirebaseHosting.V1beta1.Model.PathFilter.t, default: nil) - If provided, only paths that do not match any of the RegEx values in this list will be included in the new version.
• finalize (type: boolean(), default: nil) - If true, the call to CloneVersion immediately finalizes the version after cloning is complete. If false, the cloned version will have a status of CREATED. Use UpdateVersion to set the status of the version to FINALIZED.
• include (type: GoogleApi.FirebaseHosting.V1beta1.Model.PathFilter.t, default: nil) - If provided, only paths that match one or more RegEx values in this list will be included in the new version.
• sourceVersion (type: String.t, default: nil) - Required. The unique identifier for the version to be cloned, in the format: sites/SITE_ID/versions/VERSION_ID

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

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.

Metadata associated with aCustomDomain operation.

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

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

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.

The intended behavior and status information of a domain.

The current certificate provisioning status information for a domain.

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.

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

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

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.

If provided, i18n rewrites are enabled.

Attributes

• channels (type: list(GoogleApi.FirebaseHosting.V1beta1.Model.Channel.t), default: nil) - The list of channels.
• nextPageToken (type: String.t, default: nil) - 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.

The response from ListCustomDomains.

The response to listing Domains.

The response message for Operations.ListOperations.

Attributes

• nextPageToken (type: String.t, default: nil) - The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to ListReleases. Page tokens are short-lived and should not be stored.
• releases (type: list(GoogleApi.FirebaseHosting.V1beta1.Model.Release.t), default: nil) - The list of hashes of files that still need to be uploaded, if any exist.

Attributes

• nextPageToken (type: String.t, default: nil) - The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to ListSites. Page tokens are short-lived and should not be stored.
• sites (type: list(GoogleApi.FirebaseHosting.V1beta1.Model.Site.t), default: nil) - A list of Site objects associated with the specified Firebase project.

Attributes

• files (type: list(GoogleApi.FirebaseHosting.V1beta1.Model.VersionFile.t), default: nil) - The list of paths to the hashes of the files in the specified version.
• nextPageToken (type: String.t, default: nil) - The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to ListVersionFiles. Page tokens are short-lived and should not be stored.

Attributes

• nextPageToken (type: String.t, default: nil) - The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to ListVersions. Page tokens are short-lived and should not be stored.
• versions (type: list(GoogleApi.FirebaseHosting.V1beta1.Model.Version.t), default: nil) - The list of versions, if any exist.

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.

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

A representation of filter path.

Attributes

• files (type: map(), default: nil) - A set of file paths to the hashes corresponding to assets that should be added to the version. 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.

Attributes

• uploadRequiredHashes (type: list(String.t), default: nil) - The content hashes of the specified files that need to be uploaded to the specified URL.
• uploadUrl (type: String.t, default: nil) - The URL to which the files should be uploaded, in the format: "https://upload-firebasehosting.googleapis.com/upload/sites/SITE_ID /versions/VERSION_ID/files" 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.

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.

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

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.

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.

A Site represents a Firebase Hosting site.

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

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.

The request sent to UndeleteCustomDomain.

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

A static content file that is part of a version.