Module google_firebasehosting1_beta1::api

source ·

Structs§

  • 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
    There is no detailed description.
  • 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.
  • 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); }
  • FirebaseHosting
    Central instance to access all FirebaseHosting related resource activities
  • 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
    There is no detailed description.
  • ListCustomDomainsResponse
    The response from ListCustomDomains.
  • ListDomainsResponse
    The response to listing Domains.
  • ListOperationsResponse
    The response message for Operations.ListOperations.
  • ListReleasesResponse
    There is no detailed description.
  • ListSitesResponse
    There is no detailed description.
  • ListVersionFilesResponse
    There is no detailed description.
  • ListVersionsResponse
    There is no detailed description.
  • Operation
    This resource represents a long-running operation that is the result of a network API call.
  • PathFilter
    A representation of filter path.
  • PopulateVersionFilesRequest
    There is no detailed description.
  • PopulateVersionFilesResponse
    There is no detailed description.
  • ProjectMethods
    A builder providing access to all methods supported on project resources. It is not used directly, but through the FirebaseHosting hub.
  • ProjectOperationGetCall
    Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
  • ProjectSiteChannelCreateCall
    Creates a new channel in the specified site.
  • ProjectSiteChannelDeleteCall
    Deletes the specified channel of the specified site. The live channel cannot be deleted.
  • ProjectSiteChannelGetCall
    Retrieves information for the specified channel of the specified site.
  • ProjectSiteChannelListCall
    Lists the channels for the specified site. All sites have a default live channel.
  • ProjectSiteChannelPatchCall
    Updates information for the specified channel of the specified site. Implicitly creates the channel if it doesn’t already exist.
  • ProjectSiteChannelReleaseCreateCall
    Creates a new release, which makes the content of the specified version actively display on the appropriate URL(s).
  • ProjectSiteChannelReleaseGetCall
    Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live channel and any active preview channels for the specified site.
  • ProjectSiteChannelReleaseListCall
    Lists the releases that have been created for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live channel and any active preview channels for the specified site.
  • ProjectSiteCreateCall
    Creates a new Hosting Site in the specified parent Firebase project. Note that Hosting sites can take several minutes to propagate through Firebase systems.
  • ProjectSiteCustomDomainCreateCall
    Creates a CustomDomain.
  • ProjectSiteCustomDomainDeleteCall
    Deletes the specified CustomDomain.
  • ProjectSiteCustomDomainGetCall
    Gets the specified CustomDomain.
  • ProjectSiteCustomDomainListCall
    Lists each CustomDomain associated with the specified parent Hosting site. Returns CustomDomains in a consistent, but undefined, order to facilitate pagination.
  • ProjectSiteCustomDomainOperationGetCall
    Gets the latest state of a long-running operation. Use this method to poll the operation result at intervals as recommended by the API service.
  • ProjectSiteCustomDomainOperationListCall
    Lists operations that match the specified filter in the request.
  • ProjectSiteCustomDomainPatchCall
    Updates the specified CustomDomain.
  • ProjectSiteCustomDomainUndeleteCall
    Undeletes the specified CustomDomain if it has been soft-deleted. Hosting retains soft-deleted custom domains for around 30 days before permanently deleting them.
  • ProjectSiteDeleteCall
    Deletes the specified Hosting Site from the specified parent Firebase project.
  • ProjectSiteDomainCreateCall
    Creates a domain mapping on the specified site.
  • ProjectSiteDomainDeleteCall
    Deletes the existing domain mapping on the specified site.
  • ProjectSiteDomainGetCall
    Gets a domain mapping on the specified site.
  • ProjectSiteDomainListCall
    Lists the domains for the specified site.
  • ProjectSiteDomainUpdateCall
    Updates the specified domain mapping, creating the mapping as if it does not exist.
  • ProjectSiteGetCall
    Gets the specified Hosting Site.
  • ProjectSiteGetConfigCall
    Gets the Hosting metadata for a specific site.
  • ProjectSiteListCall
    Lists each Hosting Site associated with the specified parent Firebase project.
  • ProjectSitePatchCall
    Updates attributes of the specified Hosting Site.
  • ProjectSiteReleaseCreateCall
    Creates a new release, which makes the content of the specified version actively display on the appropriate URL(s).
  • ProjectSiteReleaseGetCall
    Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live channel and any active preview channels for the specified site.
  • ProjectSiteReleaseListCall
    Lists the releases that have been created for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live channel and any active preview channels for the specified site.
  • ProjectSiteUpdateConfigCall
    Sets the Hosting metadata for a specific site.
  • ProjectSiteVersionCloneCall
    Creates a new version on the specified target site using the content of the specified version.
  • ProjectSiteVersionCreateCall
    Creates a new version for the specified site.
  • ProjectSiteVersionDeleteCall
    Deletes the specified version.
  • ProjectSiteVersionFileListCall
    Lists the remaining files to be uploaded for the specified version.
  • ProjectSiteVersionGetCall
    Get the specified version that has been created for the specified site. This can include versions that were created for the default live channel or for any active preview channels for the specified site.
  • ProjectSiteVersionListCall
    Lists the versions that have been created for the specified site. This list includes versions for both the default live channel and any active preview channels for the specified site.
  • ProjectSiteVersionPatchCall
    Updates the specified metadata for the specified version. This method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The supported state transitions for a version are from CREATED to FINALIZED. Use DeleteVersion to set the status of a version to DELETED.
  • ProjectSiteVersionPopulateFileCall
    Adds content files to the specified version. Each file must be under 2 GB.
  • 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.
  • SiteChannelCreateCall
    Creates a new channel in the specified site.
  • SiteChannelDeleteCall
    Deletes the specified channel of the specified site. The live channel cannot be deleted.
  • SiteChannelGetCall
    Retrieves information for the specified channel of the specified site.
  • SiteChannelListCall
    Lists the channels for the specified site. All sites have a default live channel.
  • SiteChannelPatchCall
    Updates information for the specified channel of the specified site. Implicitly creates the channel if it doesn’t already exist.
  • SiteChannelReleaseCreateCall
    Creates a new release, which makes the content of the specified version actively display on the appropriate URL(s).
  • SiteChannelReleaseGetCall
    Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live channel and any active preview channels for the specified site.
  • SiteChannelReleaseListCall
    Lists the releases that have been created for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live channel and any active preview channels for the specified site.
  • SiteConfig
    A SiteConfig contains metadata associated with a specific site that controls Firebase Hosting serving behavior
  • SiteDomainCreateCall
    Creates a domain mapping on the specified site.
  • SiteDomainDeleteCall
    Deletes the existing domain mapping on the specified site.
  • SiteDomainGetCall
    Gets a domain mapping on the specified site.
  • SiteDomainListCall
    Lists the domains for the specified site.
  • SiteDomainUpdateCall
    Updates the specified domain mapping, creating the mapping as if it does not exist.
  • SiteGetConfigCall
    Gets the Hosting metadata for a specific site.
  • SiteMethods
    A builder providing access to all methods supported on site resources. It is not used directly, but through the FirebaseHosting hub.
  • SiteReleaseCreateCall
    Creates a new release, which makes the content of the specified version actively display on the appropriate URL(s).
  • SiteReleaseGetCall
    Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live channel and any active preview channels for the specified site.
  • SiteReleaseListCall
    Lists the releases that have been created for the specified site or channel. When used to list releases for a site, this list includes releases for both the default live channel and any active preview channels for the specified site.
  • SiteUpdateConfigCall
    Sets the Hosting metadata for a specific site.
  • SiteVersionCloneCall
    Creates a new version on the specified target site using the content of the specified version.
  • SiteVersionCreateCall
    Creates a new version for the specified site.
  • SiteVersionDeleteCall
    Deletes the specified version.
  • SiteVersionFileListCall
    Lists the remaining files to be uploaded for the specified version.
  • SiteVersionGetCall
    Get the specified version that has been created for the specified site. This can include versions that were created for the default live channel or for any active preview channels for the specified site.
  • SiteVersionListCall
    Lists the versions that have been created for the specified site. This list includes versions for both the default live channel and any active preview channels for the specified site.
  • SiteVersionPatchCall
    Updates the specified metadata for the specified version. This method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The supported state transitions for a version are from CREATED to FINALIZED. Use DeleteVersion to set the status of a version to DELETED.
  • SiteVersionPopulateFileCall
    Adds content files to the specified version. Each file must be under 2 GB.
  • 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.

Enums§