Movatterモバイル変換


[0]ホーム

URL:


firebasehosting

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:4

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package firebasehosting provides access to the Firebase Hosting API.

For product documentation, see:https://firebase.google.com/docs/hosting/

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/firebasehosting/v1beta1"...ctx := context.Background()firebasehostingService, err := firebasehosting.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:

firebasehostingService, err := firebasehosting.NewService(ctx, option.WithScopes(firebasehosting.FirebaseReadonlyScope))

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

firebasehostingService, err := firebasehosting.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)firebasehostingService, err := firebasehosting.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"// View your data across Google Cloud services and see the email address of// your Google AccountCloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"// View and administer all your Firebase data and settingsFirebaseScope = "https://www.googleapis.com/auth/firebase"// View all your Firebase data and settingsFirebaseReadonlyScope = "https://www.googleapis.com/auth/firebase.readonly")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeActingUser

type ActingUser struct {// Email: The email address of the user when the user performed the action.Emailstring `json:"email,omitempty"`// ImageUrl: A profile image URL for the user. May not be present if the user// has changed their email address or deleted their account.ImageUrlstring `json:"imageUrl,omitempty"`// ForceSendFields is a list of field names (e.g. "Email") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Email") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ActingUser: Contains metadata about the user who performed an action, suchas creating a release or finalizing a version.

func (ActingUser)MarshalJSON

func (sActingUser) MarshalJSON() ([]byte,error)

typeCertDnsChallenge

type CertDnsChallenge struct {// DomainName: The domain name upon which the DNS challenge must be satisfied.DomainNamestring `json:"domainName,omitempty"`// Token: The value that must be present as a TXT record on the domain name to// satisfy the challenge.Tokenstring `json:"token,omitempty"`// ForceSendFields is a list of field names (e.g. "DomainName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DomainName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CertDnsChallenge: Represents a DNS certificate challenge.

func (CertDnsChallenge)MarshalJSON

func (sCertDnsChallenge) MarshalJSON() ([]byte,error)

typeCertHttpChallenge

type CertHttpChallenge struct {// Path: The URL path on which to serve the specified token to satisfy the// certificate challenge.Pathstring `json:"path,omitempty"`// Token: The token to serve at the specified URL path to satisfy the// certificate challenge.Tokenstring `json:"token,omitempty"`// ForceSendFields is a list of field names (e.g. "Path") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Path") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CertHttpChallenge: Represents an HTTP certificate challenge.

func (CertHttpChallenge)MarshalJSON

func (sCertHttpChallenge) MarshalJSON() ([]byte,error)

typeCertVerificationadded inv0.141.0

type CertVerification struct {// Dns: Output only. A `TXT` record to add to your DNS records that confirms// your intent to let Hosting create an SSL cert for your domain name.Dns *DnsUpdates `json:"dns,omitempty"`// Http: Output only. A file to add to your existing, non-Hosting hosting// service that confirms your intent to let Hosting create an SSL cert for your// domain name.Http *HttpUpdate `json:"http,omitempty"`// ForceSendFields is a list of field names (e.g. "Dns") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Dns") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (CertVerification)MarshalJSONadded inv0.141.0

func (sCertVerification) MarshalJSON() ([]byte,error)

typeCertificateadded inv0.141.0

type Certificate struct {// CreateTime: Output only. The certificate's creation time. For `TEMPORARY`// certs this is the time Hosting first generated challenges for your domain// name. For all other cert types, it's the time the actual cert was created.CreateTimestring `json:"createTime,omitempty"`// ExpireTime: Output only. The certificate's expiration time. After this time,// the cert can no longer be used to provide secure communication between// Hosting and your site's visitors.ExpireTimestring `json:"expireTime,omitempty"`// Issues: Output only. A set of errors Hosting encountered when attempting to// create a cert for your domain name. Resolve these issues to ensure Hosting// is able to provide secure communication with your site's visitors.Issues []*Status `json:"issues,omitempty"`// State: Output only. The state of the certificate. Only the `CERT_ACTIVE` and// `CERT_EXPIRING_SOON` states provide SSL coverage for a domain name. If the// state is `PROPAGATING` and Hosting had an active cert for the domain name// before, that formerly-active cert provides SSL coverage for the domain name// until the current cert propagates.//// Possible values://   "CERT_STATE_UNSPECIFIED" - The certificate's state is unspecified. The// message is invalid if this is unspecified.//   "CERT_PREPARING" - The initial state of every certificate, represents// Hosting's intent to create a certificate, before requests to a Certificate// Authority are made.//   "CERT_VALIDATING" - Hosting is validating whether a domain name's DNS// records are in a state that allow certificate creation on its behalf.//   "CERT_PROPAGATING" - The certificate was recently created, and needs time// to propagate in Hosting's CDN.//   "CERT_ACTIVE" - The certificate is active, providing secure connections// for the domain names it represents.//   "CERT_EXPIRING_SOON" - The certificate is expiring, all domain names on it// will be given new certificates.//   "CERT_EXPIRED" - The certificate has expired. Hosting can no longer serve// secure content on your domain name.Statestring `json:"state,omitempty"`// Type: Output only. The certificate's type.//// Possible values://   "TYPE_UNSPECIFIED" - The certificate's type is unspecified. The message is// invalid if this is unspecified.//   "TEMPORARY" - A short-lived certificate type that covers a domain name// temporarily, while Hosting creates a more permanent certificate.//   "GROUPED" - The standard certificate for Spark plan custom domains.//   "PROJECT_GROUPED" - Blaze plan only. A certificate that covers from 1 to// 100 domain names with custom domains on the same Firebase project.//   "DEDICATED" - Blaze plan only. A certificate that covers a single domain// name.Typestring `json:"type,omitempty"`// Verification: Output only. A set of ACME challenges you can add to your DNS// records or existing, non-Hosting hosting provider to allow Hosting to create// an SSL certificate for your domain name before you point traffic toward// hosting. You can use thse challenges as part of a zero downtime transition// from your old provider to Hosting.Verification *CertVerification `json:"verification,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Certificate: An SSL certificate used to provide end-to-end encryption forrequests against your domain name. A `Certificate` can be an actual SSLcertificate or, for newly-created custom domains, Hosting's intent to createone.

func (Certificate)MarshalJSONadded inv0.141.0

func (sCertificate) MarshalJSON() ([]byte,error)

typeChanneladded inv0.32.0

type Channel struct {// CreateTime: Output only. The time at which the channel was created.CreateTimestring `json:"createTime,omitempty"`// ExpireTime: 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.ExpireTimestring `json:"expireTime,omitempty"`// Labels: Text labels used for extra metadata and/or filtering.Labels map[string]string `json:"labels,omitempty"`// Name: The fully-qualified resource name for the channel, in the format:// sites/ SITE_ID/channels/CHANNEL_IDNamestring `json:"name,omitempty"`// Release: Output only. The current release for the channel, if any.Release *Release `json:"release,omitempty"`// RetainedReleaseCount: 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.RetainedReleaseCountint64 `json:"retainedReleaseCount,omitempty"`// Ttl: Input only. A time-to-live for this channel. Sets `expire_time` to the// provided duration past the time of the request.Ttlstring `json:"ttl,omitempty"`// UpdateTime: Output only. The time at which the channel was last updated.UpdateTimestring `json:"updateTime,omitempty"`// Url: 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.Urlstring `json:"url,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Channel: A `Channel` represents a stream of releases for a site. All siteshave a default `live` channel that serves content to the Firebase-providedsubdomains and any connected custom domains.

func (Channel)MarshalJSONadded inv0.32.0

func (sChannel) MarshalJSON() ([]byte,error)

typeCloneVersionRequestadded inv0.16.0

type CloneVersionRequest struct {// Exclude: If provided, only paths that do not match any of the RegEx values// in this list will be included in the new version.Exclude *PathFilter `json:"exclude,omitempty"`// Finalize: 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` (patch) to set the status of the// version to `FINALIZED`.Finalizebool `json:"finalize,omitempty"`// Include: If provided, only paths that match one or more RegEx values in this// list will be included in the new version.Include *PathFilter `json:"include,omitempty"`// SourceVersion: Required. The unique identifier for the version to be cloned,// in the format: sites/SITE_ID/versions/VERSION_IDSourceVersionstring `json:"sourceVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "Exclude") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Exclude") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CloneVersionRequest)MarshalJSONadded inv0.16.0

func (sCloneVersionRequest) MarshalJSON() ([]byte,error)

typeCloudRunRewriteadded inv0.2.0

type CloudRunRewrite struct {// Region: Optional. User-provided region where the Cloud Run service is// hosted. Defaults to `us-central1` if not supplied.Regionstring `json:"region,omitempty"`// ServiceId: Required. User-defined ID of the Cloud Run service.ServiceIdstring `json:"serviceId,omitempty"`// Tag: Optional. User-provided TrafficConfig tag to send traffic to. When// omitted, traffic is sent to the service-wide URITagstring `json:"tag,omitempty"`// ForceSendFields is a list of field names (e.g. "Region") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Region") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (CloudRunRewrite)MarshalJSONadded inv0.2.0

func (sCloudRunRewrite) MarshalJSON() ([]byte,error)

typeCustomDomainadded inv0.141.0

type CustomDomain struct {// Annotations: Annotations you can add to leave both human- and// machine-readable metadata about your `CustomDomain`.Annotations map[string]string `json:"annotations,omitempty"`// Cert: Output only. The SSL certificate Hosting has for this custom domain's// domain name. For new custom domains, this often represents Hosting's intent// to create a certificate, rather than an actual cert. Check the `state` field// for more.Cert *Certificate `json:"cert,omitempty"`// CertPreference: A field that lets you specify which SSL certificate type// Hosting creates for your domain name. Spark plan custom domains only have// access to the `GROUPED` cert type, while Blaze plan domains can select any// option.//// Possible values://   "TYPE_UNSPECIFIED" - The certificate's type is unspecified. The message is// invalid if this is unspecified.//   "TEMPORARY" - A short-lived certificate type that covers a domain name// temporarily, while Hosting creates a more permanent certificate.//   "GROUPED" - The standard certificate for Spark plan custom domains.//   "PROJECT_GROUPED" - Blaze plan only. A certificate that covers from 1 to// 100 domain names with custom domains on the same Firebase project.//   "DEDICATED" - Blaze plan only. A certificate that covers a single domain// name.CertPreferencestring `json:"certPreference,omitempty"`// CreateTime: Output only. The custom domain's create time.CreateTimestring `json:"createTime,omitempty"`// DeleteTime: Output only. The time the `CustomDomain` was deleted; null for// custom domains that haven't been deleted. Deleted custom domains persist for// approximately 30 days, after which time Hosting removes them completely. To// restore a deleted custom domain, make an `UndeleteCustomDomain` request.DeleteTimestring `json:"deleteTime,omitempty"`// Etag: Output only. A string that represents the current state of the// `CustomDomain` and allows you to confirm its initial state in requests that// would modify it. Use the tag to ensure consistency when making// `UpdateCustomDomain`, `DeleteCustomDomain`, and `UndeleteCustomDomain`// requests.Etagstring `json:"etag,omitempty"`// ExpireTime: Output only. The minimum time before a soft-deleted// `CustomDomain` is completely removed from Hosting; null for custom domains// that haven't been deleted.ExpireTimestring `json:"expireTime,omitempty"`// HostState: Output only. The `HostState` of the domain name this// `CustomDomain` refers to.//// Possible values://   "HOST_STATE_UNSPECIFIED" - Your custom domain's host state is unspecified.// The message is invalid if this is unspecified.//   "HOST_UNHOSTED" - Your custom domain's domain name isn't associated with// any IP addresses.//   "HOST_UNREACHABLE" - Your custom domain's domain name can't be reached.// Hosting services' DNS queries to find your domain name's IP addresses// resulted in errors. See your `CustomDomain` object's `issues` field for more// details.//   "HOST_MISMATCH" - Your custom domain's domain name has IP addresses that// don't ultimately resolve to Hosting.//   "HOST_CONFLICT" - Your custom domain's domain name has IP addresses that// resolve to both Hosting and other services. To ensure consistent results,// remove `A` and `AAAA` records related to non-Hosting services.//   "HOST_ACTIVE" - All requests against your custom domain's domain name are// served by Hosting. If the custom domain's `OwnershipState` is also `ACTIVE`,// Hosting serves your Hosting site's content on the domain name.HostStatestring `json:"hostState,omitempty"`// Issues: Output only. A set of errors Hosting systems encountered when trying// to establish Hosting's ability to serve secure content for your domain name.// Resolve these issues to ensure your `CustomDomain` behaves properly.Issues []*Status `json:"issues,omitempty"`// Labels: Labels used for extra metadata and/or filtering.Labels map[string]string `json:"labels,omitempty"`// Name: Output only. The fully-qualified name of the `CustomDomain`.Namestring `json:"name,omitempty"`// OwnershipState: Output only. The `OwnershipState` of the domain name this// `CustomDomain` refers to.//// Possible values://   "OWNERSHIP_STATE_UNSPECIFIED" - Your custom domain's ownership state is// unspecified. This should never happen.//   "OWNERSHIP_MISSING" - Your custom domain's domain name has no// Hosting-related ownership records; no Firebase project has permission to act// on the domain name's behalf.//   "OWNERSHIP_UNREACHABLE" - Your custom domain's domain name can't be// reached. Hosting services' DNS queries to find your domain name's ownership// records resulted in errors. See your `CustomDomain` object's `issues` field// for more details.//   "OWNERSHIP_MISMATCH" - Your custom domain's domain name is owned by// another Firebase project. Remove the conflicting `TXT` records and replace// them with project-specific records for your current Firebase project.//   "OWNERSHIP_CONFLICT" - Your custom domain's domain name has conflicting// `TXT` records that indicate ownership by both your current Firebase project// and another project. Remove the other project's ownership records to grant// the current project ownership.//   "OWNERSHIP_PENDING" - Your custom domain's DNS records are configured// correctly. Hosting will transfer ownership of your domain to this// `CustomDomain` within 24 hours.//   "OWNERSHIP_ACTIVE" - Your custom domain's domain name has `TXT` records// that grant its project permission to act on its behalf.OwnershipStatestring `json:"ownershipState,omitempty"`// Reconciling: Output only. A field that, if true, indicates that Hosting's// systems are attmepting to make the custom domain's state match your// preferred state. This is most frequently `true` when initially provisioning// a `CustomDomain` after a `CreateCustomDomain` request or when creating a new// SSL certificate to match an updated `cert_preference` after an// `UpdateCustomDomain` request.Reconcilingbool `json:"reconciling,omitempty"`// RedirectTarget: A domain name that this `CustomDomain` should direct traffic// towards. If specified, Hosting will respond to requests against this custom// domain with an HTTP 301 code, and route traffic to the specified// `redirect_target` instead.RedirectTargetstring `json:"redirectTarget,omitempty"`// RequiredDnsUpdates: Output only. A set of updates you should make to the// domain name's DNS records to let Hosting serve secure content on its behalf.RequiredDnsUpdates *DnsUpdates `json:"requiredDnsUpdates,omitempty"`// UpdateTime: Output only. The last time the `CustomDomain` was updated.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Annotations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Annotations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (CustomDomain)MarshalJSONadded inv0.141.0

func (sCustomDomain) MarshalJSON() ([]byte,error)

typeCustomDomainMetadataadded inv0.141.0

type CustomDomainMetadata struct {// CertState: The `CertState` of the domain name's SSL certificate.//// Possible values://   "CERT_STATE_UNSPECIFIED" - The certificate's state is unspecified. The// message is invalid if this is unspecified.//   "CERT_PREPARING" - The initial state of every certificate, represents// Hosting's intent to create a certificate, before requests to a Certificate// Authority are made.//   "CERT_VALIDATING" - Hosting is validating whether a domain name's DNS// records are in a state that allow certificate creation on its behalf.//   "CERT_PROPAGATING" - The certificate was recently created, and needs time// to propagate in Hosting's CDN.//   "CERT_ACTIVE" - The certificate is active, providing secure connections// for the domain names it represents.//   "CERT_EXPIRING_SOON" - The certificate is expiring, all domain names on it// will be given new certificates.//   "CERT_EXPIRED" - The certificate has expired. Hosting can no longer serve// secure content on your domain name.CertStatestring `json:"certState,omitempty"`// HostState: The `HostState` of the domain name this `CustomDomain` refers to.//// Possible values://   "HOST_STATE_UNSPECIFIED" - Your custom domain's host state is unspecified.// The message is invalid if this is unspecified.//   "HOST_UNHOSTED" - Your custom domain's domain name isn't associated with// any IP addresses.//   "HOST_UNREACHABLE" - Your custom domain's domain name can't be reached.// Hosting services' DNS queries to find your domain name's IP addresses// resulted in errors. See your `CustomDomain` object's `issues` field for more// details.//   "HOST_MISMATCH" - Your custom domain's domain name has IP addresses that// don't ultimately resolve to Hosting.//   "HOST_CONFLICT" - Your custom domain's domain name has IP addresses that// resolve to both Hosting and other services. To ensure consistent results,// remove `A` and `AAAA` records related to non-Hosting services.//   "HOST_ACTIVE" - All requests against your custom domain's domain name are// served by Hosting. If the custom domain's `OwnershipState` is also `ACTIVE`,// Hosting serves your Hosting site's content on the domain name.HostStatestring `json:"hostState,omitempty"`// Issues: A list of issues that are currently preventing Hosting from// completing the operation. These are generally DNS-related issues that// Hosting encounters when querying a domain name's records or attempting to// mint an SSL certificate.Issues []*Status `json:"issues,omitempty"`// LiveMigrationSteps: A set of DNS record updates and ACME challenges that// allow you to transition domain names to Firebase Hosting with zero downtime.// These updates allow Hosting to create an SSL certificate and establish// ownership for your custom domain before Hosting begins serving traffic on// it. If your domain name is already in active use with another provider, add// one of the challenges and make the recommended DNS updates. After adding// challenges and adjusting DNS records as necessary, wait for the// `ownershipState` to be `OWNERSHIP_ACTIVE` and the `certState` to be// `CERT_ACTIVE` before sending traffic to Hosting.LiveMigrationSteps []*LiveMigrationStep `json:"liveMigrationSteps,omitempty"`// OwnershipState: The `OwnershipState` of the domain name this `CustomDomain`// refers to.//// Possible values://   "OWNERSHIP_STATE_UNSPECIFIED" - Your custom domain's ownership state is// unspecified. This should never happen.//   "OWNERSHIP_MISSING" - Your custom domain's domain name has no// Hosting-related ownership records; no Firebase project has permission to act// on the domain name's behalf.//   "OWNERSHIP_UNREACHABLE" - Your custom domain's domain name can't be// reached. Hosting services' DNS queries to find your domain name's ownership// records resulted in errors. See your `CustomDomain` object's `issues` field// for more details.//   "OWNERSHIP_MISMATCH" - Your custom domain's domain name is owned by// another Firebase project. Remove the conflicting `TXT` records and replace// them with project-specific records for your current Firebase project.//   "OWNERSHIP_CONFLICT" - Your custom domain's domain name has conflicting// `TXT` records that indicate ownership by both your current Firebase project// and another project. Remove the other project's ownership records to grant// the current project ownership.//   "OWNERSHIP_PENDING" - Your custom domain's DNS records are configured// correctly. Hosting will transfer ownership of your domain to this// `CustomDomain` within 24 hours.//   "OWNERSHIP_ACTIVE" - Your custom domain's domain name has `TXT` records// that grant its project permission to act on its behalf.OwnershipStatestring `json:"ownershipState,omitempty"`// QuickSetupUpdates: A set of DNS record updates that allow Hosting to serve// secure content on your domain name. The record type determines the update's// purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that// they direct traffic to Hosting servers. - `TXT`: Updates ownership// permissions on your domain name, letting Hosting know that your custom// domain's project has permission to perform actions for that domain name. -// `CAA`: Updates your domain name's list of authorized Certificate Authorities// (CAs). Only present if you have existing `CAA` records that prohibit// Hosting's CA from minting certs for your domain name. These updates include// all DNS changes you'll need to get started with Hosting, but, if made all at// once, can result in a brief period of downtime for your domain name--while// Hosting creates and uploads an SSL cert, for example. If you'd like to add// your domain name to Hosting without downtime, complete the// `liveMigrationSteps` first, before making the remaining updates in this// field.QuickSetupUpdates *DnsUpdates `json:"quickSetupUpdates,omitempty"`// ForceSendFields is a list of field names (e.g. "CertState") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CertState") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CustomDomainMetadata: Metadata associated with a`CustomDomain` operation.

func (CustomDomainMetadata)MarshalJSONadded inv0.141.0

func (sCustomDomainMetadata) MarshalJSON() ([]byte,error)

typeDnsRecordadded inv0.141.0

type DnsRecord struct {// DomainName: Output only. The domain name the record pertains to, e.g.// `foo.bar.com.`.DomainNamestring `json:"domainName,omitempty"`// Rdata: Output only. The data of the record. The meaning of the value depends// on record type: - A and AAAA: IP addresses for the domain name. - CNAME:// Another domain to check for records. - TXT: Arbitrary text strings// associated with the domain name. Hosting uses TXT records to determine which// Firebase projects have permission to act on the domain name's behalf. - CAA:// The record's flags, tag, and value, e.g. `0 issue "pki.goog".Rdatastring `json:"rdata,omitempty"`// RequiredAction: Output only. An enum that indicates the a required action// for this record.//// Possible values://   "NONE" - No action necessary.//   "ADD" - Add this record to your DNS records.//   "REMOVE" - Remove this record from your DNS records.RequiredActionstring `json:"requiredAction,omitempty"`// Type: Output only. The record's type, which determines what data the record// contains.//// Possible values://   "TYPE_UNSPECIFIED" - The record's type is unspecified. The message is// invalid if this is unspecified.//   "A" - An `A` record, as defined in [RFC// 1035](https://tools.ietf.org/html/rfc1035). A records determine which IPv4// addresses a domain name directs traffic towards.//   "CNAME" - A `CNAME` record, as defined in [RFC// 1035](https://tools.ietf.org/html/rfc1035). `CNAME` or Canonical Name// records map a domain name to a different, canonical domain name. If a// `CNAME` record is present, it should be the only record on the domain name.//   "TXT" - A `TXT` record, as defined in [RFC// 1035](https://tools.ietf.org/html/rfc1035). `TXT` records hold arbitrary// text data on a domain name. Hosting uses `TXT` records to establish which// Firebase Project has permission to act on a domain name.//   "AAAA" - An AAAA record, as defined in [RFC// 3596](https://tools.ietf.org/html/rfc3596) AAAA records determine which IPv6// addresses a domain name directs traffic towards.//   "CAA" - A CAA record, as defined in [RFC// 6844](https://tools.ietf.org/html/rfc6844). CAA, or Certificate Authority// Authorization, records determine which Certificate Authorities (SSL// certificate minting organizations) are authorized to mint a certificate for// the domain name. Firebase Hosting uses `pki.goog` as its primary CA. CAA// records cascade. A CAA record on `foo.com` also applies to `bar.foo.com`// unless `bar.foo.com` has its own set of CAA records. CAA records are// optional. If a domain name and its parents have no CAA records, all CAs are// authorized to mint certificates on its behalf. In general, Hosting only asks// you to modify CAA records when doing so is required to unblock SSL cert// creation.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "DomainName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DomainName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DnsRecord: DNS records are resource records that define how systems andservices should behave when handling requests for a domain name. Forexample, when you add `A` records to your domain name's DNS records, you'reinforming other systems (such as your users' web browsers) to contact thoseIPv4 addresses to retrieve resources relevant to your domain name (such asyour Hosting site files).

func (DnsRecord)MarshalJSONadded inv0.141.0

func (sDnsRecord) MarshalJSON() ([]byte,error)

typeDnsRecordSetadded inv0.141.0

type DnsRecordSet struct {// CheckError: Output only. An error Hosting services encountered when querying// your domain name's DNS records. Note: Hosting ignores `NXDOMAIN` errors, as// those generally just mean that a domain name hasn't been set up yet.CheckError *Status `json:"checkError,omitempty"`// DomainName: Output only. The domain name the record set pertains to.DomainNamestring `json:"domainName,omitempty"`// Records: Output only. Records on the domain.Records []*DnsRecord `json:"records,omitempty"`// ForceSendFields is a list of field names (e.g. "CheckError") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CheckError") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (DnsRecordSet)MarshalJSONadded inv0.141.0

func (sDnsRecordSet) MarshalJSON() ([]byte,error)

typeDnsUpdatesadded inv0.141.0

type DnsUpdates struct {// CheckTime: The last time Hosting checked your custom domain's DNS records.CheckTimestring `json:"checkTime,omitempty"`// Desired: The set of DNS records Hosting needs to serve secure content on the// domain.Desired []*DnsRecordSet `json:"desired,omitempty"`// Discovered: The set of DNS records Hosting discovered when inspecting a// domain.Discovered []*DnsRecordSet `json:"discovered,omitempty"`// ForceSendFields is a list of field names (e.g. "CheckTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CheckTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (DnsUpdates)MarshalJSONadded inv0.141.0

func (sDnsUpdates) MarshalJSON() ([]byte,error)

typeDomain

type Domain struct {// DomainName: Required. The domain name of the association.DomainNamestring `json:"domainName,omitempty"`// DomainRedirect: If set, the domain should redirect with the provided// parameters.DomainRedirect *DomainRedirect `json:"domainRedirect,omitempty"`// Provisioning: Output only. Information about the provisioning of// certificates and the health of the DNS resolution for the domain.Provisioning *DomainProvisioning `json:"provisioning,omitempty"`// Site: Required. The site name of the association.Sitestring `json:"site,omitempty"`// Status: Output only. Additional status of the domain association.//// Possible values://   "DOMAIN_STATUS_UNSPECIFIED" - Unspecified domain association status.//   "DOMAIN_CHANGE_PENDING" - An external operation is in progress on the// domain association and no further operations can be performed until it is// complete. Formerly used for metabase updates. Not currently used//   "DOMAIN_ACTIVE" - The domain association is active and no additional// action is required.//   "DOMAIN_VERIFICATION_REQUIRED" - The domain was previously verified in the// legacy system. User must reverify the domain through the ownership service.//   "DOMAIN_VERIFICATION_LOST" - The domain verification has been lost and the// domain is in the grace period before being removed from the Firebase Hosting// site.Statusstring `json:"status,omitempty"`// UpdateTime: Output only. The time at which the domain was last updated.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DomainName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DomainName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Domain: The intended behavior and status information of a domain.

func (Domain)MarshalJSON

func (sDomain) MarshalJSON() ([]byte,error)

typeDomainProvisioning

type DomainProvisioning struct {// CertChallengeDiscoveredTxt: The TXT records (for the certificate challenge)// that were found at the last DNS fetch.CertChallengeDiscoveredTxt []string `json:"certChallengeDiscoveredTxt,omitempty"`// CertChallengeDns: The DNS challenge for generating a certificate.CertChallengeDns *CertDnsChallenge `json:"certChallengeDns,omitempty"`// CertChallengeHttp: The HTTP challenge for generating a certificate.CertChallengeHttp *CertHttpChallenge `json:"certChallengeHttp,omitempty"`// CertStatus: The certificate provisioning status; updated when Firebase// Hosting provisions an SSL certificate for the domain.//// Possible values://   "CERT_STATUS_UNSPECIFIED" - Unspecified certificate provisioning status.//   "CERT_PENDING" - Waiting for certificate challenge to be created.//   "CERT_MISSING" - Waiting for certificate challenge to be met.//   "CERT_PROCESSING" - Certificate challenge met; attempting to// acquire/propagate certificate.//   "CERT_PROPAGATING" - Certificate obtained; propagating to the CDN.//   "CERT_ACTIVE" - Certificate provisioned and deployed across the CDN.//   "CERT_ERROR" - Certificate provisioning failed in a non-recoverable// manner.CertStatusstring `json:"certStatus,omitempty"`// DiscoveredIps: The IPs found at the last DNS fetch.DiscoveredIps []string `json:"discoveredIps,omitempty"`// DnsFetchTime: The time at which the last DNS fetch occurred.DnsFetchTimestring `json:"dnsFetchTime,omitempty"`// DnsStatus: The DNS record match status as of the last DNS fetch.//// Possible values://   "DNS_STATUS_UNSPECIFIED" - Unspecified DNS status.//   "DNS_PENDING" - No DNS records have been specified for this domain yet.//   "DNS_MISSING" - None of the required DNS records have been detected on the// domain.//   "DNS_PARTIAL_MATCH" - Some of the required DNS records were detected, but// not all of them. No extra (non-required) DNS records were detected.//   "DNS_MATCH" - All required DNS records were detected. No extra// (non-required) DNS records were detected.//   "DNS_EXTRANEOUS_MATCH" - The domain has at least one of the required DNS// records, and it has at least one extra (non-required) DNS record.DnsStatusstring `json:"dnsStatus,omitempty"`// ExpectedIps: The list of IPs to which the domain is expected to resolve.ExpectedIps []string `json:"expectedIps,omitempty"`// ForceSendFields is a list of field names (e.g. "CertChallengeDiscoveredTxt")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CertChallengeDiscoveredTxt") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DomainProvisioning: The current certificate provisioning status informationfor a domain.

func (DomainProvisioning)MarshalJSON

func (sDomainProvisioning) MarshalJSON() ([]byte,error)

typeDomainRedirect

type DomainRedirect struct {// DomainName: Required. The domain name to redirect to.DomainNamestring `json:"domainName,omitempty"`// Type: Required. The redirect status code.//// Possible values://   "REDIRECT_TYPE_UNSPECIFIED" - The default redirect type; should not be// intentionlly used.//   "MOVED_PERMANENTLY" - The redirect will respond with an HTTP status code// of `301 Moved Permanently`.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "DomainName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DomainName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DomainRedirect: Defines the behavior of a domain-level redirect. Domainredirects preserve the path of the redirect but replace the requested domainwith the one specified in the redirect configuration.

func (DomainRedirect)MarshalJSON

func (sDomainRedirect) MarshalJSON() ([]byte,error)

typeEmpty

type Empty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}

Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeHeader

type Header struct {// Glob: The user-supplied glob// (https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching)// to match against the request URL path.Globstring `json:"glob,omitempty"`// Headers: Required. The additional headers to add to the response.Headers map[string]string `json:"headers,omitempty"`// Regex: The user-supplied RE2 regular expression to match against the request// URL path.Regexstring `json:"regex,omitempty"`// ForceSendFields is a list of field names (e.g. "Glob") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Glob") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Header: A `Header`(https://firebase.google.com/docs/hosting/full-config#headers) specifies aURL pattern that, if matched to the request URL path, triggers Hosting toapply the specified custom response headers.

func (Header)MarshalJSON

func (sHeader) MarshalJSON() ([]byte,error)

typeHttpUpdateadded inv0.141.0

type HttpUpdate struct {// CheckError: Output only. An error encountered during the last contents// check. If null, the check completed successfully.CheckError *Status `json:"checkError,omitempty"`// Desired: Output only. A text string to serve at the path.Desiredstring `json:"desired,omitempty"`// Discovered: Output only. Whether Hosting was able to find the required file// contents on the specified path during its last check.Discoveredstring `json:"discovered,omitempty"`// LastCheckTime: Output only. The last time Hosting systems checked for the// file contents.LastCheckTimestring `json:"lastCheckTime,omitempty"`// Path: Output only. The path to the file.Pathstring `json:"path,omitempty"`// ForceSendFields is a list of field names (e.g. "CheckError") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CheckError") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HttpUpdate: A file you can add to your existing, non-Hosting hosting servicethat confirms your intent to allow Hosting's Certificate Authorities tocreate an SSL certificate for your domain.

func (HttpUpdate)MarshalJSONadded inv0.141.0

func (sHttpUpdate) MarshalJSON() ([]byte,error)

typeI18nConfigadded inv0.31.0

type I18nConfig struct {// Root: Required. The user-supplied path where country and language specific// content will be looked for within the public directory.Rootstring `json:"root,omitempty"`// ForceSendFields is a list of field names (e.g. "Root") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Root") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

I18nConfig: If provided, i18n rewrites are enabled.

func (I18nConfig)MarshalJSONadded inv0.31.0

func (sI18nConfig) MarshalJSON() ([]byte,error)

typeListChannelsResponseadded inv0.32.0

type ListChannelsResponse struct {// Channels: The list of channels.Channels []*Channel `json:"channels,omitempty"`// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Channels") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Channels") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ListChannelsResponse)MarshalJSONadded inv0.32.0

func (sListChannelsResponse) MarshalJSON() ([]byte,error)

typeListCustomDomainsResponseadded inv0.141.0

type ListCustomDomainsResponse struct {// CustomDomains: A list of `CustomDomain` entities associated with the// specified Firebase `Site`.CustomDomains []*CustomDomain `json:"customDomains,omitempty"`// NextPageToken: The pagination token, if more results exist beyond the ones// in this response. Include this token in your next call to// `ListCustomDomains`. Page tokens are short-lived and should not be stored.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CustomDomains") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CustomDomains") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListCustomDomainsResponse: The response from `ListCustomDomains`.

func (ListCustomDomainsResponse)MarshalJSONadded inv0.141.0

func (sListCustomDomainsResponse) MarshalJSON() ([]byte,error)

typeListDomainsResponse

type ListDomainsResponse struct {// Domains: The list of domains, if any exist.Domains []*Domain `json:"domains,omitempty"`// NextPageToken: The pagination token, if more results exist.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Domains") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Domains") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListDomainsResponse: The response to listing Domains.

func (ListDomainsResponse)MarshalJSON

func (sListDomainsResponse) MarshalJSON() ([]byte,error)

typeListOperationsResponseadded inv0.141.0

type ListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*Operation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections e.g. when attempting to list all resources across all supported// locations.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse)MarshalJSONadded inv0.141.0

func (sListOperationsResponse) MarshalJSON() ([]byte,error)

typeListReleasesResponse

type ListReleasesResponse struct {// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// Releases: The list of hashes of files that still need to be uploaded, if any// exist.Releases []*Release `json:"releases,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ListReleasesResponse)MarshalJSON

func (sListReleasesResponse) MarshalJSON() ([]byte,error)

typeListSitesResponseadded inv0.42.0

type ListSitesResponse struct {// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// Sites: A list of Site objects associated with the specified Firebase// project.Sites []*Site `json:"sites,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ListSitesResponse)MarshalJSONadded inv0.42.0

func (sListSitesResponse) MarshalJSON() ([]byte,error)

typeListVersionFilesResponse

type ListVersionFilesResponse struct {// Files:  The list of paths to the hashes of the files in the specified// version.Files []*VersionFile `json:"files,omitempty"`// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Files") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Files") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ListVersionFilesResponse)MarshalJSON

func (sListVersionFilesResponse) MarshalJSON() ([]byte,error)

typeListVersionsResponseadded inv0.14.0

type ListVersionsResponse struct {// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// Versions: The list of versions, if any exist.Versions []*Version `json:"versions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ListVersionsResponse)MarshalJSONadded inv0.14.0

func (sListVersionsResponse) MarshalJSON() ([]byte,error)

typeLiveMigrationStepadded inv0.141.0

type LiveMigrationStep struct {// CertVerification: Output only. A pair of ACME challenges that Hosting's// Certificate Authority (CA) can use to create an SSL cert for your domain// name. Use either the DNS or HTTP challenge; it's not necessary to provide// both.CertVerification *CertVerification `json:"certVerification,omitempty"`// DnsUpdates: Output only. DNS updates to facilitate your domain's// zero-downtime migration to Hosting.DnsUpdates *DnsUpdates `json:"dnsUpdates,omitempty"`// Issues: Output only. Issues that prevent the current step from completing.Issues []*Status `json:"issues,omitempty"`// State: Output only. The state of the live migration step, indicates whether// you should work to complete the step now, in the future, or have already// completed it.//// Possible values://   "STATE_UNSPECIFIED" - The step's state is unspecified. The message is// invalid if this is unspecified.//   "PREPARING" - Hosting doesn't have enough information to construct the// step yet. Complete any prior steps and/or resolve this step's issue to// proceed.//   "PENDING" - The step's state is pending. Complete prior steps before// working on a `PENDING` step.//   "INCOMPLETE" - The step is incomplete. You should complete any// `certVerification` or `dnsUpdates` changes to complete it.//   "PROCESSING" - You've done your part to update records and present// challenges as necessary. Hosting is now completing background processes to// complete the step, e.g. minting an SSL cert for your domain name.//   "COMPLETE" - The step is complete. You've already made the necessary// changes to your domain and/or prior hosting service to advance to the next// step. Once all steps are complete, Hosting is ready to serve secure content// on your domain.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "CertVerification") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CertVerification") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

LiveMigrationStep: A set of updates including ACME challenges and DNSrecords that allow Hosting to create an SSL certificate and establishproject ownership for your domain name before you direct traffic to Hostingservers. Use these updates to facilitate zero downtime migrations to Hostingfrom other services. After you've made the recommended updates, check yourcustom domain's `ownershipState` and `certState`. To avoid downtime, theyshould be `OWNERSHIP_ACTIVE` and `CERT_ACTIVE`, respectively, before youupdate your `A` and `AAAA` records.

func (LiveMigrationStep)MarshalJSONadded inv0.141.0

func (sLiveMigrationStep) MarshalJSON() ([]byte,error)

typeOperationadded inv0.16.0

type Operation struct {// Done: If the value is `false`, it means the operation is still in progress.// If `true`, the operation is completed, and either `error` or `response` is// available.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or cancellation.Error *Status `json:"error,omitempty"`// Metadata: Service-specific metadata associated with the operation. It// typically contains progress information and common metadata such as create// time. Some services might not provide such metadata. Any method that returns// a long-running operation should document the metadata type, if any.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: The server-assigned name, which is only unique within the same service// that originally returns it. If you use the default HTTP mapping, the `name`// should be a resource name ending with `operations/{unique_id}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. If the original// method returns no data on success, such as `Delete`, the response is// `google.protobuf.Empty`. If the original method is standard// `Get`/`Create`/`Update`, the response should be the resource. For other// methods, the response should have the type `XxxResponse`, where `Xxx` is the// original method name. For example, if the original method name is// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Operation: This resource represents a long-running operation that is theresult of a network API call.

func (Operation)MarshalJSONadded inv0.16.0

func (sOperation) MarshalJSON() ([]byte,error)

typePathFilteradded inv0.16.0

type PathFilter struct {// Regexes: An array of RegEx values by which to filter.Regexes []string `json:"regexes,omitempty"`// ForceSendFields is a list of field names (e.g. "Regexes") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Regexes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PathFilter: A representation of filter path.

func (PathFilter)MarshalJSONadded inv0.16.0

func (sPathFilter) MarshalJSON() ([]byte,error)

typePopulateVersionFilesRequest

type PopulateVersionFilesRequest struct {// Files: 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.Files map[string]string `json:"files,omitempty"`// ForceSendFields is a list of field names (e.g. "Files") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Files") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (PopulateVersionFilesRequest)MarshalJSON

func (sPopulateVersionFilesRequest) MarshalJSON() ([]byte,error)

typePopulateVersionFilesResponse

type PopulateVersionFilesResponse struct {// UploadRequiredHashes: The content hashes of the specified files that need to// be uploaded to the specified URL.UploadRequiredHashes []string `json:"uploadRequiredHashes,omitempty"`// UploadUrl: 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.UploadUrlstring `json:"uploadUrl,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "UploadRequiredHashes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "UploadRequiredHashes") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (PopulateVersionFilesResponse)MarshalJSON

func (sPopulateVersionFilesResponse) MarshalJSON() ([]byte,error)

typeProjectsOperationsGetCalladded inv0.16.0

type ProjectsOperationsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsOperationsGetCall)Contextadded inv0.16.0

Context sets the context to be used in this call's Do method.

func (*ProjectsOperationsGetCall)Doadded inv0.16.0

Do executes the "firebasehosting.projects.operations.get" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsOperationsGetCall)Fieldsadded inv0.16.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsOperationsGetCall)Headeradded inv0.16.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsOperationsGetCall)IfNoneMatchadded inv0.16.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsOperationsServiceadded inv0.16.0

type ProjectsOperationsService struct {// contains filtered or unexported fields}

funcNewProjectsOperationsServiceadded inv0.16.0

func NewProjectsOperationsService(s *Service) *ProjectsOperationsService

func (*ProjectsOperationsService)Getadded inv0.16.0

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

typeProjectsServiceadded inv0.16.0

type ProjectsService struct {Operations *ProjectsOperationsServiceSites *ProjectsSitesService// contains filtered or unexported fields}

funcNewProjectsServiceadded inv0.16.0

func NewProjectsService(s *Service) *ProjectsService

typeProjectsSitesChannelsCreateCalladded inv0.32.0

type ProjectsSitesChannelsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesChannelsCreateCall)ChannelIdadded inv0.32.0

ChannelId sets the optional parameter "channelId": Required. Immutable. Aunique ID within the site that identifies the channel.

func (*ProjectsSitesChannelsCreateCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesChannelsCreateCall)Doadded inv0.32.0

Do executes the "firebasehosting.projects.sites.channels.create" call.Any non-2xx status code is an error. Response headers are in either*Channel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsCreateCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesChannelsCreateCall)Headeradded inv0.32.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSitesChannelsDeleteCalladded inv0.32.0

type ProjectsSitesChannelsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesChannelsDeleteCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesChannelsDeleteCall)Doadded inv0.32.0

Do executes the "firebasehosting.projects.sites.channels.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsDeleteCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesChannelsDeleteCall)Headeradded inv0.32.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSitesChannelsGetCalladded inv0.32.0

type ProjectsSitesChannelsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesChannelsGetCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesChannelsGetCall)Doadded inv0.32.0

Do executes the "firebasehosting.projects.sites.channels.get" call.Any non-2xx status code is an error. Response headers are in either*Channel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsGetCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesChannelsGetCall)Headeradded inv0.32.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesChannelsGetCall)IfNoneMatchadded inv0.32.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsSitesChannelsListCalladded inv0.32.0

type ProjectsSitesChannelsListCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesChannelsListCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesChannelsListCall)Doadded inv0.32.0

Do executes the "firebasehosting.projects.sites.channels.list" call.Any non-2xx status code is an error. Response headers are in either*ListChannelsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsSitesChannelsListCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesChannelsListCall)Headeradded inv0.32.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesChannelsListCall)IfNoneMatchadded inv0.32.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsSitesChannelsListCall)PageSizeadded inv0.32.0

PageSize sets the optional parameter "pageSize": The maximum number ofchannels to return. The service may return a lower number if fewer channelsexist than this maximum number. If unspecified, defaults to 10. The maximumvalue is 100; values above 100 will be coerced to 100.

func (*ProjectsSitesChannelsListCall)PageTokenadded inv0.32.0

PageToken sets the optional parameter "pageToken": A token from a previouscall to `ListChannels` that tells the server where to resume listing.

func (*ProjectsSitesChannelsListCall)Pagesadded inv0.32.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsSitesChannelsPatchCalladded inv0.32.0

type ProjectsSitesChannelsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesChannelsPatchCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesChannelsPatchCall)Doadded inv0.32.0

Do executes the "firebasehosting.projects.sites.channels.patch" call.Any non-2xx status code is an error. Response headers are in either*Channel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsPatchCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesChannelsPatchCall)Headeradded inv0.32.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesChannelsPatchCall)UpdateMaskadded inv0.32.0

UpdateMask sets the optional parameter "updateMask": A comma-separated listof fields to be updated in this request.

typeProjectsSitesChannelsReleasesCreateCalladded inv0.21.0

type ProjectsSitesChannelsReleasesCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesChannelsReleasesCreateCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesChannelsReleasesCreateCall)Doadded inv0.21.0

Do executes the "firebasehosting.projects.sites.channels.releases.create" call.Any non-2xx status code is an error. Response headers are in either*Release.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsReleasesCreateCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesChannelsReleasesCreateCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesChannelsReleasesCreateCall)VersionNameadded inv0.21.0

VersionName sets the optional parameter "versionName": The unique identifierfor a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_IDin this version identifier must match the SITE_ID in the `parent` parameter.This query parameter must be empty if the `type` field in the request bodyis `SITE_DISABLE`.

typeProjectsSitesChannelsReleasesGetCalladded inv0.110.0

type ProjectsSitesChannelsReleasesGetCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesChannelsReleasesGetCall)Contextadded inv0.110.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesChannelsReleasesGetCall)Doadded inv0.110.0

Do executes the "firebasehosting.projects.sites.channels.releases.get" call.Any non-2xx status code is an error. Response headers are in either*Release.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsReleasesGetCall)Fieldsadded inv0.110.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesChannelsReleasesGetCall)Headeradded inv0.110.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesChannelsReleasesGetCall)IfNoneMatchadded inv0.110.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsSitesChannelsReleasesListCalladded inv0.21.0

type ProjectsSitesChannelsReleasesListCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesChannelsReleasesListCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesChannelsReleasesListCall)Doadded inv0.21.0

Do executes the "firebasehosting.projects.sites.channels.releases.list" call.Any non-2xx status code is an error. Response headers are in either*ListReleasesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsSitesChannelsReleasesListCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesChannelsReleasesListCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesChannelsReleasesListCall)IfNoneMatchadded inv0.21.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsSitesChannelsReleasesListCall)PageSizeadded inv0.21.0

PageSize sets the optional parameter "pageSize": The maximum number ofreleases to return. The service may return a lower number if fewer releasesexist than this maximum number. If unspecified, defaults to 100.

func (*ProjectsSitesChannelsReleasesListCall)PageTokenadded inv0.21.0

PageToken sets the optional parameter "pageToken": A token from a previouscall to `releases.list` or `channels.releases.list` that tells the serverwhere to resume listing.

func (*ProjectsSitesChannelsReleasesListCall)Pagesadded inv0.21.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsSitesChannelsReleasesServiceadded inv0.21.0

type ProjectsSitesChannelsReleasesService struct {// contains filtered or unexported fields}

funcNewProjectsSitesChannelsReleasesServiceadded inv0.21.0

func NewProjectsSitesChannelsReleasesService(s *Service) *ProjectsSitesChannelsReleasesService

func (*ProjectsSitesChannelsReleasesService)Createadded inv0.21.0

Create: Creates a new release, which makes the content of the specifiedversion actively display on the appropriate URL(s).

  • parent: The site or channel to which the release belongs, in either of thefollowing formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID.

func (*ProjectsSitesChannelsReleasesService)Getadded inv0.110.0

Get: Gets the specified release for a site or channel. When used to get arelease for a site, this can get releases for both the default `live`channel and any active preview channels for the specified site.

  • name: The fully-qualified resource name for the Hosting release, in eitherof the following formats: -sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID -sites/SITE_ID/releases/RELEASE_ID.

func (*ProjectsSitesChannelsReleasesService)Listadded inv0.21.0

List: Lists the releases that have been created for the specified site orchannel. When used to list releases for a site, this list includes releasesfor both the default `live` channel and any active preview channels for thespecified site.

  • parent: The site or channel for which to list releases, in either of thefollowing formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID.

typeProjectsSitesChannelsServiceadded inv0.21.0

type ProjectsSitesChannelsService struct {Releases *ProjectsSitesChannelsReleasesService// contains filtered or unexported fields}

funcNewProjectsSitesChannelsServiceadded inv0.21.0

func NewProjectsSitesChannelsService(s *Service) *ProjectsSitesChannelsService

func (*ProjectsSitesChannelsService)Createadded inv0.32.0

Create: Creates a new channel in the specified site.

  • parent: The site in which to create this channel, in the format: sites/SITE_ID.

func (*ProjectsSitesChannelsService)Deleteadded inv0.32.0

Delete: Deletes the specified channel of the specified site. The `live`channel cannot be deleted.

  • name: The fully-qualified resource name for the channel, in the format:sites/SITE_ID/channels/CHANNEL_ID.

func (*ProjectsSitesChannelsService)Getadded inv0.32.0

Get: Retrieves information for the specified channel of the specified site.

  • name: The fully-qualified resource name for the channel, in the format:sites/SITE_ID/channels/CHANNEL_ID.

func (*ProjectsSitesChannelsService)Listadded inv0.32.0

List: Lists the channels for the specified site. All sites have a default`live` channel.

- parent: The site for which to list channels, in the format: sites/SITE_ID.

func (*ProjectsSitesChannelsService)Patchadded inv0.32.0

Patch: Updates information for the specified channel of the specified site.Implicitly creates the channel if it doesn't already exist.

  • name: The fully-qualified resource name for the channel, in the format:sites/ SITE_ID/channels/CHANNEL_ID.

typeProjectsSitesCreateCalladded inv0.42.0

type ProjectsSitesCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesCreateCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesCreateCall)Doadded inv0.42.0

Do executes the "firebasehosting.projects.sites.create" call.Any non-2xx status code is an error. Response headers are in either*Site.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCreateCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesCreateCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesCreateCall)SiteIdadded inv0.42.0

SiteId sets the optional parameter "siteId": Required. Immutable. A globallyunique identifier for the Hosting site. This identifier is used to constructthe Firebase-provisioned subdomains for the site, so it must also be a validdomain name label.

func (*ProjectsSitesCreateCall)ValidateOnlyadded inv0.139.0

func (c *ProjectsSitesCreateCall) ValidateOnly(validateOnlybool) *ProjectsSitesCreateCall

ValidateOnly sets the optional parameter "validateOnly": If set, validatesthat the site_id is available and that the request would succeed, returningthe expected resulting site or error.

typeProjectsSitesCustomDomainsCreateCalladded inv0.141.0

type ProjectsSitesCustomDomainsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesCustomDomainsCreateCall)Contextadded inv0.141.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesCustomDomainsCreateCall)CustomDomainIdadded inv0.141.0

CustomDomainId sets the optional parameter "customDomainId": Required. TheID of the `CustomDomain`, which is the domain name you'd like to use withFirebase Hosting.

func (*ProjectsSitesCustomDomainsCreateCall)Doadded inv0.141.0

Do executes the "firebasehosting.projects.sites.customDomains.create" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsCreateCall)Fieldsadded inv0.141.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesCustomDomainsCreateCall)Headeradded inv0.141.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesCustomDomainsCreateCall)ValidateOnlyadded inv0.141.0

ValidateOnly sets the optional parameter "validateOnly": If true, Hostingvalidates that it's possible to complete your request but doesn't actuallycreate a new `CustomDomain`.

typeProjectsSitesCustomDomainsDeleteCalladded inv0.141.0

type ProjectsSitesCustomDomainsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesCustomDomainsDeleteCall)AllowMissingadded inv0.141.0

AllowMissing sets the optional parameter "allowMissing": If true, therequest succeeds even if the `CustomDomain` doesn't exist.

func (*ProjectsSitesCustomDomainsDeleteCall)Contextadded inv0.141.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesCustomDomainsDeleteCall)Doadded inv0.141.0

Do executes the "firebasehosting.projects.sites.customDomains.delete" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsDeleteCall)Etagadded inv0.141.0

Etag sets the optional parameter "etag": A tag that represents the state ofthe `CustomDomain` as you know it. If present, the supplied tag must matchthe current value on your `CustomDomain`, or the request fails.

func (*ProjectsSitesCustomDomainsDeleteCall)Fieldsadded inv0.141.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesCustomDomainsDeleteCall)Headeradded inv0.141.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesCustomDomainsDeleteCall)ValidateOnlyadded inv0.141.0

ValidateOnly sets the optional parameter "validateOnly": If true, Hostingvalidates that it's possible to complete your request but doesn't actuallydelete the `CustomDomain`.

typeProjectsSitesCustomDomainsGetCalladded inv0.141.0

type ProjectsSitesCustomDomainsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesCustomDomainsGetCall)Contextadded inv0.141.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesCustomDomainsGetCall)Doadded inv0.141.0

Do executes the "firebasehosting.projects.sites.customDomains.get" call.Any non-2xx status code is an error. Response headers are in either*CustomDomain.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsGetCall)Fieldsadded inv0.141.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesCustomDomainsGetCall)Headeradded inv0.141.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesCustomDomainsGetCall)IfNoneMatchadded inv0.141.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsSitesCustomDomainsListCalladded inv0.141.0

type ProjectsSitesCustomDomainsListCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesCustomDomainsListCall)Contextadded inv0.141.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesCustomDomainsListCall)Doadded inv0.141.0

Do executes the "firebasehosting.projects.sites.customDomains.list" call.Any non-2xx status code is an error. Response headers are in either*ListCustomDomainsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsListCall)Fieldsadded inv0.141.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesCustomDomainsListCall)Headeradded inv0.141.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesCustomDomainsListCall)IfNoneMatchadded inv0.141.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsSitesCustomDomainsListCall)PageSizeadded inv0.141.0

PageSize sets the optional parameter "pageSize": The max number of`CustomDomain` entities to return in a request. Defaults to 10.

func (*ProjectsSitesCustomDomainsListCall)PageTokenadded inv0.141.0

PageToken sets the optional parameter "pageToken": A token from a previouscall to `ListCustomDomains` that tells the server where to resume listing.

func (*ProjectsSitesCustomDomainsListCall)Pagesadded inv0.141.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsSitesCustomDomainsListCall)ShowDeletedadded inv0.141.0

ShowDeleted sets the optional parameter "showDeleted": If true, the requestreturns soft-deleted `CustomDomain`s that haven't been fully-deleted yet. Torestore deleted `CustomDomain`s, make an `UndeleteCustomDomain` request.

typeProjectsSitesCustomDomainsOperationsGetCalladded inv0.141.0

type ProjectsSitesCustomDomainsOperationsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesCustomDomainsOperationsGetCall)Contextadded inv0.141.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesCustomDomainsOperationsGetCall)Doadded inv0.141.0

Do executes the "firebasehosting.projects.sites.customDomains.operations.get" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsOperationsGetCall)Fieldsadded inv0.141.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesCustomDomainsOperationsGetCall)Headeradded inv0.141.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesCustomDomainsOperationsGetCall)IfNoneMatchadded inv0.141.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsSitesCustomDomainsOperationsListCalladded inv0.141.0

type ProjectsSitesCustomDomainsOperationsListCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesCustomDomainsOperationsListCall)Contextadded inv0.141.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesCustomDomainsOperationsListCall)Doadded inv0.141.0

Do executes the "firebasehosting.projects.sites.customDomains.operations.list" call.Any non-2xx status code is an error. Response headers are in either*ListOperationsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsSitesCustomDomainsOperationsListCall)Fieldsadded inv0.141.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesCustomDomainsOperationsListCall)Filteradded inv0.141.0

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsSitesCustomDomainsOperationsListCall)Headeradded inv0.141.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesCustomDomainsOperationsListCall)IfNoneMatchadded inv0.141.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsSitesCustomDomainsOperationsListCall)PageSizeadded inv0.141.0

PageSize sets the optional parameter "pageSize": The standard list pagesize.

func (*ProjectsSitesCustomDomainsOperationsListCall)PageTokenadded inv0.141.0

PageToken sets the optional parameter "pageToken": The standard list pagetoken.

func (*ProjectsSitesCustomDomainsOperationsListCall)Pagesadded inv0.141.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsSitesCustomDomainsOperationsListCall)ReturnPartialSuccessadded inv0.252.0

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in the[ListOperationsResponse.unreachable] field. This can only be `true` whenreading across collections e.g. when `parent` is set to"projects/example/locations/-". This field is not by default supported andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeProjectsSitesCustomDomainsOperationsServiceadded inv0.141.0

type ProjectsSitesCustomDomainsOperationsService struct {// contains filtered or unexported fields}

funcNewProjectsSitesCustomDomainsOperationsServiceadded inv0.141.0

func NewProjectsSitesCustomDomainsOperationsService(s *Service) *ProjectsSitesCustomDomainsOperationsService

func (*ProjectsSitesCustomDomainsOperationsService)Getadded inv0.141.0

Get: Gets the latest state of a long-running operation. Use this method topoll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*ProjectsSitesCustomDomainsOperationsService)Listadded inv0.141.0

List: Lists operations that match the specified filter in the request.

- name: The name of the operation's parent resource.

typeProjectsSitesCustomDomainsPatchCalladded inv0.141.0

type ProjectsSitesCustomDomainsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesCustomDomainsPatchCall)AllowMissingadded inv0.141.0

AllowMissing sets the optional parameter "allowMissing": If true, Hostingcreates the `CustomDomain` if it doesn't already exist.

func (*ProjectsSitesCustomDomainsPatchCall)Contextadded inv0.141.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesCustomDomainsPatchCall)Doadded inv0.141.0

Do executes the "firebasehosting.projects.sites.customDomains.patch" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsPatchCall)Fieldsadded inv0.141.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesCustomDomainsPatchCall)Headeradded inv0.141.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesCustomDomainsPatchCall)UpdateMaskadded inv0.141.0

UpdateMask sets the optional parameter "updateMask": The set of field namesfrom your `CustomDomain` that you want to update. A field will beoverwritten if, and only if, it's in the mask. If you don't provide a mask,Hosting updates the entire `CustomDomain`.

func (*ProjectsSitesCustomDomainsPatchCall)ValidateOnlyadded inv0.141.0

ValidateOnly sets the optional parameter "validateOnly": If true, Hostingvalidates that it's possible to complete your request but doesn't actuallycreate or update the `CustomDomain`.

typeProjectsSitesCustomDomainsServiceadded inv0.141.0

type ProjectsSitesCustomDomainsService struct {Operations *ProjectsSitesCustomDomainsOperationsService// contains filtered or unexported fields}

funcNewProjectsSitesCustomDomainsServiceadded inv0.141.0

func NewProjectsSitesCustomDomainsService(s *Service) *ProjectsSitesCustomDomainsService

func (*ProjectsSitesCustomDomainsService)Createadded inv0.141.0

Create: Creates a `CustomDomain`.

  • parent: The custom domain's parent, specifically a Firebase Hosting`Site`.

func (*ProjectsSitesCustomDomainsService)Deleteadded inv0.141.0

Delete: Deletes the specified `CustomDomain`.

- name: The name of the `CustomDomain` to delete.

func (*ProjectsSitesCustomDomainsService)Getadded inv0.141.0

Get: Gets the specified `CustomDomain`.

- name: The name of the `CustomDomain` to get.

func (*ProjectsSitesCustomDomainsService)Listadded inv0.141.0

List: Lists each `CustomDomain` associated with the specified parent Hostingsite. Returns `CustomDomain`s in a consistent, but undefined, order tofacilitate pagination.

  • parent: The Firebase Hosting `Site` with `CustomDomain` entities you'dlike to list.

func (*ProjectsSitesCustomDomainsService)Patchadded inv0.141.0

Patch: Updates the specified `CustomDomain`.

- name: Output only. The fully-qualified name of the `CustomDomain`.

func (*ProjectsSitesCustomDomainsService)Undeleteadded inv0.141.0

Undelete: Undeletes the specified `CustomDomain` if it has beensoft-deleted. Hosting retains soft-deleted custom domains for around 30 daysbefore permanently deleting them.

- name: The name of the `CustomDomain` to delete.

typeProjectsSitesCustomDomainsUndeleteCalladded inv0.141.0

type ProjectsSitesCustomDomainsUndeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesCustomDomainsUndeleteCall)Contextadded inv0.141.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesCustomDomainsUndeleteCall)Doadded inv0.141.0

Do executes the "firebasehosting.projects.sites.customDomains.undelete" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsUndeleteCall)Fieldsadded inv0.141.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesCustomDomainsUndeleteCall)Headeradded inv0.141.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSitesDeleteCalladded inv0.42.0

type ProjectsSitesDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesDeleteCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesDeleteCall)Doadded inv0.42.0

Do executes the "firebasehosting.projects.sites.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDeleteCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesDeleteCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSitesDomainsCreateCalladded inv0.23.0

type ProjectsSitesDomainsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesDomainsCreateCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesDomainsCreateCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.domains.create" call.Any non-2xx status code is an error. Response headers are in either*Domain.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDomainsCreateCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesDomainsCreateCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSitesDomainsDeleteCalladded inv0.23.0

type ProjectsSitesDomainsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesDomainsDeleteCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesDomainsDeleteCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.domains.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDomainsDeleteCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesDomainsDeleteCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSitesDomainsGetCalladded inv0.23.0

type ProjectsSitesDomainsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesDomainsGetCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesDomainsGetCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.domains.get" call.Any non-2xx status code is an error. Response headers are in either*Domain.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDomainsGetCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesDomainsGetCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesDomainsGetCall)IfNoneMatchadded inv0.23.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsSitesDomainsListCalladded inv0.23.0

type ProjectsSitesDomainsListCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesDomainsListCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesDomainsListCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.domains.list" call.Any non-2xx status code is an error. Response headers are in either*ListDomainsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsSitesDomainsListCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesDomainsListCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesDomainsListCall)IfNoneMatchadded inv0.23.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsSitesDomainsListCall)PageSizeadded inv0.23.0

PageSize sets the optional parameter "pageSize": The page size to return.Defaults to 50.

func (*ProjectsSitesDomainsListCall)PageTokenadded inv0.23.0

PageToken sets the optional parameter "pageToken": The next_page_token froma previous request, if provided.

func (*ProjectsSitesDomainsListCall)Pagesadded inv0.23.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsSitesDomainsServiceadded inv0.23.0

type ProjectsSitesDomainsService struct {// contains filtered or unexported fields}

funcNewProjectsSitesDomainsServiceadded inv0.23.0

func NewProjectsSitesDomainsService(s *Service) *ProjectsSitesDomainsService

func (*ProjectsSitesDomainsService)Createadded inv0.23.0

Create: Creates a domain mapping on the specified site.

  • parent: The parent to create the domain association for, in the format:sites/site-name.

func (*ProjectsSitesDomainsService)Deleteadded inv0.23.0

Delete: Deletes the existing domain mapping on the specified site.

- name: The name of the domain association to delete.

func (*ProjectsSitesDomainsService)Getadded inv0.23.0

Get: Gets a domain mapping on the specified site.

- name: The name of the domain configuration to get.

func (*ProjectsSitesDomainsService)Listadded inv0.23.0

List: Lists the domains for the specified site.

  • parent: The parent for which to list domains, in the format: sites/site-name.

func (*ProjectsSitesDomainsService)Updateadded inv0.23.0

Update: Updates the specified domain mapping, creating the mapping as if itdoes not exist.

  • name: The name of the domain association to update or create, if anassociation doesn't already exist.

typeProjectsSitesDomainsUpdateCalladded inv0.23.0

type ProjectsSitesDomainsUpdateCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesDomainsUpdateCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesDomainsUpdateCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.domains.update" call.Any non-2xx status code is an error. Response headers are in either*Domain.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDomainsUpdateCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesDomainsUpdateCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSitesGetCalladded inv0.42.0

type ProjectsSitesGetCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesGetCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesGetCall)Doadded inv0.42.0

Do executes the "firebasehosting.projects.sites.get" call.Any non-2xx status code is an error. Response headers are in either*Site.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesGetCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesGetCall)Headeradded inv0.42.0

func (c *ProjectsSitesGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesGetCall)IfNoneMatchadded inv0.42.0

func (c *ProjectsSitesGetCall) IfNoneMatch(entityTagstring) *ProjectsSitesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsSitesGetConfigCalladded inv0.23.0

type ProjectsSitesGetConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesGetConfigCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesGetConfigCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.getConfig" call.Any non-2xx status code is an error. Response headers are in either*SiteConfig.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesGetConfigCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesGetConfigCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesGetConfigCall)IfNoneMatchadded inv0.23.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsSitesListCalladded inv0.42.0

type ProjectsSitesListCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesListCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesListCall)Doadded inv0.42.0

Do executes the "firebasehosting.projects.sites.list" call.Any non-2xx status code is an error. Response headers are in either*ListSitesResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsSitesListCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesListCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesListCall)IfNoneMatchadded inv0.42.0

func (c *ProjectsSitesListCall) IfNoneMatch(entityTagstring) *ProjectsSitesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsSitesListCall)PageSizeadded inv0.42.0

PageSize sets the optional parameter "pageSize": The maximum number of sitesto return. The service may return a lower number if fewer sites exist thanthis maximum number. If unspecified, defaults to 40.

func (*ProjectsSitesListCall)PageTokenadded inv0.42.0

func (c *ProjectsSitesListCall) PageToken(pageTokenstring) *ProjectsSitesListCall

PageToken sets the optional parameter "pageToken": A token from a previouscall to `ListSites` that tells the server where to resume listing.

func (*ProjectsSitesListCall)Pagesadded inv0.42.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsSitesPatchCalladded inv0.42.0

type ProjectsSitesPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesPatchCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesPatchCall)Doadded inv0.42.0

Do executes the "firebasehosting.projects.sites.patch" call.Any non-2xx status code is an error. Response headers are in either*Site.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesPatchCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesPatchCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesPatchCall)UpdateMaskadded inv0.42.0

func (c *ProjectsSitesPatchCall) UpdateMask(updateMaskstring) *ProjectsSitesPatchCall

UpdateMask sets the optional parameter "updateMask": A set of field namesfrom your Site that you want to update.

typeProjectsSitesReleasesCreateCalladded inv0.21.0

type ProjectsSitesReleasesCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesReleasesCreateCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesReleasesCreateCall)Doadded inv0.21.0

Do executes the "firebasehosting.projects.sites.releases.create" call.Any non-2xx status code is an error. Response headers are in either*Release.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesReleasesCreateCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesReleasesCreateCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesReleasesCreateCall)VersionNameadded inv0.21.0

VersionName sets the optional parameter "versionName": The unique identifierfor a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_IDin this version identifier must match the SITE_ID in the `parent` parameter.This query parameter must be empty if the `type` field in the request bodyis `SITE_DISABLE`.

typeProjectsSitesReleasesGetCalladded inv0.110.0

type ProjectsSitesReleasesGetCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesReleasesGetCall)Contextadded inv0.110.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesReleasesGetCall)Doadded inv0.110.0

Do executes the "firebasehosting.projects.sites.releases.get" call.Any non-2xx status code is an error. Response headers are in either*Release.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesReleasesGetCall)Fieldsadded inv0.110.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesReleasesGetCall)Headeradded inv0.110.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesReleasesGetCall)IfNoneMatchadded inv0.110.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsSitesReleasesListCalladded inv0.21.0

type ProjectsSitesReleasesListCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesReleasesListCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesReleasesListCall)Doadded inv0.21.0

Do executes the "firebasehosting.projects.sites.releases.list" call.Any non-2xx status code is an error. Response headers are in either*ListReleasesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsSitesReleasesListCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesReleasesListCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesReleasesListCall)IfNoneMatchadded inv0.21.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsSitesReleasesListCall)PageSizeadded inv0.21.0

PageSize sets the optional parameter "pageSize": The maximum number ofreleases to return. The service may return a lower number if fewer releasesexist than this maximum number. If unspecified, defaults to 100.

func (*ProjectsSitesReleasesListCall)PageTokenadded inv0.21.0

PageToken sets the optional parameter "pageToken": A token from a previouscall to `releases.list` or `channels.releases.list` that tells the serverwhere to resume listing.

func (*ProjectsSitesReleasesListCall)Pagesadded inv0.21.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsSitesReleasesServiceadded inv0.21.0

type ProjectsSitesReleasesService struct {// contains filtered or unexported fields}

funcNewProjectsSitesReleasesServiceadded inv0.21.0

func NewProjectsSitesReleasesService(s *Service) *ProjectsSitesReleasesService

func (*ProjectsSitesReleasesService)Createadded inv0.21.0

Create: Creates a new release, which makes the content of the specifiedversion actively display on the appropriate URL(s).

  • parent: The site or channel to which the release belongs, in either of thefollowing formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID.

func (*ProjectsSitesReleasesService)Getadded inv0.110.0

Get: Gets the specified release for a site or channel. When used to get arelease for a site, this can get releases for both the default `live`channel and any active preview channels for the specified site.

  • name: The fully-qualified resource name for the Hosting release, in eitherof the following formats: -sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID -sites/SITE_ID/releases/RELEASE_ID.

func (*ProjectsSitesReleasesService)Listadded inv0.21.0

List: Lists the releases that have been created for the specified site orchannel. When used to list releases for a site, this list includes releasesfor both the default `live` channel and any active preview channels for thespecified site.

  • parent: The site or channel for which to list releases, in either of thefollowing formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID.

typeProjectsSitesServiceadded inv0.21.0

type ProjectsSitesService struct {Channels *ProjectsSitesChannelsServiceCustomDomains *ProjectsSitesCustomDomainsServiceDomains *ProjectsSitesDomainsServiceReleases *ProjectsSitesReleasesServiceVersions *ProjectsSitesVersionsService// contains filtered or unexported fields}

funcNewProjectsSitesServiceadded inv0.21.0

func NewProjectsSitesService(s *Service) *ProjectsSitesService

func (*ProjectsSitesService)Createadded inv0.42.0

Create: Creates a new Hosting Site in the specified parent Firebase project.Note that Hosting sites can take several minutes to propagate throughFirebase systems.

  • parent: The Firebase project in which to create a Hosting site, in theformat: projects/PROJECT_IDENTIFIER Refer to the `Site` `name`(../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIERvalues.

func (*ProjectsSitesService)Deleteadded inv0.42.0

Delete: Deletes the specified Hosting Site from the specified parentFirebase project.

  • name: The fully-qualified resource name for the Hosting site, in theformat: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to the `Site``name` (../projects#Site.FIELDS.name) field for details aboutPROJECT_IDENTIFIER values.

func (*ProjectsSitesService)Getadded inv0.42.0

Get: Gets the specified Hosting Site.

  • name: The fully-qualified resource name for the Hosting site, in theformat: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to the `Site``name` (../projects#Site.FIELDS.name) field for details aboutPROJECT_IDENTIFIER values. Since a SITE_ID is a globally uniqueidentifier, you can also use the unique sub-collection resource accesspattern, in the format: projects/-/sites/SITE_ID.

func (*ProjectsSitesService)GetConfigadded inv0.23.0

GetConfig: Gets the Hosting metadata for a specific site.

  • name: The site for which to get the SiteConfig, in the format: sites/site-name/config.

func (*ProjectsSitesService)Listadded inv0.42.0

List: Lists each Hosting Site associated with the specified parent Firebaseproject.

  • parent: The Firebase project for which to list sites, in the format:projects/PROJECT_IDENTIFIER Refer to the `Site` `name`(../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIERvalues.

func (*ProjectsSitesService)Patchadded inv0.42.0

Patch: Updates attributes of the specified Hosting Site.

func (*ProjectsSitesService)UpdateConfigadded inv0.23.0

func (r *ProjectsSitesService) UpdateConfig(namestring, siteconfig *SiteConfig) *ProjectsSitesUpdateConfigCall

UpdateConfig: Sets the Hosting metadata for a specific site.

  • name: The site for which to update the SiteConfig, in the format: sites/site-name/config.

typeProjectsSitesUpdateConfigCalladded inv0.23.0

type ProjectsSitesUpdateConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesUpdateConfigCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesUpdateConfigCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.updateConfig" call.Any non-2xx status code is an error. Response headers are in either*SiteConfig.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesUpdateConfigCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesUpdateConfigCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesUpdateConfigCall)UpdateMaskadded inv0.23.0

UpdateMask sets the optional parameter "updateMask": A set of field namesfrom your site configuration (../sites.SiteConfig) that you want to update.A field will be overwritten if, and only if, it's in the mask. If a mask isnot provided then a default mask of only `max_versions`(../sites.SiteConfig.max_versions) will be used.

typeProjectsSitesVersionsCloneCalladded inv0.23.0

type ProjectsSitesVersionsCloneCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesVersionsCloneCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesVersionsCloneCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.versions.clone" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsCloneCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesVersionsCloneCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSitesVersionsCreateCalladded inv0.23.0

type ProjectsSitesVersionsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesVersionsCreateCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesVersionsCreateCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.versions.create" call.Any non-2xx status code is an error. Response headers are in either*Version.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsCreateCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesVersionsCreateCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesVersionsCreateCall)SizeBytesadded inv0.23.0

SizeBytes sets the optional parameter "sizeBytes": The self-reported size ofthe version. This value is used for a pre-emptive quota check for legacyversion uploads.

func (*ProjectsSitesVersionsCreateCall)VersionIdadded inv0.23.0

VersionId sets the optional parameter "versionId": A unique id for the newversion. This is was only specified for legacy version creations, and shouldbe blank.

typeProjectsSitesVersionsDeleteCalladded inv0.23.0

type ProjectsSitesVersionsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesVersionsDeleteCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesVersionsDeleteCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.versions.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsDeleteCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesVersionsDeleteCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSitesVersionsFilesListCalladded inv0.23.0

type ProjectsSitesVersionsFilesListCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesVersionsFilesListCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesVersionsFilesListCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.versions.files.list" call.Any non-2xx status code is an error. Response headers are in either*ListVersionFilesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsSitesVersionsFilesListCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesVersionsFilesListCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesVersionsFilesListCall)IfNoneMatchadded inv0.23.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsSitesVersionsFilesListCall)PageSizeadded inv0.23.0

PageSize sets the optional parameter "pageSize": The maximum number ofversion files to return. The service may return a lower number if fewerversion files exist than this maximum number. If unspecified, defaults to1000.

func (*ProjectsSitesVersionsFilesListCall)PageTokenadded inv0.23.0

PageToken sets the optional parameter "pageToken": A token from a previouscall to `ListVersionFiles` that tells the server where to resume listing.

func (*ProjectsSitesVersionsFilesListCall)Pagesadded inv0.23.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsSitesVersionsFilesListCall)Statusadded inv0.23.0

Status sets the optional parameter "status": The type of files that shouldbe listed for the specified version.

Possible values:

"STATUS_UNSPECIFIED" - The default status; should not be intentionally

used.

"EXPECTED" - The file has been included in the version and is expected to

be uploaded in the near future.

"ACTIVE" - The file has already been uploaded to Firebase Hosting.

typeProjectsSitesVersionsFilesServiceadded inv0.23.0

type ProjectsSitesVersionsFilesService struct {// contains filtered or unexported fields}

funcNewProjectsSitesVersionsFilesServiceadded inv0.23.0

func NewProjectsSitesVersionsFilesService(s *Service) *ProjectsSitesVersionsFilesService

func (*ProjectsSitesVersionsFilesService)Listadded inv0.23.0

List: Lists the remaining files to be uploaded for the specified version.

  • parent: The version for which to list files, in the format: sites/SITE_ID/versions/VERSION_ID.

typeProjectsSitesVersionsGetCalladded inv0.110.0

type ProjectsSitesVersionsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesVersionsGetCall)Contextadded inv0.110.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesVersionsGetCall)Doadded inv0.110.0

Do executes the "firebasehosting.projects.sites.versions.get" call.Any non-2xx status code is an error. Response headers are in either*Version.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsGetCall)Fieldsadded inv0.110.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesVersionsGetCall)Headeradded inv0.110.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesVersionsGetCall)IfNoneMatchadded inv0.110.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsSitesVersionsListCalladded inv0.23.0

type ProjectsSitesVersionsListCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesVersionsListCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesVersionsListCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.versions.list" call.Any non-2xx status code is an error. Response headers are in either*ListVersionsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsSitesVersionsListCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesVersionsListCall)Filteradded inv0.23.0

Filter sets the optional parameter "filter": A filter string used to returna subset of versions in the response. The currently supported fields forfiltering are: `name`, `status`, and `create_time`. Learn more aboutfiltering in Google's AIP 160 standard (https://google.aip.dev/160).

func (*ProjectsSitesVersionsListCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesVersionsListCall)IfNoneMatchadded inv0.23.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsSitesVersionsListCall)PageSizeadded inv0.23.0

PageSize sets the optional parameter "pageSize": The maximum number ofversions to return. The service may return a lower number if fewer versionsexist than this maximum number. If unspecified, defaults to 25. The maximumvalue is 100; values above 100 will be coerced to 100.

func (*ProjectsSitesVersionsListCall)PageTokenadded inv0.23.0

PageToken sets the optional parameter "pageToken": A token from a previouscall to `ListVersions` that tells the server where to resume listing.

func (*ProjectsSitesVersionsListCall)Pagesadded inv0.23.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsSitesVersionsPatchCalladded inv0.23.0

type ProjectsSitesVersionsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesVersionsPatchCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesVersionsPatchCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.versions.patch" call.Any non-2xx status code is an error. Response headers are in either*Version.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsPatchCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesVersionsPatchCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSitesVersionsPatchCall)UpdateMaskadded inv0.23.0

UpdateMask sets the optional parameter "updateMask": A set of field namesfrom your version (../sites.versions) that you want to update. A field willbe overwritten if, and only if, it's in the mask. If a mask is not providedthen a default mask of only `status`(../sites.versions#Version.FIELDS.status) will be used.

typeProjectsSitesVersionsPopulateFilesCalladded inv0.23.0

type ProjectsSitesVersionsPopulateFilesCall struct {// contains filtered or unexported fields}

func (*ProjectsSitesVersionsPopulateFilesCall)Contextadded inv0.23.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSitesVersionsPopulateFilesCall)Doadded inv0.23.0

Do executes the "firebasehosting.projects.sites.versions.populateFiles" call.Any non-2xx status code is an error. Response headers are in either*PopulateVersionFilesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsSitesVersionsPopulateFilesCall)Fieldsadded inv0.23.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSitesVersionsPopulateFilesCall)Headeradded inv0.23.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSitesVersionsServiceadded inv0.23.0

type ProjectsSitesVersionsService struct {Files *ProjectsSitesVersionsFilesService// contains filtered or unexported fields}

funcNewProjectsSitesVersionsServiceadded inv0.23.0

func NewProjectsSitesVersionsService(s *Service) *ProjectsSitesVersionsService

func (*ProjectsSitesVersionsService)Cloneadded inv0.23.0

Clone: Creates a new version on the specified target site using the contentof the specified version.

  • parent: The target site for the cloned version, in the format: sites/SITE_ID.

func (*ProjectsSitesVersionsService)Createadded inv0.23.0

Create: Creates a new version for the specified site.

  • parent: The site in which to create the version, in the format: sites/SITE_ID.

func (*ProjectsSitesVersionsService)Deleteadded inv0.23.0

Delete: Deletes the specified version.

  • name: The fully-qualified resource name for the version, in the format:sites/SITE_ID/versions/VERSION_ID.

func (*ProjectsSitesVersionsService)Getadded inv0.110.0

Get: Get the specified version that has been created for the specified site.This can include versions that were created for the default `live` channelor for any active preview channels for the specified site.

  • name: The fully-qualified resource name for the version, in the format:sites/SITE_ID/versions/VERSION_ID.

func (*ProjectsSitesVersionsService)Listadded inv0.23.0

List: Lists the versions that have been created for the specified site. Thislist includes versions for both the default `live` channel and any activepreview channels for the specified site.

  • parent: The site or channel for which to list versions, in either of thefollowing formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID.

func (*ProjectsSitesVersionsService)Patchadded inv0.23.0

Patch: Updates the specified metadata for the specified version. Thismethod will fail with `FAILED_PRECONDITION` in the event of an invalid statetransition. The supported state (../sites.versions#versionstatus)transitions for a version are from `CREATED` to `FINALIZED`. Use`DeleteVersion` (delete) to set the status of a version to `DELETED`.

  • name: The fully-qualified resource name for the version, in the format:sites/ SITE_ID/versions/VERSION_ID This name is provided in the responsebody when you call `CreateVersion` (sites.versions/create).

func (*ProjectsSitesVersionsService)PopulateFilesadded inv0.23.0

PopulateFiles: Adds content files to the specified version. Each file mustbe under 2 GB.

  • parent: The version to which to add files, in the format: sites/SITE_ID/versions/VERSION_ID.

typeRedirect

type Redirect struct {// Glob: The user-supplied glob// (https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching)// to match against the request URL path.Globstring `json:"glob,omitempty"`// Location: Required. The value to put in the HTTP location header of the// response. The location can contain capture group values from the pattern// using a `:` prefix to identify the segment and an optional `*` to capture// the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301,// "location": "https://example.com/foo/:capture"Locationstring `json:"location,omitempty"`// Regex: The user-supplied RE2 regular expression to match against the request// URL path.Regexstring `json:"regex,omitempty"`// StatusCode: Required. The status HTTP code to return in the response. It// must be a valid 3xx status code.StatusCodeint64 `json:"statusCode,omitempty"`// ForceSendFields is a list of field names (e.g. "Glob") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Glob") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Redirect: A `Redirect`(https://firebase.google.com/docs/hosting/full-config#redirects) specifies aURL pattern that, if matched to the request URL path, triggers Hosting torespond with a redirect to the specified destination path.

func (Redirect)MarshalJSON

func (sRedirect) MarshalJSON() ([]byte,error)

typeRelease

type Release struct {// Message: The deploy description when the release was created. The value can// be up to 512 characters.Messagestring `json:"message,omitempty"`// Name: 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).Namestring `json:"name,omitempty"`// ReleaseTime: Output only. The time at which the version is set to be public.ReleaseTimestring `json:"releaseTime,omitempty"`// ReleaseUser: Output only. Identifies the user who created the release.ReleaseUser *ActingUser `json:"releaseUser,omitempty"`// Type: Explains the reason for the release. Specify a value for this field// only when creating a `SITE_DISABLE` type release.//// Possible values://   "TYPE_UNSPECIFIED" - An unspecified type. Indicates that a version was// released. This is the default value when no other `type` is explicitly// specified.//   "DEPLOY" - A version was uploaded to Firebase Hosting and released.//   "ROLLBACK" - The release points back to a previously deployed version.//   "SITE_DISABLE" - The release prevents the site from serving content.// Firebase Hosting acts as if the site never existed.Typestring `json:"type,omitempty"`// Version: Output only. The configuration and content that was released.Version *Version `json:"version,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Message") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Message") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Release: A `Release` is a particular collection of configurations and files(sites.versions) that is set to be public at a particular time.

func (Release)MarshalJSON

func (sRelease) MarshalJSON() ([]byte,error)

typeRewrite

type Rewrite struct {// DynamicLinks: The request will be forwarded to Firebase Dynamic Links.DynamicLinksbool `json:"dynamicLinks,omitempty"`// Function: The function to proxy requests to. Must match the exported// function name exactly.Functionstring `json:"function,omitempty"`// FunctionRegion: Optional. Specify a Cloud region for rewritten Functions// invocations. If not provided, defaults to us-central1.FunctionRegionstring `json:"functionRegion,omitempty"`// Glob: The user-supplied glob// (https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching)// to match against the request URL path.Globstring `json:"glob,omitempty"`// Path: The URL path to rewrite the request to.Pathstring `json:"path,omitempty"`// Regex: The user-supplied RE2 regular expression to match against the request// URL path.Regexstring `json:"regex,omitempty"`// Run: The request will be forwarded to Cloud Run.Run *CloudRunRewrite `json:"run,omitempty"`// ForceSendFields is a list of field names (e.g. "DynamicLinks") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DynamicLinks") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Rewrite: A `Rewrite`(https://firebase.google.com/docs/hosting/full-config#rewrites) specifies aURL pattern that, if matched to the request URL path, triggers Hosting torespond as if the service were given the specified destination URL.

func (Rewrite)MarshalJSON

func (sRewrite) MarshalJSON() ([]byte,error)

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsServiceSites *SitesService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewServiceadded inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

typeServingConfig

type ServingConfig struct {// AppAssociation: How to handle well known App Association files.//// Possible values://   "AUTO" - The app association files will be automatically created from the// apps that exist in the Firebase project.//   "NONE" - No special handling of the app association files will occur,// these paths will result in a 404 unless caught with a Rewrite.AppAssociationstring `json:"appAssociation,omitempty"`// CleanUrls: Defines whether to drop the file extension from uploaded files.CleanUrlsbool `json:"cleanUrls,omitempty"`// Headers: An array of objects, where each object specifies a URL pattern// that, if matched to the request URL path, triggers Hosting to apply the// specified custom response headers.Headers []*Header `json:"headers,omitempty"`// I18n: Optional. Defines i18n rewrite behavior.I18n *I18nConfig `json:"i18n,omitempty"`// Redirects: An array of objects (called redirect rules), where each rule// specifies a URL pattern that, if matched to the request URL path, triggers// Hosting to respond with a redirect to the specified destination path.Redirects []*Redirect `json:"redirects,omitempty"`// Rewrites: An array of objects (called rewrite rules), where each rule// 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.Rewrites []*Rewrite `json:"rewrites,omitempty"`// TrailingSlashBehavior: Defines how to handle a trailing slash in the URL// path.//// Possible values://   "TRAILING_SLASH_BEHAVIOR_UNSPECIFIED" - No behavior is specified. Files// are served at their exact location only, and trailing slashes are only added// to directory indexes.//   "ADD" - Trailing slashes are _added_ to directory indexes as well as to// any URL path not ending in a file extension.//   "REMOVE" - Trailing slashes are _removed_ from directory indexes as well// as from any URL path not ending in a file extension.TrailingSlashBehaviorstring `json:"trailingSlashBehavior,omitempty"`// ForceSendFields is a list of field names (e.g. "AppAssociation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppAssociation") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ServingConfig: The configuration for how incoming requests to a site shouldbe routed and processed before serving content. The URL request paths arematched against the specified URL patterns in the configuration, thenHosting applies the applicable configuration according to a specificpriority order(https://firebase.google.com/docs/hosting/full-config#hosting_priority_order).

func (ServingConfig)MarshalJSON

func (sServingConfig) MarshalJSON() ([]byte,error)

typeSiteadded inv0.42.0

type Site struct {// AppId: Optional. The ID of a Web App// (https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id)// associated with the Hosting site.AppIdstring `json:"appId,omitempty"`// DefaultUrl: Output only. The default URL for the Hosting site.DefaultUrlstring `json:"defaultUrl,omitempty"`// Labels: Optional. User-specified labels for the Hosting site.Labels map[string]string `json:"labels,omitempty"`// Name: Output only. The fully-qualified resource name of the Hosting site, in// the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER:// the Firebase project's `ProjectNumber`// (https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number)// ***(recommended)*** or its `ProjectId`// (https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id).// Learn more about using project identifiers in Google's AIP 2510 standard// (https://google.aip.dev/cloud/2510).Namestring `json:"name,omitempty"`// Type: Output only. The type of Hosting site. Every Firebase project has a// `DEFAULT_SITE`, which is created when Hosting is provisioned for the// project. All additional sites are `USER_SITE`.//// Possible values://   "TYPE_UNSPECIFIED" - Unknown state, likely the result of an error on the// backend.//   "DEFAULT_SITE" - The default Hosting site that is provisioned when a// Firebase project is created.//   "USER_SITE" - A Hosting site that the user created.Typestring `json:"type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AppId") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Site: A `Site` represents a Firebase Hosting site.

func (Site)MarshalJSONadded inv0.42.0

func (sSite) MarshalJSON() ([]byte,error)

typeSiteConfig

type SiteConfig struct {// CloudLoggingEnabled: Whether or not web requests made by site visitors are// logged via Cloud Logging.CloudLoggingEnabledbool `json:"cloudLoggingEnabled,omitempty"`// MaxVersions: The number of FINALIZED versions that will be held for a site// before automatic deletion. When a new version is deployed, content for// versions in storage in excess of this number will be deleted, and will no// longer be billed for storage usage. Oldest versions will be deleted first;// sites are created with an unlimited number of max_versions by default.MaxVersionsint64 `json:"maxVersions,omitempty,string"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CloudLoggingEnabled") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CloudLoggingEnabled") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SiteConfig: A `SiteConfig` contains metadata associated with a specific sitethat controls Firebase Hosting serving behavior

func (SiteConfig)MarshalJSON

func (sSiteConfig) MarshalJSON() ([]byte,error)

typeSitesChannelsCreateCalladded inv0.32.0

type SitesChannelsCreateCall struct {// contains filtered or unexported fields}

func (*SitesChannelsCreateCall)ChannelIdadded inv0.32.0

ChannelId sets the optional parameter "channelId": Required. Immutable. Aunique ID within the site that identifies the channel.

func (*SitesChannelsCreateCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*SitesChannelsCreateCall)Doadded inv0.32.0

Do executes the "firebasehosting.sites.channels.create" call.Any non-2xx status code is an error. Response headers are in either*Channel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsCreateCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesChannelsCreateCall)Headeradded inv0.32.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSitesChannelsDeleteCalladded inv0.32.0

type SitesChannelsDeleteCall struct {// contains filtered or unexported fields}

func (*SitesChannelsDeleteCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*SitesChannelsDeleteCall)Doadded inv0.32.0

Do executes the "firebasehosting.sites.channels.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsDeleteCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesChannelsDeleteCall)Headeradded inv0.32.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSitesChannelsGetCalladded inv0.32.0

type SitesChannelsGetCall struct {// contains filtered or unexported fields}

func (*SitesChannelsGetCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*SitesChannelsGetCall)Doadded inv0.32.0

Do executes the "firebasehosting.sites.channels.get" call.Any non-2xx status code is an error. Response headers are in either*Channel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsGetCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesChannelsGetCall)Headeradded inv0.32.0

func (c *SitesChannelsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesChannelsGetCall)IfNoneMatchadded inv0.32.0

func (c *SitesChannelsGetCall) IfNoneMatch(entityTagstring) *SitesChannelsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeSitesChannelsListCalladded inv0.32.0

type SitesChannelsListCall struct {// contains filtered or unexported fields}

func (*SitesChannelsListCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*SitesChannelsListCall)Doadded inv0.32.0

Do executes the "firebasehosting.sites.channels.list" call.Any non-2xx status code is an error. Response headers are in either*ListChannelsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*SitesChannelsListCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesChannelsListCall)Headeradded inv0.32.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesChannelsListCall)IfNoneMatchadded inv0.32.0

func (c *SitesChannelsListCall) IfNoneMatch(entityTagstring) *SitesChannelsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*SitesChannelsListCall)PageSizeadded inv0.32.0

PageSize sets the optional parameter "pageSize": The maximum number ofchannels to return. The service may return a lower number if fewer channelsexist than this maximum number. If unspecified, defaults to 10. The maximumvalue is 100; values above 100 will be coerced to 100.

func (*SitesChannelsListCall)PageTokenadded inv0.32.0

func (c *SitesChannelsListCall) PageToken(pageTokenstring) *SitesChannelsListCall

PageToken sets the optional parameter "pageToken": A token from a previouscall to `ListChannels` that tells the server where to resume listing.

func (*SitesChannelsListCall)Pagesadded inv0.32.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeSitesChannelsPatchCalladded inv0.32.0

type SitesChannelsPatchCall struct {// contains filtered or unexported fields}

func (*SitesChannelsPatchCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*SitesChannelsPatchCall)Doadded inv0.32.0

Do executes the "firebasehosting.sites.channels.patch" call.Any non-2xx status code is an error. Response headers are in either*Channel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsPatchCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesChannelsPatchCall)Headeradded inv0.32.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesChannelsPatchCall)UpdateMaskadded inv0.32.0

func (c *SitesChannelsPatchCall) UpdateMask(updateMaskstring) *SitesChannelsPatchCall

UpdateMask sets the optional parameter "updateMask": A comma-separated listof fields to be updated in this request.

typeSitesChannelsReleasesCreateCalladded inv0.21.0

type SitesChannelsReleasesCreateCall struct {// contains filtered or unexported fields}

func (*SitesChannelsReleasesCreateCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*SitesChannelsReleasesCreateCall)Doadded inv0.21.0

Do executes the "firebasehosting.sites.channels.releases.create" call.Any non-2xx status code is an error. Response headers are in either*Release.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsReleasesCreateCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesChannelsReleasesCreateCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesChannelsReleasesCreateCall)VersionNameadded inv0.21.0

VersionName sets the optional parameter "versionName": The unique identifierfor a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_IDin this version identifier must match the SITE_ID in the `parent` parameter.This query parameter must be empty if the `type` field in the request bodyis `SITE_DISABLE`.

typeSitesChannelsReleasesGetCalladded inv0.110.0

type SitesChannelsReleasesGetCall struct {// contains filtered or unexported fields}

func (*SitesChannelsReleasesGetCall)Contextadded inv0.110.0

Context sets the context to be used in this call's Do method.

func (*SitesChannelsReleasesGetCall)Doadded inv0.110.0

Do executes the "firebasehosting.sites.channels.releases.get" call.Any non-2xx status code is an error. Response headers are in either*Release.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsReleasesGetCall)Fieldsadded inv0.110.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesChannelsReleasesGetCall)Headeradded inv0.110.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesChannelsReleasesGetCall)IfNoneMatchadded inv0.110.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeSitesChannelsReleasesListCalladded inv0.21.0

type SitesChannelsReleasesListCall struct {// contains filtered or unexported fields}

func (*SitesChannelsReleasesListCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*SitesChannelsReleasesListCall)Doadded inv0.21.0

Do executes the "firebasehosting.sites.channels.releases.list" call.Any non-2xx status code is an error. Response headers are in either*ListReleasesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*SitesChannelsReleasesListCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesChannelsReleasesListCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesChannelsReleasesListCall)IfNoneMatchadded inv0.21.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*SitesChannelsReleasesListCall)PageSizeadded inv0.21.0

PageSize sets the optional parameter "pageSize": The maximum number ofreleases to return. The service may return a lower number if fewer releasesexist than this maximum number. If unspecified, defaults to 100.

func (*SitesChannelsReleasesListCall)PageTokenadded inv0.21.0

PageToken sets the optional parameter "pageToken": A token from a previouscall to `releases.list` or `channels.releases.list` that tells the serverwhere to resume listing.

func (*SitesChannelsReleasesListCall)Pagesadded inv0.21.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeSitesChannelsReleasesServiceadded inv0.21.0

type SitesChannelsReleasesService struct {// contains filtered or unexported fields}

funcNewSitesChannelsReleasesServiceadded inv0.21.0

func NewSitesChannelsReleasesService(s *Service) *SitesChannelsReleasesService

func (*SitesChannelsReleasesService)Createadded inv0.21.0

Create: Creates a new release, which makes the content of the specifiedversion actively display on the appropriate URL(s).

  • parent: The site or channel to which the release belongs, in either of thefollowing formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID.

func (*SitesChannelsReleasesService)Getadded inv0.110.0

Get: Gets the specified release for a site or channel. When used to get arelease for a site, this can get releases for both the default `live`channel and any active preview channels for the specified site.

  • name: The fully-qualified resource name for the Hosting release, in eitherof the following formats: -sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID -sites/SITE_ID/releases/RELEASE_ID.

func (*SitesChannelsReleasesService)Listadded inv0.21.0

List: Lists the releases that have been created for the specified site orchannel. When used to list releases for a site, this list includes releasesfor both the default `live` channel and any active preview channels for thespecified site.

  • parent: The site or channel for which to list releases, in either of thefollowing formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID.

typeSitesChannelsServiceadded inv0.21.0

type SitesChannelsService struct {Releases *SitesChannelsReleasesService// contains filtered or unexported fields}

funcNewSitesChannelsServiceadded inv0.21.0

func NewSitesChannelsService(s *Service) *SitesChannelsService

func (*SitesChannelsService)Createadded inv0.32.0

func (r *SitesChannelsService) Create(parentstring, channel *Channel) *SitesChannelsCreateCall

Create: Creates a new channel in the specified site.

  • parent: The site in which to create this channel, in the format: sites/SITE_ID.

func (*SitesChannelsService)Deleteadded inv0.32.0

Delete: Deletes the specified channel of the specified site. The `live`channel cannot be deleted.

  • name: The fully-qualified resource name for the channel, in the format:sites/SITE_ID/channels/CHANNEL_ID.

func (*SitesChannelsService)Getadded inv0.32.0

Get: Retrieves information for the specified channel of the specified site.

  • name: The fully-qualified resource name for the channel, in the format:sites/SITE_ID/channels/CHANNEL_ID.

func (*SitesChannelsService)Listadded inv0.32.0

List: Lists the channels for the specified site. All sites have a default`live` channel.

- parent: The site for which to list channels, in the format: sites/SITE_ID.

func (*SitesChannelsService)Patchadded inv0.32.0

Patch: Updates information for the specified channel of the specified site.Implicitly creates the channel if it doesn't already exist.

  • name: The fully-qualified resource name for the channel, in the format:sites/ SITE_ID/channels/CHANNEL_ID.

typeSitesDomainsCreateCall

type SitesDomainsCreateCall struct {// contains filtered or unexported fields}

func (*SitesDomainsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesDomainsCreateCall)Do

Do executes the "firebasehosting.sites.domains.create" call.Any non-2xx status code is an error. Response headers are in either*Domain.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesDomainsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesDomainsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSitesDomainsDeleteCall

type SitesDomainsDeleteCall struct {// contains filtered or unexported fields}

func (*SitesDomainsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesDomainsDeleteCall)Do

Do executes the "firebasehosting.sites.domains.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesDomainsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesDomainsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSitesDomainsGetCall

type SitesDomainsGetCall struct {// contains filtered or unexported fields}

func (*SitesDomainsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesDomainsGetCall)Do

Do executes the "firebasehosting.sites.domains.get" call.Any non-2xx status code is an error. Response headers are in either*Domain.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesDomainsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesDomainsGetCall)Header

func (c *SitesDomainsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesDomainsGetCall)IfNoneMatch

func (c *SitesDomainsGetCall) IfNoneMatch(entityTagstring) *SitesDomainsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeSitesDomainsListCall

type SitesDomainsListCall struct {// contains filtered or unexported fields}

func (*SitesDomainsListCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesDomainsListCall)Do

Do executes the "firebasehosting.sites.domains.list" call.Any non-2xx status code is an error. Response headers are in either*ListDomainsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*SitesDomainsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesDomainsListCall)Header

func (c *SitesDomainsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesDomainsListCall)IfNoneMatch

func (c *SitesDomainsListCall) IfNoneMatch(entityTagstring) *SitesDomainsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*SitesDomainsListCall)PageSize

func (c *SitesDomainsListCall) PageSize(pageSizeint64) *SitesDomainsListCall

PageSize sets the optional parameter "pageSize": The page size to return.Defaults to 50.

func (*SitesDomainsListCall)PageToken

func (c *SitesDomainsListCall) PageToken(pageTokenstring) *SitesDomainsListCall

PageToken sets the optional parameter "pageToken": The next_page_token froma previous request, if provided.

func (*SitesDomainsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeSitesDomainsService

type SitesDomainsService struct {// contains filtered or unexported fields}

funcNewSitesDomainsService

func NewSitesDomainsService(s *Service) *SitesDomainsService

func (*SitesDomainsService)Create

func (r *SitesDomainsService) Create(parentstring, domain *Domain) *SitesDomainsCreateCall

Create: Creates a domain mapping on the specified site.

  • parent: The parent to create the domain association for, in the format:sites/site-name.

func (*SitesDomainsService)Delete

Delete: Deletes the existing domain mapping on the specified site.

- name: The name of the domain association to delete.

func (*SitesDomainsService)Get

Get: Gets a domain mapping on the specified site.

- name: The name of the domain configuration to get.

func (*SitesDomainsService)List

List: Lists the domains for the specified site.

  • parent: The parent for which to list domains, in the format: sites/site-name.

func (*SitesDomainsService)Update

Update: Updates the specified domain mapping, creating the mapping as if itdoes not exist.

  • name: The name of the domain association to update or create, if anassociation doesn't already exist.

typeSitesDomainsUpdateCall

type SitesDomainsUpdateCall struct {// contains filtered or unexported fields}

func (*SitesDomainsUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesDomainsUpdateCall)Do

Do executes the "firebasehosting.sites.domains.update" call.Any non-2xx status code is an error. Response headers are in either*Domain.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesDomainsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesDomainsUpdateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSitesGetConfigCall

type SitesGetConfigCall struct {// contains filtered or unexported fields}

func (*SitesGetConfigCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesGetConfigCall)Do

Do executes the "firebasehosting.sites.getConfig" call.Any non-2xx status code is an error. Response headers are in either*SiteConfig.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesGetConfigCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesGetConfigCall)Header

func (c *SitesGetConfigCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesGetConfigCall)IfNoneMatch

func (c *SitesGetConfigCall) IfNoneMatch(entityTagstring) *SitesGetConfigCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeSitesReleasesCreateCall

type SitesReleasesCreateCall struct {// contains filtered or unexported fields}

func (*SitesReleasesCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesReleasesCreateCall)Do

Do executes the "firebasehosting.sites.releases.create" call.Any non-2xx status code is an error. Response headers are in either*Release.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesReleasesCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesReleasesCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesReleasesCreateCall)VersionName

func (c *SitesReleasesCreateCall) VersionName(versionNamestring) *SitesReleasesCreateCall

VersionName sets the optional parameter "versionName": The unique identifierfor a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_IDin this version identifier must match the SITE_ID in the `parent` parameter.This query parameter must be empty if the `type` field in the request bodyis `SITE_DISABLE`.

typeSitesReleasesGetCalladded inv0.110.0

type SitesReleasesGetCall struct {// contains filtered or unexported fields}

func (*SitesReleasesGetCall)Contextadded inv0.110.0

Context sets the context to be used in this call's Do method.

func (*SitesReleasesGetCall)Doadded inv0.110.0

Do executes the "firebasehosting.sites.releases.get" call.Any non-2xx status code is an error. Response headers are in either*Release.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesReleasesGetCall)Fieldsadded inv0.110.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesReleasesGetCall)Headeradded inv0.110.0

func (c *SitesReleasesGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesReleasesGetCall)IfNoneMatchadded inv0.110.0

func (c *SitesReleasesGetCall) IfNoneMatch(entityTagstring) *SitesReleasesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeSitesReleasesListCall

type SitesReleasesListCall struct {// contains filtered or unexported fields}

func (*SitesReleasesListCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesReleasesListCall)Do

Do executes the "firebasehosting.sites.releases.list" call.Any non-2xx status code is an error. Response headers are in either*ListReleasesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*SitesReleasesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesReleasesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesReleasesListCall)IfNoneMatch

func (c *SitesReleasesListCall) IfNoneMatch(entityTagstring) *SitesReleasesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*SitesReleasesListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofreleases to return. The service may return a lower number if fewer releasesexist than this maximum number. If unspecified, defaults to 100.

func (*SitesReleasesListCall)PageToken

func (c *SitesReleasesListCall) PageToken(pageTokenstring) *SitesReleasesListCall

PageToken sets the optional parameter "pageToken": A token from a previouscall to `releases.list` or `channels.releases.list` that tells the serverwhere to resume listing.

func (*SitesReleasesListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeSitesReleasesService

type SitesReleasesService struct {// contains filtered or unexported fields}

funcNewSitesReleasesService

func NewSitesReleasesService(s *Service) *SitesReleasesService

func (*SitesReleasesService)Create

func (r *SitesReleasesService) Create(parentstring, release *Release) *SitesReleasesCreateCall

Create: Creates a new release, which makes the content of the specifiedversion actively display on the appropriate URL(s).

  • parent: The site or channel to which the release belongs, in either of thefollowing formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID.

func (*SitesReleasesService)Getadded inv0.110.0

Get: Gets the specified release for a site or channel. When used to get arelease for a site, this can get releases for both the default `live`channel and any active preview channels for the specified site.

  • name: The fully-qualified resource name for the Hosting release, in eitherof the following formats: -sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID -sites/SITE_ID/releases/RELEASE_ID.

func (*SitesReleasesService)List

List: Lists the releases that have been created for the specified site orchannel. When used to list releases for a site, this list includes releasesfor both the default `live` channel and any active preview channels for thespecified site.

  • parent: The site or channel for which to list releases, in either of thefollowing formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID.

typeSitesService

type SitesService struct {Channels *SitesChannelsServiceDomains *SitesDomainsServiceReleases *SitesReleasesServiceVersions *SitesVersionsService// contains filtered or unexported fields}

funcNewSitesService

func NewSitesService(s *Service) *SitesService

func (*SitesService)GetConfig

func (r *SitesService) GetConfig(namestring) *SitesGetConfigCall

GetConfig: Gets the Hosting metadata for a specific site.

  • name: The site for which to get the SiteConfig, in the format: sites/site-name/config.

func (*SitesService)UpdateConfig

func (r *SitesService) UpdateConfig(namestring, siteconfig *SiteConfig) *SitesUpdateConfigCall

UpdateConfig: Sets the Hosting metadata for a specific site.

  • name: The site for which to update the SiteConfig, in the format: sites/site-name/config.

typeSitesUpdateConfigCall

type SitesUpdateConfigCall struct {// contains filtered or unexported fields}

func (*SitesUpdateConfigCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesUpdateConfigCall)Do

Do executes the "firebasehosting.sites.updateConfig" call.Any non-2xx status code is an error. Response headers are in either*SiteConfig.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesUpdateConfigCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesUpdateConfigCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesUpdateConfigCall)UpdateMask

func (c *SitesUpdateConfigCall) UpdateMask(updateMaskstring) *SitesUpdateConfigCall

UpdateMask sets the optional parameter "updateMask": A set of field namesfrom your site configuration (../sites.SiteConfig) that you want to update.A field will be overwritten if, and only if, it's in the mask. If a mask isnot provided then a default mask of only `max_versions`(../sites.SiteConfig.max_versions) will be used.

typeSitesVersionsCloneCalladded inv0.16.0

type SitesVersionsCloneCall struct {// contains filtered or unexported fields}

func (*SitesVersionsCloneCall)Contextadded inv0.16.0

Context sets the context to be used in this call's Do method.

func (*SitesVersionsCloneCall)Doadded inv0.16.0

Do executes the "firebasehosting.sites.versions.clone" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsCloneCall)Fieldsadded inv0.16.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesVersionsCloneCall)Headeradded inv0.16.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSitesVersionsCreateCall

type SitesVersionsCreateCall struct {// contains filtered or unexported fields}

func (*SitesVersionsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesVersionsCreateCall)Do

Do executes the "firebasehosting.sites.versions.create" call.Any non-2xx status code is an error. Response headers are in either*Version.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesVersionsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesVersionsCreateCall)SizeBytes

SizeBytes sets the optional parameter "sizeBytes": The self-reported size ofthe version. This value is used for a pre-emptive quota check for legacyversion uploads.

func (*SitesVersionsCreateCall)VersionId

VersionId sets the optional parameter "versionId": A unique id for the newversion. This is was only specified for legacy version creations, and shouldbe blank.

typeSitesVersionsDeleteCall

type SitesVersionsDeleteCall struct {// contains filtered or unexported fields}

func (*SitesVersionsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesVersionsDeleteCall)Do

Do executes the "firebasehosting.sites.versions.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesVersionsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSitesVersionsFilesListCall

type SitesVersionsFilesListCall struct {// contains filtered or unexported fields}

func (*SitesVersionsFilesListCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesVersionsFilesListCall)Do

Do executes the "firebasehosting.sites.versions.files.list" call.Any non-2xx status code is an error. Response headers are in either*ListVersionFilesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*SitesVersionsFilesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesVersionsFilesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesVersionsFilesListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*SitesVersionsFilesListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofversion files to return. The service may return a lower number if fewerversion files exist than this maximum number. If unspecified, defaults to1000.

func (*SitesVersionsFilesListCall)PageToken

PageToken sets the optional parameter "pageToken": A token from a previouscall to `ListVersionFiles` that tells the server where to resume listing.

func (*SitesVersionsFilesListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*SitesVersionsFilesListCall)Status

Status sets the optional parameter "status": The type of files that shouldbe listed for the specified version.

Possible values:

"STATUS_UNSPECIFIED" - The default status; should not be intentionally

used.

"EXPECTED" - The file has been included in the version and is expected to

be uploaded in the near future.

"ACTIVE" - The file has already been uploaded to Firebase Hosting.

typeSitesVersionsFilesService

type SitesVersionsFilesService struct {// contains filtered or unexported fields}

funcNewSitesVersionsFilesService

func NewSitesVersionsFilesService(s *Service) *SitesVersionsFilesService

func (*SitesVersionsFilesService)List

List: Lists the remaining files to be uploaded for the specified version.

  • parent: The version for which to list files, in the format: sites/SITE_ID/versions/VERSION_ID.

typeSitesVersionsGetCalladded inv0.110.0

type SitesVersionsGetCall struct {// contains filtered or unexported fields}

func (*SitesVersionsGetCall)Contextadded inv0.110.0

Context sets the context to be used in this call's Do method.

func (*SitesVersionsGetCall)Doadded inv0.110.0

Do executes the "firebasehosting.sites.versions.get" call.Any non-2xx status code is an error. Response headers are in either*Version.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsGetCall)Fieldsadded inv0.110.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesVersionsGetCall)Headeradded inv0.110.0

func (c *SitesVersionsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesVersionsGetCall)IfNoneMatchadded inv0.110.0

func (c *SitesVersionsGetCall) IfNoneMatch(entityTagstring) *SitesVersionsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeSitesVersionsListCalladded inv0.14.0

type SitesVersionsListCall struct {// contains filtered or unexported fields}

func (*SitesVersionsListCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*SitesVersionsListCall)Doadded inv0.14.0

Do executes the "firebasehosting.sites.versions.list" call.Any non-2xx status code is an error. Response headers are in either*ListVersionsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*SitesVersionsListCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesVersionsListCall)Filteradded inv0.15.0

Filter sets the optional parameter "filter": A filter string used to returna subset of versions in the response. The currently supported fields forfiltering are: `name`, `status`, and `create_time`. Learn more aboutfiltering in Google's AIP 160 standard (https://google.aip.dev/160).

func (*SitesVersionsListCall)Headeradded inv0.14.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesVersionsListCall)IfNoneMatchadded inv0.14.0

func (c *SitesVersionsListCall) IfNoneMatch(entityTagstring) *SitesVersionsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*SitesVersionsListCall)PageSizeadded inv0.14.0

PageSize sets the optional parameter "pageSize": The maximum number ofversions to return. The service may return a lower number if fewer versionsexist than this maximum number. If unspecified, defaults to 25. The maximumvalue is 100; values above 100 will be coerced to 100.

func (*SitesVersionsListCall)PageTokenadded inv0.14.0

func (c *SitesVersionsListCall) PageToken(pageTokenstring) *SitesVersionsListCall

PageToken sets the optional parameter "pageToken": A token from a previouscall to `ListVersions` that tells the server where to resume listing.

func (*SitesVersionsListCall)Pagesadded inv0.14.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeSitesVersionsPatchCall

type SitesVersionsPatchCall struct {// contains filtered or unexported fields}

func (*SitesVersionsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesVersionsPatchCall)Do

Do executes the "firebasehosting.sites.versions.patch" call.Any non-2xx status code is an error. Response headers are in either*Version.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesVersionsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SitesVersionsPatchCall)UpdateMask

func (c *SitesVersionsPatchCall) UpdateMask(updateMaskstring) *SitesVersionsPatchCall

UpdateMask sets the optional parameter "updateMask": A set of field namesfrom your version (../sites.versions) that you want to update. A field willbe overwritten if, and only if, it's in the mask. If a mask is not providedthen a default mask of only `status`(../sites.versions#Version.FIELDS.status) will be used.

typeSitesVersionsPopulateFilesCall

type SitesVersionsPopulateFilesCall struct {// contains filtered or unexported fields}

func (*SitesVersionsPopulateFilesCall)Context

Context sets the context to be used in this call's Do method.

func (*SitesVersionsPopulateFilesCall)Do

Do executes the "firebasehosting.sites.versions.populateFiles" call.Any non-2xx status code is an error. Response headers are in either*PopulateVersionFilesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*SitesVersionsPopulateFilesCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SitesVersionsPopulateFilesCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSitesVersionsService

type SitesVersionsService struct {Files *SitesVersionsFilesService// contains filtered or unexported fields}

funcNewSitesVersionsService

func NewSitesVersionsService(s *Service) *SitesVersionsService

func (*SitesVersionsService)Cloneadded inv0.16.0

func (r *SitesVersionsService) Clone(parentstring, cloneversionrequest *CloneVersionRequest) *SitesVersionsCloneCall

Clone: Creates a new version on the specified target site using the contentof the specified version.

  • parent: The target site for the cloned version, in the format: sites/SITE_ID.

func (*SitesVersionsService)Create

func (r *SitesVersionsService) Create(parentstring, version *Version) *SitesVersionsCreateCall

Create: Creates a new version for the specified site.

  • parent: The site in which to create the version, in the format: sites/SITE_ID.

func (*SitesVersionsService)Delete

Delete: Deletes the specified version.

  • name: The fully-qualified resource name for the version, in the format:sites/SITE_ID/versions/VERSION_ID.

func (*SitesVersionsService)Getadded inv0.110.0

Get: Get the specified version that has been created for the specified site.This can include versions that were created for the default `live` channelor for any active preview channels for the specified site.

  • name: The fully-qualified resource name for the version, in the format:sites/SITE_ID/versions/VERSION_ID.

func (*SitesVersionsService)Listadded inv0.14.0

List: Lists the versions that have been created for the specified site. Thislist includes versions for both the default `live` channel and any activepreview channels for the specified site.

  • parent: The site or channel for which to list versions, in either of thefollowing formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID.

func (*SitesVersionsService)Patch

Patch: Updates the specified metadata for the specified version. Thismethod will fail with `FAILED_PRECONDITION` in the event of an invalid statetransition. The supported state (../sites.versions#versionstatus)transitions for a version are from `CREATED` to `FINALIZED`. Use`DeleteVersion` (delete) to set the status of a version to `DELETED`.

  • name: The fully-qualified resource name for the version, in the format:sites/ SITE_ID/versions/VERSION_ID This name is provided in the responsebody when you call `CreateVersion` (sites.versions/create).

func (*SitesVersionsService)PopulateFiles

func (r *SitesVersionsService) PopulateFiles(parentstring, populateversionfilesrequest *PopulateVersionFilesRequest) *SitesVersionsPopulateFilesCall

PopulateFiles: Adds content files to the specified version. Each file mustbe under 2 GB.

  • parent: The version to which to add files, in the format: sites/SITE_ID/versions/VERSION_ID.

typeStatusadded inv0.16.0

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in English. Any// user-facing error message should be localized and sent in the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Status: The `Status` type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).

func (Status)MarshalJSONadded inv0.16.0

func (sStatus) MarshalJSON() ([]byte,error)

typeUndeleteCustomDomainRequestadded inv0.141.0

type UndeleteCustomDomainRequest struct {// Etag: A tag that represents the state of the `CustomDomain` as you know it.// If present, the supplied tag must match the current value on your// `CustomDomain`, or the request fails.Etagstring `json:"etag,omitempty"`// ValidateOnly: If true, Hosting validates that it's possible to complete your// request but doesn't actually delete the `CustomDomain`.ValidateOnlybool `json:"validateOnly,omitempty"`// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

UndeleteCustomDomainRequest: The request sent to `UndeleteCustomDomain`.

func (UndeleteCustomDomainRequest)MarshalJSONadded inv0.141.0

func (sUndeleteCustomDomainRequest) MarshalJSON() ([]byte,error)

typeVersion

type Version struct {// Config: The configuration for the behavior of the site. This configuration// exists in the `firebase.json`// (https://firebase.google.com/docs/cli/#the_firebasejson_file) file.Config *ServingConfig `json:"config,omitempty"`// CreateTime: Output only. The time at which the version was created.CreateTimestring `json:"createTime,omitempty"`// CreateUser: Output only. Identifies the user who created the version.CreateUser *ActingUser `json:"createUser,omitempty"`// DeleteTime: Output only. The time at which the version was `DELETED`.DeleteTimestring `json:"deleteTime,omitempty"`// DeleteUser: Output only. Identifies the user who `DELETED` the version.DeleteUser *ActingUser `json:"deleteUser,omitempty"`// FileCount: Output only. The total number of files associated with the// version. This value is calculated after a version is `FINALIZED`.FileCountint64 `json:"fileCount,omitempty,string"`// FinalizeTime: Output only. The time at which the version was `FINALIZED`.FinalizeTimestring `json:"finalizeTime,omitempty"`// FinalizeUser: Output only. Identifies the user who `FINALIZED` the version.FinalizeUser *ActingUser `json:"finalizeUser,omitempty"`// Labels: The labels used for extra metadata and/or filtering.Labels map[string]string `json:"labels,omitempty"`// Name: 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).Namestring `json:"name,omitempty"`// Status: 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).//// Possible values://   "VERSION_STATUS_UNSPECIFIED" - The default status; should not be// intentionally used.//   "CREATED" - The version has been created, and content is currently being// added to the version.//   "FINALIZED" - All content has been added to the version, and the version// can no longer be changed.//   "DELETED" - The version has been deleted.//   "ABANDONED" - The version was not updated to `FINALIZED` within 12 hours// and was automatically deleted.//   "EXPIRED" - The version is outside the site-configured limit for the// number of retained versions, so the version's content is scheduled for// deletion.//   "CLONING" - The version is being cloned from another version. All content// is still being copied over.Statusstring `json:"status,omitempty"`// VersionBytes: Output only. The total stored bytesize of the version. This// value is calculated after a version is `FINALIZED`.VersionBytesint64 `json:"versionBytes,omitempty,string"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Config") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Config") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Version: A `Version` is a configuration and a collection of static fileswhich determine how a site is displayed.

func (Version)MarshalJSON

func (sVersion) MarshalJSON() ([]byte,error)

typeVersionFile

type VersionFile struct {// Hash: The SHA256 content hash of the file.Hashstring `json:"hash,omitempty"`// Path: The URI at which the file's content should display.Pathstring `json:"path,omitempty"`// Status: Output only. The current status of a particular file in the// specified version. The value will be either `pending upload` or `uploaded`.//// Possible values://   "STATUS_UNSPECIFIED" - The default status; should not be intentionally// used.//   "EXPECTED" - The file has been included in the version and is expected to// be uploaded in the near future.//   "ACTIVE" - The file has already been uploaded to Firebase Hosting.Statusstring `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "Hash") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Hash") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

VersionFile: A static content file that is part of a version.

func (VersionFile)MarshalJSON

func (sVersionFile) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp