firebasehosting

package
v0.177.0 Latest Latest
Warning

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

Go to latest
Published: Apr 30, 2024 License: BSD-3-Clause Imports: 16 Imported by: 4

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, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any 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 for authentication. For information on how to create and obtain Application Default Credentials, see https://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, use google.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 API keys), use google.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 OAuth flow, use google.golang.org/api/option.WithTokenSource:

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

See google.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 Account
	CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"

	// View and administer all your Firebase data and settings
	FirebaseScope = "https://www.googleapis.com/auth/firebase"

	// View all your Firebase data and settings
	FirebaseReadonlyScope = "https://www.googleapis.com/auth/firebase.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActingUser

type ActingUser struct {
	// Email: The email address of the user when the user performed the action.
	Email string `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.
	ImageUrl string `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, such as creating a release or finalizing a version.

func (*ActingUser) MarshalJSON

func (s *ActingUser) MarshalJSON() ([]byte, error)

type CertDnsChallenge

type CertDnsChallenge struct {
	// DomainName: The domain name upon which the DNS challenge must be satisfied.
	DomainName string `json:"domainName,omitempty"`
	// Token: The value that must be present as a TXT record on the domain name to
	// satisfy the challenge.
	Token string `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 (s *CertDnsChallenge) MarshalJSON() ([]byte, error)

type CertHttpChallenge

type CertHttpChallenge struct {
	// Path: The URL path on which to serve the specified token to satisfy the
	// certificate challenge.
	Path string `json:"path,omitempty"`
	// Token: The token to serve at the specified URL path to satisfy the
	// certificate challenge.
	Token string `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 (s *CertHttpChallenge) MarshalJSON() ([]byte, error)

type CertVerification added in v0.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 to create an SSL certificate for your domain name before directing traffic to Hosting servers. Use either the DNS or HTTP challenge; it's not necessary to provide both.

func (*CertVerification) MarshalJSON added in v0.141.0

func (s *CertVerification) MarshalJSON() ([]byte, error)

type Certificate added in v0.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.
	CreateTime string `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.
	ExpireTime string `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.
	State string `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.
	Type string `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 for requests against your domain name. A `Certificate` can be an actual SSL certificate or, for newly-created custom domains, Hosting's intent to create one.

func (*Certificate) MarshalJSON added in v0.141.0

func (s *Certificate) MarshalJSON() ([]byte, error)

type Channel added in v0.32.0

type Channel struct {
	// CreateTime: Output only. The time at which the channel was created.
	CreateTime string `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.
	ExpireTime string `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_ID
	Name string `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.
	RetainedReleaseCount int64 `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.
	Ttl string `json:"ttl,omitempty"`
	// UpdateTime: Output only. The time at which the channel was last updated.
	UpdateTime string `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.
	Url string `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 sites have a default `live` channel that serves content to the Firebase-provided subdomains and any connected custom domains.

func (*Channel) MarshalJSON added in v0.32.0

func (s *Channel) MarshalJSON() ([]byte, error)

type CloneVersionRequest added in v0.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`.
	Finalize bool `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_ID
	SourceVersion string `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) MarshalJSON added in v0.16.0

func (s *CloneVersionRequest) MarshalJSON() ([]byte, error)

type CloudRunRewrite added in v0.2.0

type CloudRunRewrite struct {
	// Region: Optional. User-provided region where the Cloud Run service is
	// hosted. Defaults to `us-central1` if not supplied.
	Region string `json:"region,omitempty"`
	// ServiceId: Required. User-defined ID of the Cloud Run service.
	ServiceId string `json:"serviceId,omitempty"`
	// Tag: Optional. User-provided TrafficConfig tag to send traffic to. When
	// omitted, traffic is sent to the service-wide URI
	Tag string `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 Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error).

func (*CloudRunRewrite) MarshalJSON added in v0.2.0

func (s *CloudRunRewrite) MarshalJSON() ([]byte, error)

type CustomDomain added in v0.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.
	CertPreference string `json:"certPreference,omitempty"`
	// CreateTime: Output only. The custom domain's create time.
	CreateTime string `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.
	DeleteTime string `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.
	Etag string `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.
	ExpireTime string `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.
	HostState string `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`.
	Name string `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.
	OwnershipState string `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.
	Reconciling bool `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.
	RedirectTarget string `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.
	UpdateTime string `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 a Firebase Hosting site. Add a `CustomDomain` to your site to allow Hosting to serve the site's content in response to requests against your domain name.

func (*CustomDomain) MarshalJSON added in v0.141.0

func (s *CustomDomain) MarshalJSON() ([]byte, error)

type CustomDomainMetadata added in v0.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.
	CertState string `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.
	HostState string `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.
	OwnershipState string `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) MarshalJSON added in v0.141.0

func (s *CustomDomainMetadata) MarshalJSON() ([]byte, error)

type DnsRecord added in v0.141.0

type DnsRecord struct {
	// DomainName: Output only. The domain name the record pertains to, e.g.
	// `foo.bar.com.`.
	DomainName string `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".
	Rdata string `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.
	RequiredAction string `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.
	Type string `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 and services should behave when handling requests for a domain name. For example, when you add `A` records to your domain name's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain name (such as your Hosting site files).

func (*DnsRecord) MarshalJSON added in v0.141.0

func (s *DnsRecord) MarshalJSON() ([]byte, error)

type DnsRecordSet added in v0.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.
	DomainName string `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 of a custom domain in Firebase Hosting.

func (*DnsRecordSet) MarshalJSON added in v0.141.0

func (s *DnsRecordSet) MarshalJSON() ([]byte, error)

type DnsUpdates added in v0.141.0

type DnsUpdates struct {
	// CheckTime: The last time Hosting checked your custom domain's DNS records.
	CheckTime string `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 allow Hosting to serve secure content in response to requests against your domain name. These updates present the current state of your domain name's DNS records when Hosting last queried them, and the desired set of records that Hosting needs to see before your custom domain can be fully active.

func (*DnsUpdates) MarshalJSON added in v0.141.0

func (s *DnsUpdates) MarshalJSON() ([]byte, error)

type Domain

type Domain struct {
	// DomainName: Required. The domain name of the association.
	DomainName string `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.
	Site string `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.
	Status string `json:"status,omitempty"`
	// UpdateTime: Output only. The time at which the domain was last updated.
	UpdateTime string `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 (s *Domain) MarshalJSON() ([]byte, error)

type DomainProvisioning

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.
	CertStatus string `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.
	DnsFetchTime string `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.
	DnsStatus string `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 information for a domain.

func (*DomainProvisioning) MarshalJSON

func (s *DomainProvisioning) MarshalJSON() ([]byte, error)

type DomainRedirect

type DomainRedirect struct {
	// DomainName: Required. The domain name to redirect to.
	DomainName string `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`.
	Type string `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. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration.

func (*DomainRedirect) MarshalJSON

func (s *DomainRedirect) MarshalJSON() ([]byte, error)

type Empty

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 defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

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.
	Glob string `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.
	Regex string `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 a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

func (*Header) MarshalJSON

func (s *Header) MarshalJSON() ([]byte, error)

type HttpUpdate added in v0.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.
	Desired string `json:"desired,omitempty"`
	// Discovered: Output only. Whether Hosting was able to find the required file
	// contents on the specified path during its last check.
	Discovered string `json:"discovered,omitempty"`
	// LastCheckTime: Output only. The last time Hosting systems checked for the
	// file contents.
	LastCheckTime string `json:"lastCheckTime,omitempty"`
	// Path: Output only. The path to the file.
	Path string `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 service that confirms your intent to allow Hosting's Certificate Authorities to create an SSL certificate for your domain.

func (*HttpUpdate) MarshalJSON added in v0.141.0

func (s *HttpUpdate) MarshalJSON() ([]byte, error)

type I18nConfig added in v0.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.
	Root string `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) MarshalJSON added in v0.31.0

func (s *I18nConfig) MarshalJSON() ([]byte, error)

type ListChannelsResponse added in v0.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.
	NextPageToken string `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) MarshalJSON added in v0.32.0

func (s *ListChannelsResponse) MarshalJSON() ([]byte, error)

type ListCustomDomainsResponse added in v0.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.
	NextPageToken string `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) MarshalJSON added in v0.141.0

func (s *ListCustomDomainsResponse) MarshalJSON() ([]byte, error)

type ListDomainsResponse

type ListDomainsResponse struct {
	// Domains: The list of domains, if any exist.
	Domains []*Domain `json:"domains,omitempty"`
	// NextPageToken: The pagination token, if more results exist.
	NextPageToken string `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 (s *ListDomainsResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse added in v0.141.0

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	Operations []*Operation `json:"operations,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) MarshalJSON added in v0.141.0

func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListReleasesResponse

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.
	NextPageToken string `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 (s *ListReleasesResponse) MarshalJSON() ([]byte, error)

type ListSitesResponse added in v0.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.
	NextPageToken string `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) MarshalJSON added in v0.42.0

func (s *ListSitesResponse) MarshalJSON() ([]byte, error)

type ListVersionFilesResponse

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.
	NextPageToken string `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 (s *ListVersionFilesResponse) MarshalJSON() ([]byte, error)

type ListVersionsResponse added in v0.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.
	NextPageToken string `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) MarshalJSON added in v0.14.0

func (s *ListVersionsResponse) MarshalJSON() ([]byte, error)

type LiveMigrationStep added in v0.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.
	State string `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 DNS records that allow Hosting to create an SSL certificate and establish project ownership for your domain name before you direct traffic to Hosting servers. Use these updates to facilitate zero downtime migrations to Hosting from other services. After you've made the recommended updates, check your custom domain's `ownershipState` and `certState`. To avoid downtime, they should be `OWNERSHIP_ACTIVE` and `CERT_ACTIVE`, respectively, before you update your `A` and `AAAA` records.

func (*LiveMigrationStep) MarshalJSON added in v0.141.0

func (s *LiveMigrationStep) MarshalJSON() ([]byte, error)

type Operation added in v0.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.
	Done bool `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.
	Metadata googleapi.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}`.
	Name string `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`.
	Response googleapi.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 the result of a network API call.

func (*Operation) MarshalJSON added in v0.16.0

func (s *Operation) MarshalJSON() ([]byte, error)

type PathFilter added in v0.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) MarshalJSON added in v0.16.0

func (s *PathFilter) MarshalJSON() ([]byte, error)

type PopulateVersionFilesRequest

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 (s *PopulateVersionFilesRequest) MarshalJSON() ([]byte, error)

type PopulateVersionFilesResponse

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.
	UploadUrl string `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 (s *PopulateVersionFilesResponse) MarshalJSON() ([]byte, error)

type ProjectsOperationsGetCall added in v0.16.0

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

func (*ProjectsOperationsGetCall) Context added in v0.16.0

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

func (*ProjectsOperationsGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsOperationsGetCall) Fields added in v0.16.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsOperationsGetCall) Header added in v0.16.0

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

func (*ProjectsOperationsGetCall) IfNoneMatch added in v0.16.0

func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall

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

type ProjectsOperationsService added in v0.16.0

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

func NewProjectsOperationsService added in v0.16.0

func NewProjectsOperationsService(s *Service) *ProjectsOperationsService

func (*ProjectsOperationsService) Get added in v0.16.0

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

- name: The name of the operation resource.

type ProjectsService added in v0.16.0

type ProjectsService struct {
	Operations *ProjectsOperationsService

	Sites *ProjectsSitesService
	// contains filtered or unexported fields
}

func NewProjectsService added in v0.16.0

func NewProjectsService(s *Service) *ProjectsService

type ProjectsSitesChannelsCreateCall added in v0.32.0

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

func (*ProjectsSitesChannelsCreateCall) ChannelId added in v0.32.0

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

func (*ProjectsSitesChannelsCreateCall) Context added in v0.32.0

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

func (*ProjectsSitesChannelsCreateCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsCreateCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesChannelsCreateCall) Header added in v0.32.0

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

type ProjectsSitesChannelsDeleteCall added in v0.32.0

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

func (*ProjectsSitesChannelsDeleteCall) Context added in v0.32.0

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

func (*ProjectsSitesChannelsDeleteCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsDeleteCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesChannelsDeleteCall) Header added in v0.32.0

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

type ProjectsSitesChannelsGetCall added in v0.32.0

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

func (*ProjectsSitesChannelsGetCall) Context added in v0.32.0

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

func (*ProjectsSitesChannelsGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsGetCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesChannelsGetCall) Header added in v0.32.0

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

func (*ProjectsSitesChannelsGetCall) IfNoneMatch added in v0.32.0

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

type ProjectsSitesChannelsListCall added in v0.32.0

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

func (*ProjectsSitesChannelsListCall) Context added in v0.32.0

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

func (*ProjectsSitesChannelsListCall) Do added in v0.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsListCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesChannelsListCall) Header added in v0.32.0

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

func (*ProjectsSitesChannelsListCall) IfNoneMatch added in v0.32.0

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

func (*ProjectsSitesChannelsListCall) PageSize added in v0.32.0

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

func (*ProjectsSitesChannelsListCall) PageToken added in v0.32.0

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

func (*ProjectsSitesChannelsListCall) Pages added in v0.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.

type ProjectsSitesChannelsPatchCall added in v0.32.0

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

func (*ProjectsSitesChannelsPatchCall) Context added in v0.32.0

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

func (*ProjectsSitesChannelsPatchCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsPatchCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesChannelsPatchCall) Header added in v0.32.0

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

func (*ProjectsSitesChannelsPatchCall) UpdateMask added in v0.32.0

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

type ProjectsSitesChannelsReleasesCreateCall added in v0.21.0

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

func (*ProjectsSitesChannelsReleasesCreateCall) Context added in v0.21.0

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

func (*ProjectsSitesChannelsReleasesCreateCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsReleasesCreateCall) Fields added in v0.21.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesChannelsReleasesCreateCall) Header added in v0.21.0

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

func (*ProjectsSitesChannelsReleasesCreateCall) VersionName added in v0.21.0

VersionName sets the optional parameter "versionName": The unique identifier for a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_ID in 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 body is `SITE_DISABLE`.

type ProjectsSitesChannelsReleasesGetCall added in v0.110.0

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

func (*ProjectsSitesChannelsReleasesGetCall) Context added in v0.110.0

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

func (*ProjectsSitesChannelsReleasesGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsReleasesGetCall) Fields added in v0.110.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesChannelsReleasesGetCall) Header added in v0.110.0

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

func (*ProjectsSitesChannelsReleasesGetCall) IfNoneMatch added in v0.110.0

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

type ProjectsSitesChannelsReleasesListCall added in v0.21.0

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

func (*ProjectsSitesChannelsReleasesListCall) Context added in v0.21.0

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

func (*ProjectsSitesChannelsReleasesListCall) Do added in v0.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesChannelsReleasesListCall) Fields added in v0.21.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesChannelsReleasesListCall) Header added in v0.21.0

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

func (*ProjectsSitesChannelsReleasesListCall) IfNoneMatch added in v0.21.0

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

func (*ProjectsSitesChannelsReleasesListCall) PageSize added in v0.21.0

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

func (*ProjectsSitesChannelsReleasesListCall) PageToken added in v0.21.0

PageToken sets the optional parameter "pageToken": A token from a previous call to `releases.list` or `channels.releases.list` that tells the server where to resume listing.

func (*ProjectsSitesChannelsReleasesListCall) Pages added in v0.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.

type ProjectsSitesChannelsReleasesService added in v0.21.0

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

func NewProjectsSitesChannelsReleasesService added in v0.21.0

func NewProjectsSitesChannelsReleasesService(s *Service) *ProjectsSitesChannelsReleasesService

func (*ProjectsSitesChannelsReleasesService) Create added in v0.21.0

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

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

func (*ProjectsSitesChannelsReleasesService) Get added in v0.110.0

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

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

func (*ProjectsSitesChannelsReleasesService) List added in v0.21.0

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

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

type ProjectsSitesChannelsService added in v0.21.0

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

func NewProjectsSitesChannelsService added in v0.21.0

func NewProjectsSitesChannelsService(s *Service) *ProjectsSitesChannelsService

func (*ProjectsSitesChannelsService) Create added in v0.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) Delete added in v0.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) Get added in v0.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) List added in v0.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) Patch added in v0.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.

type ProjectsSitesCreateCall added in v0.42.0

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

func (*ProjectsSitesCreateCall) Context added in v0.42.0

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

func (*ProjectsSitesCreateCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCreateCall) Fields added in v0.42.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesCreateCall) Header added in v0.42.0

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

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

func (*ProjectsSitesCreateCall) SiteId added in v0.42.0

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

func (*ProjectsSitesCreateCall) ValidateOnly added in v0.139.0

func (c *ProjectsSitesCreateCall) ValidateOnly(validateOnly bool) *ProjectsSitesCreateCall

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

type ProjectsSitesCustomDomainsCreateCall added in v0.141.0

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

func (*ProjectsSitesCustomDomainsCreateCall) Context added in v0.141.0

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

func (*ProjectsSitesCustomDomainsCreateCall) CustomDomainId added in v0.141.0

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

func (*ProjectsSitesCustomDomainsCreateCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsCreateCall) Fields added in v0.141.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesCustomDomainsCreateCall) Header added in v0.141.0

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

func (*ProjectsSitesCustomDomainsCreateCall) ValidateOnly added in v0.141.0

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

type ProjectsSitesCustomDomainsDeleteCall added in v0.141.0

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

func (*ProjectsSitesCustomDomainsDeleteCall) AllowMissing added in v0.141.0

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

func (*ProjectsSitesCustomDomainsDeleteCall) Context added in v0.141.0

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

func (*ProjectsSitesCustomDomainsDeleteCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsDeleteCall) Etag added in v0.141.0

Etag sets the optional parameter "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.

func (*ProjectsSitesCustomDomainsDeleteCall) Fields added in v0.141.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesCustomDomainsDeleteCall) Header added in v0.141.0

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

func (*ProjectsSitesCustomDomainsDeleteCall) ValidateOnly added in v0.141.0

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

type ProjectsSitesCustomDomainsGetCall added in v0.141.0

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

func (*ProjectsSitesCustomDomainsGetCall) Context added in v0.141.0

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

func (*ProjectsSitesCustomDomainsGetCall) Do added in v0.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 check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsGetCall) Fields added in v0.141.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesCustomDomainsGetCall) Header added in v0.141.0

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

func (*ProjectsSitesCustomDomainsGetCall) IfNoneMatch added in v0.141.0

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

type ProjectsSitesCustomDomainsListCall added in v0.141.0

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

func (*ProjectsSitesCustomDomainsListCall) Context added in v0.141.0

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

func (*ProjectsSitesCustomDomainsListCall) Do added in v0.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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsListCall) Fields added in v0.141.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesCustomDomainsListCall) Header added in v0.141.0

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

func (*ProjectsSitesCustomDomainsListCall) IfNoneMatch added in v0.141.0

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

func (*ProjectsSitesCustomDomainsListCall) PageSize added in v0.141.0

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

func (*ProjectsSitesCustomDomainsListCall) PageToken added in v0.141.0

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

func (*ProjectsSitesCustomDomainsListCall) Pages added in v0.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) ShowDeleted added in v0.141.0

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

type ProjectsSitesCustomDomainsOperationsGetCall added in v0.141.0

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

func (*ProjectsSitesCustomDomainsOperationsGetCall) Context added in v0.141.0

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

func (*ProjectsSitesCustomDomainsOperationsGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsOperationsGetCall) Fields added in v0.141.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesCustomDomainsOperationsGetCall) Header added in v0.141.0

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

func (*ProjectsSitesCustomDomainsOperationsGetCall) IfNoneMatch added in v0.141.0

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

type ProjectsSitesCustomDomainsOperationsListCall added in v0.141.0

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

func (*ProjectsSitesCustomDomainsOperationsListCall) Context added in v0.141.0

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

func (*ProjectsSitesCustomDomainsOperationsListCall) Do added in v0.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsOperationsListCall) Fields added in v0.141.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesCustomDomainsOperationsListCall) Filter added in v0.141.0

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

func (*ProjectsSitesCustomDomainsOperationsListCall) Header added in v0.141.0

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

func (*ProjectsSitesCustomDomainsOperationsListCall) IfNoneMatch added in v0.141.0

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

func (*ProjectsSitesCustomDomainsOperationsListCall) PageSize added in v0.141.0

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

func (*ProjectsSitesCustomDomainsOperationsListCall) PageToken added in v0.141.0

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

func (*ProjectsSitesCustomDomainsOperationsListCall) Pages added in v0.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.

type ProjectsSitesCustomDomainsOperationsService added in v0.141.0

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

func NewProjectsSitesCustomDomainsOperationsService added in v0.141.0

func NewProjectsSitesCustomDomainsOperationsService(s *Service) *ProjectsSitesCustomDomainsOperationsService

func (*ProjectsSitesCustomDomainsOperationsService) Get added in v0.141.0

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

- name: The name of the operation resource.

func (*ProjectsSitesCustomDomainsOperationsService) List added in v0.141.0

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

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

type ProjectsSitesCustomDomainsPatchCall added in v0.141.0

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

func (*ProjectsSitesCustomDomainsPatchCall) AllowMissing added in v0.141.0

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

func (*ProjectsSitesCustomDomainsPatchCall) Context added in v0.141.0

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

func (*ProjectsSitesCustomDomainsPatchCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsPatchCall) Fields added in v0.141.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesCustomDomainsPatchCall) Header added in v0.141.0

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

func (*ProjectsSitesCustomDomainsPatchCall) UpdateMask added in v0.141.0

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

func (*ProjectsSitesCustomDomainsPatchCall) ValidateOnly added in v0.141.0

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

type ProjectsSitesCustomDomainsService added in v0.141.0

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

func NewProjectsSitesCustomDomainsService added in v0.141.0

func NewProjectsSitesCustomDomainsService(s *Service) *ProjectsSitesCustomDomainsService

func (*ProjectsSitesCustomDomainsService) Create added in v0.141.0

Create: Creates a `CustomDomain`.

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

func (*ProjectsSitesCustomDomainsService) Delete added in v0.141.0

Delete: Deletes the specified `CustomDomain`.

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

func (*ProjectsSitesCustomDomainsService) Get added in v0.141.0

Get: Gets the specified `CustomDomain`.

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

func (*ProjectsSitesCustomDomainsService) List added in v0.141.0

List: Lists each `CustomDomain` associated with the specified parent Hosting site. Returns `CustomDomain`s in a consistent, but undefined, order to facilitate pagination.

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

func (*ProjectsSitesCustomDomainsService) Patch added in v0.141.0

Patch: Updates the specified `CustomDomain`.

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

func (*ProjectsSitesCustomDomainsService) Undelete added in v0.141.0

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

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

type ProjectsSitesCustomDomainsUndeleteCall added in v0.141.0

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

func (*ProjectsSitesCustomDomainsUndeleteCall) Context added in v0.141.0

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

func (*ProjectsSitesCustomDomainsUndeleteCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesCustomDomainsUndeleteCall) Fields added in v0.141.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesCustomDomainsUndeleteCall) Header added in v0.141.0

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

type ProjectsSitesDeleteCall added in v0.42.0

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

func (*ProjectsSitesDeleteCall) Context added in v0.42.0

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

func (*ProjectsSitesDeleteCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDeleteCall) Fields added in v0.42.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesDeleteCall) Header added in v0.42.0

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

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

type ProjectsSitesDomainsCreateCall added in v0.23.0

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

func (*ProjectsSitesDomainsCreateCall) Context added in v0.23.0

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

func (*ProjectsSitesDomainsCreateCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDomainsCreateCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesDomainsCreateCall) Header added in v0.23.0

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

type ProjectsSitesDomainsDeleteCall added in v0.23.0

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

func (*ProjectsSitesDomainsDeleteCall) Context added in v0.23.0

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

func (*ProjectsSitesDomainsDeleteCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDomainsDeleteCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesDomainsDeleteCall) Header added in v0.23.0

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

type ProjectsSitesDomainsGetCall added in v0.23.0

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

func (*ProjectsSitesDomainsGetCall) Context added in v0.23.0

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

func (*ProjectsSitesDomainsGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDomainsGetCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesDomainsGetCall) Header added in v0.23.0

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

func (*ProjectsSitesDomainsGetCall) IfNoneMatch added in v0.23.0

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

type ProjectsSitesDomainsListCall added in v0.23.0

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

func (*ProjectsSitesDomainsListCall) Context added in v0.23.0

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

func (*ProjectsSitesDomainsListCall) Do added in v0.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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDomainsListCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesDomainsListCall) Header added in v0.23.0

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

func (*ProjectsSitesDomainsListCall) IfNoneMatch added in v0.23.0

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

func (*ProjectsSitesDomainsListCall) PageSize added in v0.23.0

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

func (*ProjectsSitesDomainsListCall) PageToken added in v0.23.0

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

func (*ProjectsSitesDomainsListCall) Pages added in v0.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.

type ProjectsSitesDomainsService added in v0.23.0

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

func NewProjectsSitesDomainsService added in v0.23.0

func NewProjectsSitesDomainsService(s *Service) *ProjectsSitesDomainsService

func (*ProjectsSitesDomainsService) Create added in v0.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) Delete added in v0.23.0

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

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

func (*ProjectsSitesDomainsService) Get added in v0.23.0

Get: Gets a domain mapping on the specified site.

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

func (*ProjectsSitesDomainsService) List added in v0.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) Update added in v0.23.0

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

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

type ProjectsSitesDomainsUpdateCall added in v0.23.0

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

func (*ProjectsSitesDomainsUpdateCall) Context added in v0.23.0

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

func (*ProjectsSitesDomainsUpdateCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesDomainsUpdateCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesDomainsUpdateCall) Header added in v0.23.0

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

type ProjectsSitesGetCall added in v0.42.0

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

func (*ProjectsSitesGetCall) Context added in v0.42.0

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

func (*ProjectsSitesGetCall) Do added in v0.42.0

func (c *ProjectsSitesGetCall) Do(opts ...googleapi.CallOption) (*Site, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesGetCall) Fields added in v0.42.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesGetCall) Header added in v0.42.0

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

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

func (*ProjectsSitesGetCall) IfNoneMatch added in v0.42.0

func (c *ProjectsSitesGetCall) IfNoneMatch(entityTag string) *ProjectsSitesGetCall

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

type ProjectsSitesGetConfigCall added in v0.23.0

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

func (*ProjectsSitesGetConfigCall) Context added in v0.23.0

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

func (*ProjectsSitesGetConfigCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesGetConfigCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesGetConfigCall) Header added in v0.23.0

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

func (*ProjectsSitesGetConfigCall) IfNoneMatch added in v0.23.0

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

type ProjectsSitesListCall added in v0.42.0

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

func (*ProjectsSitesListCall) Context added in v0.42.0

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

func (*ProjectsSitesListCall) Do added in v0.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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesListCall) Fields added in v0.42.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesListCall) Header added in v0.42.0

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

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

func (*ProjectsSitesListCall) IfNoneMatch added in v0.42.0

func (c *ProjectsSitesListCall) IfNoneMatch(entityTag string) *ProjectsSitesListCall

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

func (*ProjectsSitesListCall) PageSize added in v0.42.0

func (c *ProjectsSitesListCall) PageSize(pageSize int64) *ProjectsSitesListCall

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

func (*ProjectsSitesListCall) PageToken added in v0.42.0

func (c *ProjectsSitesListCall) PageToken(pageToken string) *ProjectsSitesListCall

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

func (*ProjectsSitesListCall) Pages added in v0.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.

type ProjectsSitesPatchCall added in v0.42.0

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

func (*ProjectsSitesPatchCall) Context added in v0.42.0

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

func (*ProjectsSitesPatchCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesPatchCall) Fields added in v0.42.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesPatchCall) Header added in v0.42.0

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

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

func (*ProjectsSitesPatchCall) UpdateMask added in v0.42.0

func (c *ProjectsSitesPatchCall) UpdateMask(updateMask string) *ProjectsSitesPatchCall

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

type ProjectsSitesReleasesCreateCall added in v0.21.0

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

func (*ProjectsSitesReleasesCreateCall) Context added in v0.21.0

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

func (*ProjectsSitesReleasesCreateCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesReleasesCreateCall) Fields added in v0.21.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesReleasesCreateCall) Header added in v0.21.0

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

func (*ProjectsSitesReleasesCreateCall) VersionName added in v0.21.0

VersionName sets the optional parameter "versionName": The unique identifier for a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_ID in 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 body is `SITE_DISABLE`.

type ProjectsSitesReleasesGetCall added in v0.110.0

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

func (*ProjectsSitesReleasesGetCall) Context added in v0.110.0

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

func (*ProjectsSitesReleasesGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesReleasesGetCall) Fields added in v0.110.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesReleasesGetCall) Header added in v0.110.0

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

func (*ProjectsSitesReleasesGetCall) IfNoneMatch added in v0.110.0

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

type ProjectsSitesReleasesListCall added in v0.21.0

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

func (*ProjectsSitesReleasesListCall) Context added in v0.21.0

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

func (*ProjectsSitesReleasesListCall) Do added in v0.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesReleasesListCall) Fields added in v0.21.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesReleasesListCall) Header added in v0.21.0

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

func (*ProjectsSitesReleasesListCall) IfNoneMatch added in v0.21.0

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

func (*ProjectsSitesReleasesListCall) PageSize added in v0.21.0

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

func (*ProjectsSitesReleasesListCall) PageToken added in v0.21.0

PageToken sets the optional parameter "pageToken": A token from a previous call to `releases.list` or `channels.releases.list` that tells the server where to resume listing.

func (*ProjectsSitesReleasesListCall) Pages added in v0.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.

type ProjectsSitesReleasesService added in v0.21.0

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

func NewProjectsSitesReleasesService added in v0.21.0

func NewProjectsSitesReleasesService(s *Service) *ProjectsSitesReleasesService

func (*ProjectsSitesReleasesService) Create added in v0.21.0

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

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

func (*ProjectsSitesReleasesService) Get added in v0.110.0

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

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

func (*ProjectsSitesReleasesService) List added in v0.21.0

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

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

type ProjectsSitesService added in v0.21.0

type ProjectsSitesService struct {
	Channels *ProjectsSitesChannelsService

	CustomDomains *ProjectsSitesCustomDomainsService

	Domains *ProjectsSitesDomainsService

	Releases *ProjectsSitesReleasesService

	Versions *ProjectsSitesVersionsService
	// contains filtered or unexported fields
}

func NewProjectsSitesService added in v0.21.0

func NewProjectsSitesService(s *Service) *ProjectsSitesService

func (*ProjectsSitesService) Create added in v0.42.0

func (r *ProjectsSitesService) Create(parent string, site *Site) *ProjectsSitesCreateCall

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

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

func (*ProjectsSitesService) Delete added in v0.42.0

Delete: Deletes the specified Hosting Site from the specified parent Firebase project.

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

func (*ProjectsSitesService) Get added in v0.42.0

Get: Gets the specified Hosting Site.

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

func (*ProjectsSitesService) GetConfig added in v0.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) List added in v0.42.0

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

  • 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_IDENTIFIER values.

func (*ProjectsSitesService) Patch added in v0.42.0

func (r *ProjectsSitesService) Patch(nameid string, site *Site) *ProjectsSitesPatchCall

Patch: Updates attributes of the specified Hosting Site.

func (*ProjectsSitesService) UpdateConfig added in v0.23.0

func (r *ProjectsSitesService) UpdateConfig(name string, 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.

type ProjectsSitesUpdateConfigCall added in v0.23.0

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

func (*ProjectsSitesUpdateConfigCall) Context added in v0.23.0

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

func (*ProjectsSitesUpdateConfigCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesUpdateConfigCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesUpdateConfigCall) Header added in v0.23.0

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

func (*ProjectsSitesUpdateConfigCall) UpdateMask added in v0.23.0

UpdateMask sets the optional parameter "updateMask": A set of field names from 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 is not provided then a default mask of only `max_versions` (../sites.SiteConfig.max_versions) will be used.

type ProjectsSitesVersionsCloneCall added in v0.23.0

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

func (*ProjectsSitesVersionsCloneCall) Context added in v0.23.0

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

func (*ProjectsSitesVersionsCloneCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsCloneCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesVersionsCloneCall) Header added in v0.23.0

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

type ProjectsSitesVersionsCreateCall added in v0.23.0

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

func (*ProjectsSitesVersionsCreateCall) Context added in v0.23.0

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

func (*ProjectsSitesVersionsCreateCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsCreateCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesVersionsCreateCall) Header added in v0.23.0

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

func (*ProjectsSitesVersionsCreateCall) SizeBytes added in v0.23.0

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

func (*ProjectsSitesVersionsCreateCall) VersionId added in v0.23.0

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

type ProjectsSitesVersionsDeleteCall added in v0.23.0

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

func (*ProjectsSitesVersionsDeleteCall) Context added in v0.23.0

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

func (*ProjectsSitesVersionsDeleteCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsDeleteCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesVersionsDeleteCall) Header added in v0.23.0

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

type ProjectsSitesVersionsFilesListCall added in v0.23.0

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

func (*ProjectsSitesVersionsFilesListCall) Context added in v0.23.0

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

func (*ProjectsSitesVersionsFilesListCall) Do added in v0.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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsFilesListCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesVersionsFilesListCall) Header added in v0.23.0

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

func (*ProjectsSitesVersionsFilesListCall) IfNoneMatch added in v0.23.0

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

func (*ProjectsSitesVersionsFilesListCall) PageSize added in v0.23.0

PageSize sets the optional parameter "pageSize": The maximum number of version files to return. The service may return a lower number if fewer version files exist than this maximum number. If unspecified, defaults to 1000.

func (*ProjectsSitesVersionsFilesListCall) PageToken added in v0.23.0

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

func (*ProjectsSitesVersionsFilesListCall) Pages added in v0.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) Status added in v0.23.0

Status sets the optional parameter "status": The type of files that should be 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.

type ProjectsSitesVersionsFilesService added in v0.23.0

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

func NewProjectsSitesVersionsFilesService added in v0.23.0

func NewProjectsSitesVersionsFilesService(s *Service) *ProjectsSitesVersionsFilesService

func (*ProjectsSitesVersionsFilesService) List added in v0.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.

type ProjectsSitesVersionsGetCall added in v0.110.0

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

func (*ProjectsSitesVersionsGetCall) Context added in v0.110.0

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

func (*ProjectsSitesVersionsGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsGetCall) Fields added in v0.110.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesVersionsGetCall) Header added in v0.110.0

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

func (*ProjectsSitesVersionsGetCall) IfNoneMatch added in v0.110.0

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

type ProjectsSitesVersionsListCall added in v0.23.0

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

func (*ProjectsSitesVersionsListCall) Context added in v0.23.0

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

func (*ProjectsSitesVersionsListCall) Do added in v0.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsListCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesVersionsListCall) Filter added in v0.23.0

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

func (*ProjectsSitesVersionsListCall) Header added in v0.23.0

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

func (*ProjectsSitesVersionsListCall) IfNoneMatch added in v0.23.0

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

func (*ProjectsSitesVersionsListCall) PageSize added in v0.23.0

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

func (*ProjectsSitesVersionsListCall) PageToken added in v0.23.0

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

func (*ProjectsSitesVersionsListCall) Pages added in v0.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.

type ProjectsSitesVersionsPatchCall added in v0.23.0

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

func (*ProjectsSitesVersionsPatchCall) Context added in v0.23.0

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

func (*ProjectsSitesVersionsPatchCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsPatchCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesVersionsPatchCall) Header added in v0.23.0

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

func (*ProjectsSitesVersionsPatchCall) UpdateMask added in v0.23.0

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

type ProjectsSitesVersionsPopulateFilesCall added in v0.23.0

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

func (*ProjectsSitesVersionsPopulateFilesCall) Context added in v0.23.0

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

func (*ProjectsSitesVersionsPopulateFilesCall) Do added in v0.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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSitesVersionsPopulateFilesCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSitesVersionsPopulateFilesCall) Header added in v0.23.0

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

type ProjectsSitesVersionsService added in v0.23.0

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

func NewProjectsSitesVersionsService added in v0.23.0

func NewProjectsSitesVersionsService(s *Service) *ProjectsSitesVersionsService

func (*ProjectsSitesVersionsService) Clone added in v0.23.0

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

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

func (*ProjectsSitesVersionsService) Create added in v0.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) Delete added in v0.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) Get added in v0.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` channel or 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) List added in v0.23.0

List: Lists the versions that have been created for the specified site. This list includes versions for both the default `live` channel and any active preview channels for the specified site.

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

func (*ProjectsSitesVersionsService) Patch added in v0.23.0

Patch: Updates the specified metadata for the specified version. This method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The supported state (../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 response body when you call `CreateVersion` (sites.versions/create).

func (*ProjectsSitesVersionsService) PopulateFiles added in v0.23.0

func (r *ProjectsSitesVersionsService) PopulateFiles(parent string, populateversionfilesrequest *PopulateVersionFilesRequest) *ProjectsSitesVersionsPopulateFilesCall

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

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

type Redirect

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.
	Glob string `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"
	Location string `json:"location,omitempty"`
	// Regex: The user-supplied RE2 regular expression to match against the request
	// URL path.
	Regex string `json:"regex,omitempty"`
	// StatusCode: Required. The status HTTP code to return in the response. It
	// must be a valid 3xx status code.
	StatusCode int64 `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 a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

func (*Redirect) MarshalJSON

func (s *Redirect) MarshalJSON() ([]byte, error)

type Release

type Release struct {
	// Message: The deploy description when the release was created. The value can
	// be up to 512 characters.
	Message string `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).
	Name string `json:"name,omitempty"`
	// ReleaseTime: Output only. The time at which the version is set to be public.
	ReleaseTime string `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.
	Type string `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 (s *Release) MarshalJSON() ([]byte, error)

type Rewrite

type Rewrite struct {
	// DynamicLinks: The request will be forwarded to Firebase Dynamic Links.
	DynamicLinks bool `json:"dynamicLinks,omitempty"`
	// Function: The function to proxy requests to. Must match the exported
	// function name exactly.
	Function string `json:"function,omitempty"`
	// FunctionRegion: Optional. Specify a Cloud region for rewritten Functions
	// invocations. If not provided, defaults to us-central1.
	FunctionRegion string `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.
	Glob string `json:"glob,omitempty"`
	// Path: The URL path to rewrite the request to.
	Path string `json:"path,omitempty"`
	// Regex: The user-supplied RE2 regular expression to match against the request
	// URL path.
	Regex string `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 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.

func (*Rewrite) MarshalJSON

func (s *Rewrite) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService

	Sites *SitesService
	// contains filtered or unexported fields
}

func New deprecated

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.

func NewService added in v0.3.0

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

NewService creates a new Service.

type ServingConfig

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.
	AppAssociation string `json:"appAssociation,omitempty"`
	// CleanUrls: Defines whether to drop the file extension from uploaded files.
	CleanUrls bool `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.
	TrailingSlashBehavior string `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 should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific priority order (https://firebase.google.com/docs/hosting/full-config#hosting_priority_order).

func (*ServingConfig) MarshalJSON

func (s *ServingConfig) MarshalJSON() ([]byte, error)

type Site added in v0.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.
	AppId string `json:"appId,omitempty"`
	// DefaultUrl: Output only. The default URL for the Hosting site.
	DefaultUrl string `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).
	Name string `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.
	Type string `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) MarshalJSON added in v0.42.0

func (s *Site) MarshalJSON() ([]byte, error)

type SiteConfig

type SiteConfig struct {
	// CloudLoggingEnabled: Whether or not web requests made by site visitors are
	// logged via Cloud Logging.
	CloudLoggingEnabled bool `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.
	MaxVersions int64 `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 site that controls Firebase Hosting serving behavior

func (*SiteConfig) MarshalJSON

func (s *SiteConfig) MarshalJSON() ([]byte, error)

type SitesChannelsCreateCall added in v0.32.0

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

func (*SitesChannelsCreateCall) ChannelId added in v0.32.0

func (c *SitesChannelsCreateCall) ChannelId(channelId string) *SitesChannelsCreateCall

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

func (*SitesChannelsCreateCall) Context added in v0.32.0

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

func (*SitesChannelsCreateCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsCreateCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesChannelsCreateCall) Header added in v0.32.0

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

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

type SitesChannelsDeleteCall added in v0.32.0

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

func (*SitesChannelsDeleteCall) Context added in v0.32.0

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

func (*SitesChannelsDeleteCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsDeleteCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesChannelsDeleteCall) Header added in v0.32.0

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

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

type SitesChannelsGetCall added in v0.32.0

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

func (*SitesChannelsGetCall) Context added in v0.32.0

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

func (*SitesChannelsGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsGetCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesChannelsGetCall) Header added in v0.32.0

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

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

func (*SitesChannelsGetCall) IfNoneMatch added in v0.32.0

func (c *SitesChannelsGetCall) IfNoneMatch(entityTag string) *SitesChannelsGetCall

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

type SitesChannelsListCall added in v0.32.0

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

func (*SitesChannelsListCall) Context added in v0.32.0

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

func (*SitesChannelsListCall) Do added in v0.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsListCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesChannelsListCall) Header added in v0.32.0

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

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

func (*SitesChannelsListCall) IfNoneMatch added in v0.32.0

func (c *SitesChannelsListCall) IfNoneMatch(entityTag string) *SitesChannelsListCall

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

func (*SitesChannelsListCall) PageSize added in v0.32.0

func (c *SitesChannelsListCall) PageSize(pageSize int64) *SitesChannelsListCall

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

func (*SitesChannelsListCall) PageToken added in v0.32.0

func (c *SitesChannelsListCall) PageToken(pageToken string) *SitesChannelsListCall

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

func (*SitesChannelsListCall) Pages added in v0.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.

type SitesChannelsPatchCall added in v0.32.0

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

func (*SitesChannelsPatchCall) Context added in v0.32.0

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

func (*SitesChannelsPatchCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsPatchCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesChannelsPatchCall) Header added in v0.32.0

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

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

func (*SitesChannelsPatchCall) UpdateMask added in v0.32.0

func (c *SitesChannelsPatchCall) UpdateMask(updateMask string) *SitesChannelsPatchCall

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

type SitesChannelsReleasesCreateCall added in v0.21.0

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

func (*SitesChannelsReleasesCreateCall) Context added in v0.21.0

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

func (*SitesChannelsReleasesCreateCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsReleasesCreateCall) Fields added in v0.21.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesChannelsReleasesCreateCall) Header added in v0.21.0

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

func (*SitesChannelsReleasesCreateCall) VersionName added in v0.21.0

VersionName sets the optional parameter "versionName": The unique identifier for a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_ID in 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 body is `SITE_DISABLE`.

type SitesChannelsReleasesGetCall added in v0.110.0

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

func (*SitesChannelsReleasesGetCall) Context added in v0.110.0

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

func (*SitesChannelsReleasesGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsReleasesGetCall) Fields added in v0.110.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesChannelsReleasesGetCall) Header added in v0.110.0

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

func (*SitesChannelsReleasesGetCall) IfNoneMatch added in v0.110.0

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

type SitesChannelsReleasesListCall added in v0.21.0

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

func (*SitesChannelsReleasesListCall) Context added in v0.21.0

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

func (*SitesChannelsReleasesListCall) Do added in v0.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesChannelsReleasesListCall) Fields added in v0.21.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesChannelsReleasesListCall) Header added in v0.21.0

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

func (*SitesChannelsReleasesListCall) IfNoneMatch added in v0.21.0

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

func (*SitesChannelsReleasesListCall) PageSize added in v0.21.0

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

func (*SitesChannelsReleasesListCall) PageToken added in v0.21.0

PageToken sets the optional parameter "pageToken": A token from a previous call to `releases.list` or `channels.releases.list` that tells the server where to resume listing.

func (*SitesChannelsReleasesListCall) Pages added in v0.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.

type SitesChannelsReleasesService added in v0.21.0

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

func NewSitesChannelsReleasesService added in v0.21.0

func NewSitesChannelsReleasesService(s *Service) *SitesChannelsReleasesService

func (*SitesChannelsReleasesService) Create added in v0.21.0

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

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

func (*SitesChannelsReleasesService) Get added in v0.110.0

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

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

func (*SitesChannelsReleasesService) List added in v0.21.0

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

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

type SitesChannelsService added in v0.21.0

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

func NewSitesChannelsService added in v0.21.0

func NewSitesChannelsService(s *Service) *SitesChannelsService

func (*SitesChannelsService) Create added in v0.32.0

func (r *SitesChannelsService) Create(parent string, 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) Delete added in v0.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) Get added in v0.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) List added in v0.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) Patch added in v0.32.0

func (r *SitesChannelsService) Patch(name string, channel *Channel) *SitesChannelsPatchCall

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.

type SitesDomainsCreateCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesDomainsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesDomainsCreateCall) Header

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

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

type SitesDomainsDeleteCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesDomainsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesDomainsDeleteCall) Header

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

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

type SitesDomainsGetCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesDomainsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesDomainsGetCall) Header

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

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

func (*SitesDomainsGetCall) IfNoneMatch

func (c *SitesDomainsGetCall) IfNoneMatch(entityTag string) *SitesDomainsGetCall

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

type SitesDomainsListCall

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesDomainsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesDomainsListCall) Header

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

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

func (*SitesDomainsListCall) IfNoneMatch

func (c *SitesDomainsListCall) IfNoneMatch(entityTag string) *SitesDomainsListCall

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

func (*SitesDomainsListCall) PageSize

func (c *SitesDomainsListCall) PageSize(pageSize int64) *SitesDomainsListCall

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

func (*SitesDomainsListCall) PageToken

func (c *SitesDomainsListCall) PageToken(pageToken string) *SitesDomainsListCall

PageToken sets the optional parameter "pageToken": The next_page_token from a 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.

type SitesDomainsService

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

func NewSitesDomainsService

func NewSitesDomainsService(s *Service) *SitesDomainsService

func (*SitesDomainsService) Create

func (r *SitesDomainsService) Create(parent string, 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

func (r *SitesDomainsService) Update(name string, domain *Domain) *SitesDomainsUpdateCall

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

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

type SitesDomainsUpdateCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesDomainsUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesDomainsUpdateCall) Header

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

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

type SitesGetConfigCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesGetConfigCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesGetConfigCall) Header

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

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

func (*SitesGetConfigCall) IfNoneMatch

func (c *SitesGetConfigCall) IfNoneMatch(entityTag string) *SitesGetConfigCall

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

type SitesReleasesCreateCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesReleasesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesReleasesCreateCall) Header

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

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

func (*SitesReleasesCreateCall) VersionName

func (c *SitesReleasesCreateCall) VersionName(versionName string) *SitesReleasesCreateCall

VersionName sets the optional parameter "versionName": The unique identifier for a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_ID in 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 body is `SITE_DISABLE`.

type SitesReleasesGetCall added in v0.110.0

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

func (*SitesReleasesGetCall) Context added in v0.110.0

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

func (*SitesReleasesGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesReleasesGetCall) Fields added in v0.110.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesReleasesGetCall) Header added in v0.110.0

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

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

func (*SitesReleasesGetCall) IfNoneMatch added in v0.110.0

func (c *SitesReleasesGetCall) IfNoneMatch(entityTag string) *SitesReleasesGetCall

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

type SitesReleasesListCall

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesReleasesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesReleasesListCall) Header

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

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

func (*SitesReleasesListCall) IfNoneMatch

func (c *SitesReleasesListCall) IfNoneMatch(entityTag string) *SitesReleasesListCall

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

func (*SitesReleasesListCall) PageSize

func (c *SitesReleasesListCall) PageSize(pageSize int64) *SitesReleasesListCall

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

func (*SitesReleasesListCall) PageToken

func (c *SitesReleasesListCall) PageToken(pageToken string) *SitesReleasesListCall

PageToken sets the optional parameter "pageToken": A token from a previous call to `releases.list` or `channels.releases.list` that tells the server where 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.

type SitesReleasesService

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

func NewSitesReleasesService

func NewSitesReleasesService(s *Service) *SitesReleasesService

func (*SitesReleasesService) Create

func (r *SitesReleasesService) Create(parent string, release *Release) *SitesReleasesCreateCall

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

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

func (*SitesReleasesService) Get added in v0.110.0

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

  • name: The fully-qualified resource name for the Hosting release, in either of 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 or channel. When used to list releases for a site, this list includes releases for both the default `live` channel and any active preview channels for the specified site.

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

type SitesService

type SitesService struct {
	Channels *SitesChannelsService

	Domains *SitesDomainsService

	Releases *SitesReleasesService

	Versions *SitesVersionsService
	// contains filtered or unexported fields
}

func NewSitesService

func NewSitesService(s *Service) *SitesService

func (*SitesService) GetConfig

func (r *SitesService) GetConfig(name string) *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(name string, 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.

type SitesUpdateConfigCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesUpdateConfigCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesUpdateConfigCall) Header

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

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

func (*SitesUpdateConfigCall) UpdateMask

func (c *SitesUpdateConfigCall) UpdateMask(updateMask string) *SitesUpdateConfigCall

UpdateMask sets the optional parameter "updateMask": A set of field names from 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 is not provided then a default mask of only `max_versions` (../sites.SiteConfig.max_versions) will be used.

type SitesVersionsCloneCall added in v0.16.0

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

func (*SitesVersionsCloneCall) Context added in v0.16.0

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

func (*SitesVersionsCloneCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsCloneCall) Fields added in v0.16.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesVersionsCloneCall) Header added in v0.16.0

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

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

type SitesVersionsCreateCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesVersionsCreateCall) Header

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

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

func (*SitesVersionsCreateCall) SizeBytes

func (c *SitesVersionsCreateCall) SizeBytes(sizeBytes int64) *SitesVersionsCreateCall

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

func (*SitesVersionsCreateCall) VersionId

func (c *SitesVersionsCreateCall) VersionId(versionId string) *SitesVersionsCreateCall

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

type SitesVersionsDeleteCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesVersionsDeleteCall) Header

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

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

type SitesVersionsFilesListCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsFilesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesVersionsFilesListCall) Header

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

func (*SitesVersionsFilesListCall) IfNoneMatch

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

func (*SitesVersionsFilesListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of version files to return. The service may return a lower number if fewer version files exist than this maximum number. If unspecified, defaults to 1000.

func (*SitesVersionsFilesListCall) PageToken

PageToken sets the optional parameter "pageToken": A token from a previous call 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 should be 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.

type SitesVersionsFilesService

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

func NewSitesVersionsFilesService

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.

type SitesVersionsGetCall added in v0.110.0

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

func (*SitesVersionsGetCall) Context added in v0.110.0

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

func (*SitesVersionsGetCall) Do added in v0.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsGetCall) Fields added in v0.110.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesVersionsGetCall) Header added in v0.110.0

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

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

func (*SitesVersionsGetCall) IfNoneMatch added in v0.110.0

func (c *SitesVersionsGetCall) IfNoneMatch(entityTag string) *SitesVersionsGetCall

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

type SitesVersionsListCall added in v0.14.0

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

func (*SitesVersionsListCall) Context added in v0.14.0

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

func (*SitesVersionsListCall) Do added in v0.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsListCall) Fields added in v0.14.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesVersionsListCall) Filter added in v0.15.0

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

func (*SitesVersionsListCall) Header added in v0.14.0

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

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

func (*SitesVersionsListCall) IfNoneMatch added in v0.14.0

func (c *SitesVersionsListCall) IfNoneMatch(entityTag string) *SitesVersionsListCall

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

func (*SitesVersionsListCall) PageSize added in v0.14.0

func (c *SitesVersionsListCall) PageSize(pageSize int64) *SitesVersionsListCall

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

func (*SitesVersionsListCall) PageToken added in v0.14.0

func (c *SitesVersionsListCall) PageToken(pageToken string) *SitesVersionsListCall

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

func (*SitesVersionsListCall) Pages added in v0.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.

type SitesVersionsPatchCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesVersionsPatchCall) Header

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

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

func (*SitesVersionsPatchCall) UpdateMask

func (c *SitesVersionsPatchCall) UpdateMask(updateMask string) *SitesVersionsPatchCall

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

type SitesVersionsPopulateFilesCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SitesVersionsPopulateFilesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SitesVersionsPopulateFilesCall) Header

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

type SitesVersionsService

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

func NewSitesVersionsService

func NewSitesVersionsService(s *Service) *SitesVersionsService

func (*SitesVersionsService) Clone added in v0.16.0

func (r *SitesVersionsService) Clone(parent string, cloneversionrequest *CloneVersionRequest) *SitesVersionsCloneCall

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

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

func (*SitesVersionsService) Create

func (r *SitesVersionsService) Create(parent string, 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) Get added in v0.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` channel or 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) List added in v0.14.0

List: Lists the versions that have been created for the specified site. This list includes versions for both the default `live` channel and any active preview channels for the specified site.

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

func (*SitesVersionsService) Patch

func (r *SitesVersionsService) Patch(name string, version *Version) *SitesVersionsPatchCall

Patch: Updates the specified metadata for the specified version. This method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The supported state (../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 response body when you call `CreateVersion` (sites.versions/create).

func (*SitesVersionsService) PopulateFiles

func (r *SitesVersionsService) PopulateFiles(parent string, populateversionfilesrequest *PopulateVersionFilesRequest) *SitesVersionsPopulateFilesCall

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

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

type Status added in v0.16.0

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `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.
	Message string `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 for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (*Status) MarshalJSON added in v0.16.0

func (s *Status) MarshalJSON() ([]byte, error)

type UndeleteCustomDomainRequest added in v0.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.
	Etag string `json:"etag,omitempty"`
	// ValidateOnly: If true, Hosting validates that it's possible to complete your
	// request but doesn't actually delete the `CustomDomain`.
	ValidateOnly bool `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) MarshalJSON added in v0.141.0

func (s *UndeleteCustomDomainRequest) MarshalJSON() ([]byte, error)

type Version

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.
	CreateTime string `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`.
	DeleteTime string `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`.
	FileCount int64 `json:"fileCount,omitempty,string"`
	// FinalizeTime: Output only. The time at which the version was `FINALIZED`.
	FinalizeTime string `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).
	Name string `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.
	Status string `json:"status,omitempty"`
	// VersionBytes: Output only. The total stored bytesize of the version. This
	// value is calculated after a version is `FINALIZED`.
	VersionBytes int64 `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 files which determine how a site is displayed.

func (*Version) MarshalJSON

func (s *Version) MarshalJSON() ([]byte, error)

type VersionFile

type VersionFile struct {
	// Hash: The SHA256 content hash of the file.
	Hash string `json:"hash,omitempty"`
	// Path: The URI at which the file's content should display.
	Path string `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.
	Status string `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 (s *VersionFile) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL