firebasehosting

package
v0.76.0 Latest Latest
Warning

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

 Go to latest Published: Apr 26, 2022 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/

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 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 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 option.WithTokenSource: 

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

See https://godoc.org/google.golang.org/api/option/ 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CertHttpChallenge: Represents an HTTP certificate challenge.

func (*CertHttpChallenge) MarshalJSON 

func (s *CertHttpChallenge) 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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"`

	// 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any non-pointer, non-interface field
	// appearing in ForceSendFields will be sent to the server regardless of
	// whether the field is empty or not. This may be used to include empty
	// fields in Patch requests.
	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. However, any field with an empty value appearing
	// in NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListChannelsResponse) MarshalJSON added in v0.32.0 

func (s *ListChannelsResponse) 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListDomainsResponse: The response to listing Domains.

func (*ListDomainsResponse) MarshalJSON 

func (s *ListDomainsResponse) 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListVersionsResponse) MarshalJSON added in v0.14.0 

func (s *ListVersionsResponse) 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 response of the operation in case of success. 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	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 

func (c *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsOperationsGetCall) Do added in v0.16.0 

func (c *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "firebasehosting.projects.operations.get" call. Exactly one of *Operation or error will be non-nil. 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 

func (c *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall

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

func (*ProjectsOperationsGetCall) Header added in v0.16.0 

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

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

func (*ProjectsOperationsGetCall) IfNoneMatch added in v0.16.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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 

func (r *ProjectsOperationsService) Get(name string) *ProjectsOperationsGetCall

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 

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

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 

func (c *ProjectsSitesChannelsCreateCall) Context(ctx context.Context) *ProjectsSitesChannelsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesChannelsCreateCall) Do added in v0.32.0 

func (c *ProjectsSitesChannelsCreateCall) Do(opts ...googleapi.CallOption) (*Channel, error)

Do executes the "firebasehosting.projects.sites.channels.create" call. Exactly one of *Channel or error will be non-nil. 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 

func (c *ProjectsSitesChannelsCreateCall) Fields(s ...googleapi.Field) *ProjectsSitesChannelsCreateCall

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

func (*ProjectsSitesChannelsCreateCall) Header added in v0.32.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *ProjectsSitesChannelsDeleteCall) Context(ctx context.Context) *ProjectsSitesChannelsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesChannelsDeleteCall) Do added in v0.32.0 

func (c *ProjectsSitesChannelsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firebasehosting.projects.sites.channels.delete" call. Exactly one of *Empty or error will be non-nil. 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 

func (c *ProjectsSitesChannelsDeleteCall) Fields(s ...googleapi.Field) *ProjectsSitesChannelsDeleteCall

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

func (*ProjectsSitesChannelsDeleteCall) Header added in v0.32.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *ProjectsSitesChannelsGetCall) Context(ctx context.Context) *ProjectsSitesChannelsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesChannelsGetCall) Do added in v0.32.0 

func (c *ProjectsSitesChannelsGetCall) Do(opts ...googleapi.CallOption) (*Channel, error)

Do executes the "firebasehosting.projects.sites.channels.get" call. Exactly one of *Channel or error will be non-nil. 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 

func (c *ProjectsSitesChannelsGetCall) Fields(s ...googleapi.Field) *ProjectsSitesChannelsGetCall

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

func (*ProjectsSitesChannelsGetCall) Header added in v0.32.0 

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

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

func (*ProjectsSitesChannelsGetCall) IfNoneMatch added in v0.32.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsSitesChannelsListCall added in v0.32.0 

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

func (*ProjectsSitesChannelsListCall) Context added in v0.32.0 

func (c *ProjectsSitesChannelsListCall) Context(ctx context.Context) *ProjectsSitesChannelsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesChannelsListCall) Do added in v0.32.0 

func (c *ProjectsSitesChannelsListCall) Do(opts ...googleapi.CallOption) (*ListChannelsResponse, error)

Do executes the "firebasehosting.projects.sites.channels.list" call. Exactly one of *ListChannelsResponse or error will be non-nil. 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 

func (c *ProjectsSitesChannelsListCall) Fields(s ...googleapi.Field) *ProjectsSitesChannelsListCall

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

func (*ProjectsSitesChannelsListCall) Header added in v0.32.0 

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

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

func (*ProjectsSitesChannelsListCall) IfNoneMatch added in v0.32.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsSitesChannelsListCall) PageSize added in v0.32.0 

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

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 

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

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 

func (c *ProjectsSitesChannelsListCall) Pages(ctx context.Context, f func(*ListChannelsResponse) error) error

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 

func (c *ProjectsSitesChannelsPatchCall) Context(ctx context.Context) *ProjectsSitesChannelsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesChannelsPatchCall) Do added in v0.32.0 

func (c *ProjectsSitesChannelsPatchCall) Do(opts ...googleapi.CallOption) (*Channel, error)

Do executes the "firebasehosting.projects.sites.channels.patch" call. Exactly one of *Channel or error will be non-nil. 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 

func (c *ProjectsSitesChannelsPatchCall) Fields(s ...googleapi.Field) *ProjectsSitesChannelsPatchCall

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

func (*ProjectsSitesChannelsPatchCall) Header added in v0.32.0 

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

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

func (*ProjectsSitesChannelsPatchCall) UpdateMask added in v0.32.0 

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

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 

func (c *ProjectsSitesChannelsReleasesCreateCall) Context(ctx context.Context) *ProjectsSitesChannelsReleasesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesChannelsReleasesCreateCall) Do added in v0.21.0 

func (c *ProjectsSitesChannelsReleasesCreateCall) Do(opts ...googleapi.CallOption) (*Release, error)

Do executes the "firebasehosting.projects.sites.channels.releases.create" call. Exactly one of *Release or error will be non-nil. 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 

func (c *ProjectsSitesChannelsReleasesCreateCall) Fields(s ...googleapi.Field) *ProjectsSitesChannelsReleasesCreateCall

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

func (*ProjectsSitesChannelsReleasesCreateCall) Header added in v0.21.0 

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

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

func (*ProjectsSitesChannelsReleasesCreateCall) VersionName added in v0.21.0 

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

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 ProjectsSitesChannelsReleasesListCall added in v0.21.0 

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

func (*ProjectsSitesChannelsReleasesListCall) Context added in v0.21.0 

func (c *ProjectsSitesChannelsReleasesListCall) Context(ctx context.Context) *ProjectsSitesChannelsReleasesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesChannelsReleasesListCall) Do added in v0.21.0 

func (c *ProjectsSitesChannelsReleasesListCall) Do(opts ...googleapi.CallOption) (*ListReleasesResponse, error)

Do executes the "firebasehosting.projects.sites.channels.releases.list" call. Exactly one of *ListReleasesResponse or error will be non-nil. 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 

func (c *ProjectsSitesChannelsReleasesListCall) Fields(s ...googleapi.Field) *ProjectsSitesChannelsReleasesListCall

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

func (*ProjectsSitesChannelsReleasesListCall) Header added in v0.21.0 

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

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

func (*ProjectsSitesChannelsReleasesListCall) IfNoneMatch added in v0.21.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsSitesChannelsReleasesListCall) PageSize added in v0.21.0 

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

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 

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

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 

func (c *ProjectsSitesChannelsReleasesListCall) Pages(ctx context.Context, f func(*ListReleasesResponse) error) error

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 

func (r *ProjectsSitesChannelsReleasesService) Create(parent string, release *Release) *ProjectsSitesChannelsReleasesCreateCall

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) List added in v0.21.0 

func (r *ProjectsSitesChannelsReleasesService) List(parent string) *ProjectsSitesChannelsReleasesListCall

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 

func (r *ProjectsSitesChannelsService) Create(parent string, channel *Channel) *ProjectsSitesChannelsCreateCall

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 

func (r *ProjectsSitesChannelsService) Delete(name string) *ProjectsSitesChannelsDeleteCall

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 

func (r *ProjectsSitesChannelsService) Get(name string) *ProjectsSitesChannelsGetCall

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 

func (r *ProjectsSitesChannelsService) List(parent string) *ProjectsSitesChannelsListCall

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 

func (r *ProjectsSitesChannelsService) Patch(name string, channel *Channel) *ProjectsSitesChannelsPatchCall

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 

func (c *ProjectsSitesCreateCall) Context(ctx context.Context) *ProjectsSitesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesCreateCall) Do added in v0.42.0 

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

Do executes the "firebasehosting.projects.sites.create" call. Exactly one of *Site or error will be non-nil. 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 

func (c *ProjectsSitesCreateCall) Fields(s ...googleapi.Field) *ProjectsSitesCreateCall

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

func (*ProjectsSitesCreateCall) Header added in v0.42.0 

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

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

func (*ProjectsSitesCreateCall) SiteId added in v0.42.0 

func (c *ProjectsSitesCreateCall) SiteId(siteId string) *ProjectsSitesCreateCall

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.

type ProjectsSitesDeleteCall added in v0.42.0 

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

func (*ProjectsSitesDeleteCall) Context added in v0.42.0 

func (c *ProjectsSitesDeleteCall) Context(ctx context.Context) *ProjectsSitesDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesDeleteCall) Do added in v0.42.0 

func (c *ProjectsSitesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firebasehosting.projects.sites.delete" call. Exactly one of *Empty or error will be non-nil. 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 

func (c *ProjectsSitesDeleteCall) Fields(s ...googleapi.Field) *ProjectsSitesDeleteCall

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

func (*ProjectsSitesDeleteCall) Header added in v0.42.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *ProjectsSitesDomainsCreateCall) Context(ctx context.Context) *ProjectsSitesDomainsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesDomainsCreateCall) Do added in v0.23.0 

func (c *ProjectsSitesDomainsCreateCall) Do(opts ...googleapi.CallOption) (*Domain, error)

Do executes the "firebasehosting.projects.sites.domains.create" call. Exactly one of *Domain or error will be non-nil. 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 

func (c *ProjectsSitesDomainsCreateCall) Fields(s ...googleapi.Field) *ProjectsSitesDomainsCreateCall

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

func (*ProjectsSitesDomainsCreateCall) Header added in v0.23.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *ProjectsSitesDomainsDeleteCall) Context(ctx context.Context) *ProjectsSitesDomainsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesDomainsDeleteCall) Do added in v0.23.0 

func (c *ProjectsSitesDomainsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firebasehosting.projects.sites.domains.delete" call. Exactly one of *Empty or error will be non-nil. 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 

func (c *ProjectsSitesDomainsDeleteCall) Fields(s ...googleapi.Field) *ProjectsSitesDomainsDeleteCall

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

func (*ProjectsSitesDomainsDeleteCall) Header added in v0.23.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *ProjectsSitesDomainsGetCall) Context(ctx context.Context) *ProjectsSitesDomainsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesDomainsGetCall) Do added in v0.23.0 

func (c *ProjectsSitesDomainsGetCall) Do(opts ...googleapi.CallOption) (*Domain, error)

Do executes the "firebasehosting.projects.sites.domains.get" call. Exactly one of *Domain or error will be non-nil. 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 

func (c *ProjectsSitesDomainsGetCall) Fields(s ...googleapi.Field) *ProjectsSitesDomainsGetCall

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

func (*ProjectsSitesDomainsGetCall) Header added in v0.23.0 

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

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

func (*ProjectsSitesDomainsGetCall) IfNoneMatch added in v0.23.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsSitesDomainsListCall added in v0.23.0 

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

func (*ProjectsSitesDomainsListCall) Context added in v0.23.0 

func (c *ProjectsSitesDomainsListCall) Context(ctx context.Context) *ProjectsSitesDomainsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesDomainsListCall) Do added in v0.23.0 

func (c *ProjectsSitesDomainsListCall) Do(opts ...googleapi.CallOption) (*ListDomainsResponse, error)

Do executes the "firebasehosting.projects.sites.domains.list" call. Exactly one of *ListDomainsResponse or error will be non-nil. 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 

func (c *ProjectsSitesDomainsListCall) Fields(s ...googleapi.Field) *ProjectsSitesDomainsListCall

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

func (*ProjectsSitesDomainsListCall) Header added in v0.23.0 

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

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

func (*ProjectsSitesDomainsListCall) IfNoneMatch added in v0.23.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsSitesDomainsListCall) PageSize added in v0.23.0 

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

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

func (*ProjectsSitesDomainsListCall) PageToken added in v0.23.0 

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

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

func (*ProjectsSitesDomainsListCall) Pages added in v0.23.0 

func (c *ProjectsSitesDomainsListCall) Pages(ctx context.Context, f func(*ListDomainsResponse) error) error

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 

func (r *ProjectsSitesDomainsService) Create(parent string, domain *Domain) *ProjectsSitesDomainsCreateCall

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 

func (r *ProjectsSitesDomainsService) Delete(name string) *ProjectsSitesDomainsDeleteCall

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 

func (r *ProjectsSitesDomainsService) Get(name string) *ProjectsSitesDomainsGetCall

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 

func (r *ProjectsSitesDomainsService) List(parent string) *ProjectsSitesDomainsListCall

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 

func (r *ProjectsSitesDomainsService) Update(name string, domain *Domain) *ProjectsSitesDomainsUpdateCall

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 

func (c *ProjectsSitesDomainsUpdateCall) Context(ctx context.Context) *ProjectsSitesDomainsUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesDomainsUpdateCall) Do added in v0.23.0 

func (c *ProjectsSitesDomainsUpdateCall) Do(opts ...googleapi.CallOption) (*Domain, error)

Do executes the "firebasehosting.projects.sites.domains.update" call. Exactly one of *Domain or error will be non-nil. 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 

func (c *ProjectsSitesDomainsUpdateCall) Fields(s ...googleapi.Field) *ProjectsSitesDomainsUpdateCall

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

func (*ProjectsSitesDomainsUpdateCall) Header added in v0.23.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *ProjectsSitesGetCall) Context(ctx context.Context) *ProjectsSitesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

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. Exactly one of *Site or error will be non-nil. 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 

func (c *ProjectsSitesGetCall) Fields(s ...googleapi.Field) *ProjectsSitesGetCall

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

func (*ProjectsSitesGetCall) Header added in v0.42.0 

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

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

func (*ProjectsSitesGetCall) IfNoneMatch added in v0.42.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsSitesGetConfigCall added in v0.23.0 

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

func (*ProjectsSitesGetConfigCall) Context added in v0.23.0 

func (c *ProjectsSitesGetConfigCall) Context(ctx context.Context) *ProjectsSitesGetConfigCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesGetConfigCall) Do added in v0.23.0 

func (c *ProjectsSitesGetConfigCall) Do(opts ...googleapi.CallOption) (*SiteConfig, error)

Do executes the "firebasehosting.projects.sites.getConfig" call. Exactly one of *SiteConfig or error will be non-nil. 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 

func (c *ProjectsSitesGetConfigCall) Fields(s ...googleapi.Field) *ProjectsSitesGetConfigCall

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

func (*ProjectsSitesGetConfigCall) Header added in v0.23.0 

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

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

func (*ProjectsSitesGetConfigCall) IfNoneMatch added in v0.23.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsSitesListCall added in v0.42.0 

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

func (*ProjectsSitesListCall) Context added in v0.42.0 

func (c *ProjectsSitesListCall) Context(ctx context.Context) *ProjectsSitesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesListCall) Do added in v0.42.0 

func (c *ProjectsSitesListCall) Do(opts ...googleapi.CallOption) (*ListSitesResponse, error)

Do executes the "firebasehosting.projects.sites.list" call. Exactly one of *ListSitesResponse or error will be non-nil. 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 

func (c *ProjectsSitesListCall) Fields(s ...googleapi.Field) *ProjectsSitesListCall

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

func (*ProjectsSitesListCall) Header added in v0.42.0 

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

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

func (*ProjectsSitesListCall) IfNoneMatch added in v0.42.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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 

func (c *ProjectsSitesListCall) Pages(ctx context.Context, f func(*ListSitesResponse) error) error

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 

func (c *ProjectsSitesPatchCall) Context(ctx context.Context) *ProjectsSitesPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesPatchCall) Do added in v0.42.0 

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

Do executes the "firebasehosting.projects.sites.patch" call. Exactly one of *Site or error will be non-nil. 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 

func (c *ProjectsSitesPatchCall) Fields(s ...googleapi.Field) *ProjectsSitesPatchCall

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

func (*ProjectsSitesPatchCall) Header added in v0.42.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *ProjectsSitesReleasesCreateCall) Context(ctx context.Context) *ProjectsSitesReleasesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesReleasesCreateCall) Do added in v0.21.0 

func (c *ProjectsSitesReleasesCreateCall) Do(opts ...googleapi.CallOption) (*Release, error)

Do executes the "firebasehosting.projects.sites.releases.create" call. Exactly one of *Release or error will be non-nil. 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 

func (c *ProjectsSitesReleasesCreateCall) Fields(s ...googleapi.Field) *ProjectsSitesReleasesCreateCall

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

func (*ProjectsSitesReleasesCreateCall) Header added in v0.21.0 

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

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

func (*ProjectsSitesReleasesCreateCall) VersionName added in v0.21.0 

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

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 ProjectsSitesReleasesListCall added in v0.21.0 

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

func (*ProjectsSitesReleasesListCall) Context added in v0.21.0 

func (c *ProjectsSitesReleasesListCall) Context(ctx context.Context) *ProjectsSitesReleasesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesReleasesListCall) Do added in v0.21.0 

func (c *ProjectsSitesReleasesListCall) Do(opts ...googleapi.CallOption) (*ListReleasesResponse, error)

Do executes the "firebasehosting.projects.sites.releases.list" call. Exactly one of *ListReleasesResponse or error will be non-nil. 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 

func (c *ProjectsSitesReleasesListCall) Fields(s ...googleapi.Field) *ProjectsSitesReleasesListCall

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

func (*ProjectsSitesReleasesListCall) Header added in v0.21.0 

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

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

func (*ProjectsSitesReleasesListCall) IfNoneMatch added in v0.21.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsSitesReleasesListCall) PageSize added in v0.21.0 

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

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 

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

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 

func (c *ProjectsSitesReleasesListCall) Pages(ctx context.Context, f func(*ListReleasesResponse) error) error

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 

func (r *ProjectsSitesReleasesService) Create(parent string, release *Release) *ProjectsSitesReleasesCreateCall

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) List added in v0.21.0 

func (r *ProjectsSitesReleasesService) List(parent string) *ProjectsSitesReleasesListCall

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

	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 

func (r *ProjectsSitesService) Delete(name string) *ProjectsSitesDeleteCall

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 

func (r *ProjectsSitesService) Get(nameid string) *ProjectsSitesGetCall

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 

func (r *ProjectsSitesService) GetConfig(name string) *ProjectsSitesGetConfigCall

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 

func (r *ProjectsSitesService) List(parent string) *ProjectsSitesListCall

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 

func (c *ProjectsSitesUpdateConfigCall) Context(ctx context.Context) *ProjectsSitesUpdateConfigCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesUpdateConfigCall) Do added in v0.23.0 

func (c *ProjectsSitesUpdateConfigCall) Do(opts ...googleapi.CallOption) (*SiteConfig, error)

Do executes the "firebasehosting.projects.sites.updateConfig" call. Exactly one of *SiteConfig or error will be non-nil. 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 

func (c *ProjectsSitesUpdateConfigCall) Fields(s ...googleapi.Field) *ProjectsSitesUpdateConfigCall

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

func (*ProjectsSitesUpdateConfigCall) Header added in v0.23.0 

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

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

func (*ProjectsSitesUpdateConfigCall) UpdateMask added in v0.23.0 

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

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 

func (c *ProjectsSitesVersionsCloneCall) Context(ctx context.Context) *ProjectsSitesVersionsCloneCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesVersionsCloneCall) Do added in v0.23.0 

func (c *ProjectsSitesVersionsCloneCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "firebasehosting.projects.sites.versions.clone" call. Exactly one of *Operation or error will be non-nil. 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 

func (c *ProjectsSitesVersionsCloneCall) Fields(s ...googleapi.Field) *ProjectsSitesVersionsCloneCall

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

func (*ProjectsSitesVersionsCloneCall) Header added in v0.23.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *ProjectsSitesVersionsCreateCall) Context(ctx context.Context) *ProjectsSitesVersionsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesVersionsCreateCall) Do added in v0.23.0 

func (c *ProjectsSitesVersionsCreateCall) Do(opts ...googleapi.CallOption) (*Version, error)

Do executes the "firebasehosting.projects.sites.versions.create" call. Exactly one of *Version or error will be non-nil. 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 

func (c *ProjectsSitesVersionsCreateCall) Fields(s ...googleapi.Field) *ProjectsSitesVersionsCreateCall

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

func (*ProjectsSitesVersionsCreateCall) Header added in v0.23.0 

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

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

func (*ProjectsSitesVersionsCreateCall) SizeBytes added in v0.23.0 

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

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 

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

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 

func (c *ProjectsSitesVersionsDeleteCall) Context(ctx context.Context) *ProjectsSitesVersionsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesVersionsDeleteCall) Do added in v0.23.0 

func (c *ProjectsSitesVersionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firebasehosting.projects.sites.versions.delete" call. Exactly one of *Empty or error will be non-nil. 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 

func (c *ProjectsSitesVersionsDeleteCall) Fields(s ...googleapi.Field) *ProjectsSitesVersionsDeleteCall

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

func (*ProjectsSitesVersionsDeleteCall) Header added in v0.23.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *ProjectsSitesVersionsFilesListCall) Context(ctx context.Context) *ProjectsSitesVersionsFilesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesVersionsFilesListCall) Do added in v0.23.0 

func (c *ProjectsSitesVersionsFilesListCall) Do(opts ...googleapi.CallOption) (*ListVersionFilesResponse, error)

Do executes the "firebasehosting.projects.sites.versions.files.list" call. Exactly one of *ListVersionFilesResponse or error will be non-nil. 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 

func (c *ProjectsSitesVersionsFilesListCall) Fields(s ...googleapi.Field) *ProjectsSitesVersionsFilesListCall

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

func (*ProjectsSitesVersionsFilesListCall) Header added in v0.23.0 

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

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

func (*ProjectsSitesVersionsFilesListCall) IfNoneMatch added in v0.23.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsSitesVersionsFilesListCall) PageSize added in v0.23.0 

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

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 

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

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 

func (c *ProjectsSitesVersionsFilesListCall) Pages(ctx context.Context, f func(*ListVersionFilesResponse) error) error

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 

func (c *ProjectsSitesVersionsFilesListCall) Status(status string) *ProjectsSitesVersionsFilesListCall

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 

func (r *ProjectsSitesVersionsFilesService) List(parent string) *ProjectsSitesVersionsFilesListCall

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 ProjectsSitesVersionsListCall added in v0.23.0 

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

func (*ProjectsSitesVersionsListCall) Context added in v0.23.0 

func (c *ProjectsSitesVersionsListCall) Context(ctx context.Context) *ProjectsSitesVersionsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesVersionsListCall) Do added in v0.23.0 

func (c *ProjectsSitesVersionsListCall) Do(opts ...googleapi.CallOption) (*ListVersionsResponse, error)

Do executes the "firebasehosting.projects.sites.versions.list" call. Exactly one of *ListVersionsResponse or error will be non-nil. 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 

func (c *ProjectsSitesVersionsListCall) Fields(s ...googleapi.Field) *ProjectsSitesVersionsListCall

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

func (*ProjectsSitesVersionsListCall) Filter added in v0.23.0 

func (c *ProjectsSitesVersionsListCall) Filter(filter string) *ProjectsSitesVersionsListCall

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 

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

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

func (*ProjectsSitesVersionsListCall) IfNoneMatch added in v0.23.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsSitesVersionsListCall) PageSize added in v0.23.0 

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

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 

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

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 

func (c *ProjectsSitesVersionsListCall) Pages(ctx context.Context, f func(*ListVersionsResponse) error) error

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 

func (c *ProjectsSitesVersionsPatchCall) Context(ctx context.Context) *ProjectsSitesVersionsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesVersionsPatchCall) Do added in v0.23.0 

func (c *ProjectsSitesVersionsPatchCall) Do(opts ...googleapi.CallOption) (*Version, error)

Do executes the "firebasehosting.projects.sites.versions.patch" call. Exactly one of *Version or error will be non-nil. 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 

func (c *ProjectsSitesVersionsPatchCall) Fields(s ...googleapi.Field) *ProjectsSitesVersionsPatchCall

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

func (*ProjectsSitesVersionsPatchCall) Header added in v0.23.0 

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

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

func (*ProjectsSitesVersionsPatchCall) UpdateMask added in v0.23.0 

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

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 

func (c *ProjectsSitesVersionsPopulateFilesCall) Context(ctx context.Context) *ProjectsSitesVersionsPopulateFilesCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsSitesVersionsPopulateFilesCall) Do added in v0.23.0 

func (c *ProjectsSitesVersionsPopulateFilesCall) Do(opts ...googleapi.CallOption) (*PopulateVersionFilesResponse, error)

Do executes the "firebasehosting.projects.sites.versions.populateFiles" call. Exactly one of *PopulateVersionFilesResponse or error will be non-nil. 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 

func (c *ProjectsSitesVersionsPopulateFilesCall) Fields(s ...googleapi.Field) *ProjectsSitesVersionsPopulateFilesCall

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

func (*ProjectsSitesVersionsPopulateFilesCall) Header added in v0.23.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (r *ProjectsSitesVersionsService) Clone(parent string, cloneversionrequest *CloneVersionRequest) *ProjectsSitesVersionsCloneCall

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 

func (r *ProjectsSitesVersionsService) Create(parent string, version *Version) *ProjectsSitesVersionsCreateCall

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 

func (r *ProjectsSitesVersionsService) Delete(name string) *ProjectsSitesVersionsDeleteCall

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) List added in v0.23.0 

func (r *ProjectsSitesVersionsService) List(parent string) *ProjectsSitesVersionsListCall

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 

func (r *ProjectsSitesVersionsService) Patch(name string, version *Version) *ProjectsSitesVersionsPatchCall

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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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"`

	// 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	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/projects/api/reference/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/projects/api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number)
	// ***(recommended)*** or its `ProjectId`
	// (https://firebase.google.com/docs/projects/api/reference/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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	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 

func (c *SitesChannelsCreateCall) Context(ctx context.Context) *SitesChannelsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesChannelsCreateCall) Do added in v0.32.0 

func (c *SitesChannelsCreateCall) Do(opts ...googleapi.CallOption) (*Channel, error)

Do executes the "firebasehosting.sites.channels.create" call. Exactly one of *Channel or error will be non-nil. 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 

func (c *SitesChannelsCreateCall) Fields(s ...googleapi.Field) *SitesChannelsCreateCall

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

func (*SitesChannelsCreateCall) Header added in v0.32.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *SitesChannelsDeleteCall) Context(ctx context.Context) *SitesChannelsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesChannelsDeleteCall) Do added in v0.32.0 

func (c *SitesChannelsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firebasehosting.sites.channels.delete" call. Exactly one of *Empty or error will be non-nil. 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 

func (c *SitesChannelsDeleteCall) Fields(s ...googleapi.Field) *SitesChannelsDeleteCall

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

func (*SitesChannelsDeleteCall) Header added in v0.32.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *SitesChannelsGetCall) Context(ctx context.Context) *SitesChannelsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesChannelsGetCall) Do added in v0.32.0 

func (c *SitesChannelsGetCall) Do(opts ...googleapi.CallOption) (*Channel, error)

Do executes the "firebasehosting.sites.channels.get" call. Exactly one of *Channel or error will be non-nil. 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 

func (c *SitesChannelsGetCall) Fields(s ...googleapi.Field) *SitesChannelsGetCall

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

func (*SitesChannelsGetCall) Header added in v0.32.0 

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

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

func (*SitesChannelsGetCall) IfNoneMatch added in v0.32.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type SitesChannelsListCall added in v0.32.0 

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

func (*SitesChannelsListCall) Context added in v0.32.0 

func (c *SitesChannelsListCall) Context(ctx context.Context) *SitesChannelsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesChannelsListCall) Do added in v0.32.0 

func (c *SitesChannelsListCall) Do(opts ...googleapi.CallOption) (*ListChannelsResponse, error)

Do executes the "firebasehosting.sites.channels.list" call. Exactly one of *ListChannelsResponse or error will be non-nil. 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 

func (c *SitesChannelsListCall) Fields(s ...googleapi.Field) *SitesChannelsListCall

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

func (*SitesChannelsListCall) Header added in v0.32.0 

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

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

func (*SitesChannelsListCall) IfNoneMatch added in v0.32.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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 

func (c *SitesChannelsListCall) Pages(ctx context.Context, f func(*ListChannelsResponse) error) error

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 

func (c *SitesChannelsPatchCall) Context(ctx context.Context) *SitesChannelsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesChannelsPatchCall) Do added in v0.32.0 

func (c *SitesChannelsPatchCall) Do(opts ...googleapi.CallOption) (*Channel, error)

Do executes the "firebasehosting.sites.channels.patch" call. Exactly one of *Channel or error will be non-nil. 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 

func (c *SitesChannelsPatchCall) Fields(s ...googleapi.Field) *SitesChannelsPatchCall

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

func (*SitesChannelsPatchCall) Header added in v0.32.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *SitesChannelsReleasesCreateCall) Context(ctx context.Context) *SitesChannelsReleasesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesChannelsReleasesCreateCall) Do added in v0.21.0 

func (c *SitesChannelsReleasesCreateCall) Do(opts ...googleapi.CallOption) (*Release, error)

Do executes the "firebasehosting.sites.channels.releases.create" call. Exactly one of *Release or error will be non-nil. 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 

func (c *SitesChannelsReleasesCreateCall) Fields(s ...googleapi.Field) *SitesChannelsReleasesCreateCall

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

func (*SitesChannelsReleasesCreateCall) Header added in v0.21.0 

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

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

func (*SitesChannelsReleasesCreateCall) VersionName added in v0.21.0 

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

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 SitesChannelsReleasesListCall added in v0.21.0 

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

func (*SitesChannelsReleasesListCall) Context added in v0.21.0 

func (c *SitesChannelsReleasesListCall) Context(ctx context.Context) *SitesChannelsReleasesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesChannelsReleasesListCall) Do added in v0.21.0 

func (c *SitesChannelsReleasesListCall) Do(opts ...googleapi.CallOption) (*ListReleasesResponse, error)

Do executes the "firebasehosting.sites.channels.releases.list" call. Exactly one of *ListReleasesResponse or error will be non-nil. 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 

func (c *SitesChannelsReleasesListCall) Fields(s ...googleapi.Field) *SitesChannelsReleasesListCall

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

func (*SitesChannelsReleasesListCall) Header added in v0.21.0 

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

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

func (*SitesChannelsReleasesListCall) IfNoneMatch added in v0.21.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*SitesChannelsReleasesListCall) PageSize added in v0.21.0 

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

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 

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

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 

func (c *SitesChannelsReleasesListCall) Pages(ctx context.Context, f func(*ListReleasesResponse) error) error

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 

func (r *SitesChannelsReleasesService) Create(parent string, release *Release) *SitesChannelsReleasesCreateCall

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) List added in v0.21.0 

func (r *SitesChannelsReleasesService) List(parent string) *SitesChannelsReleasesListCall

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 

func (r *SitesChannelsService) Delete(name string) *SitesChannelsDeleteCall

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 

func (r *SitesChannelsService) Get(name string) *SitesChannelsGetCall

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 

func (r *SitesChannelsService) List(parent string) *SitesChannelsListCall

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 

func (c *SitesDomainsCreateCall) Context(ctx context.Context) *SitesDomainsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesDomainsCreateCall) Do 

func (c *SitesDomainsCreateCall) Do(opts ...googleapi.CallOption) (*Domain, error)

Do executes the "firebasehosting.sites.domains.create" call. Exactly one of *Domain or error will be non-nil. 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 

func (c *SitesDomainsCreateCall) Fields(s ...googleapi.Field) *SitesDomainsCreateCall

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

func (*SitesDomainsCreateCall) Header 

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

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

type SitesDomainsDeleteCall 

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

func (*SitesDomainsDeleteCall) Context 

func (c *SitesDomainsDeleteCall) Context(ctx context.Context) *SitesDomainsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesDomainsDeleteCall) Do 

func (c *SitesDomainsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firebasehosting.sites.domains.delete" call. Exactly one of *Empty or error will be non-nil. 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 

func (c *SitesDomainsDeleteCall) Fields(s ...googleapi.Field) *SitesDomainsDeleteCall

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

func (*SitesDomainsDeleteCall) Header 

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

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

type SitesDomainsGetCall 

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

func (*SitesDomainsGetCall) Context 

func (c *SitesDomainsGetCall) Context(ctx context.Context) *SitesDomainsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesDomainsGetCall) Do 

func (c *SitesDomainsGetCall) Do(opts ...googleapi.CallOption) (*Domain, error)

Do executes the "firebasehosting.sites.domains.get" call. Exactly one of *Domain or error will be non-nil. 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 

func (c *SitesDomainsGetCall) Fields(s ...googleapi.Field) *SitesDomainsGetCall

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

func (*SitesDomainsGetCall) Header 

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

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

func (*SitesDomainsGetCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type SitesDomainsListCall 

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

func (*SitesDomainsListCall) Context 

func (c *SitesDomainsListCall) Context(ctx context.Context) *SitesDomainsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesDomainsListCall) Do 

func (c *SitesDomainsListCall) Do(opts ...googleapi.CallOption) (*ListDomainsResponse, error)

Do executes the "firebasehosting.sites.domains.list" call. Exactly one of *ListDomainsResponse or error will be non-nil. 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 

func (c *SitesDomainsListCall) Fields(s ...googleapi.Field) *SitesDomainsListCall

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

func (*SitesDomainsListCall) Header 

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

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

func (*SitesDomainsListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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 

func (c *SitesDomainsListCall) Pages(ctx context.Context, f func(*ListDomainsResponse) error) error

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 

func (r *SitesDomainsService) Delete(name string) *SitesDomainsDeleteCall

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

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

func (*SitesDomainsService) Get 

func (r *SitesDomainsService) Get(name string) *SitesDomainsGetCall

Get: Gets a domain mapping on the specified site.

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

func (*SitesDomainsService) List 

func (r *SitesDomainsService) List(parent string) *SitesDomainsListCall

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 

func (c *SitesDomainsUpdateCall) Context(ctx context.Context) *SitesDomainsUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesDomainsUpdateCall) Do 

func (c *SitesDomainsUpdateCall) Do(opts ...googleapi.CallOption) (*Domain, error)

Do executes the "firebasehosting.sites.domains.update" call. Exactly one of *Domain or error will be non-nil. 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 

func (c *SitesDomainsUpdateCall) Fields(s ...googleapi.Field) *SitesDomainsUpdateCall

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

func (*SitesDomainsUpdateCall) Header 

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

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

type SitesGetConfigCall 

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

func (*SitesGetConfigCall) Context 

func (c *SitesGetConfigCall) Context(ctx context.Context) *SitesGetConfigCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesGetConfigCall) Do 

func (c *SitesGetConfigCall) Do(opts ...googleapi.CallOption) (*SiteConfig, error)

Do executes the "firebasehosting.sites.getConfig" call. Exactly one of *SiteConfig or error will be non-nil. 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 

func (c *SitesGetConfigCall) Fields(s ...googleapi.Field) *SitesGetConfigCall

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

func (*SitesGetConfigCall) Header 

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

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

func (*SitesGetConfigCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type SitesReleasesCreateCall 

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

func (*SitesReleasesCreateCall) Context 

func (c *SitesReleasesCreateCall) Context(ctx context.Context) *SitesReleasesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesReleasesCreateCall) Do 

func (c *SitesReleasesCreateCall) Do(opts ...googleapi.CallOption) (*Release, error)

Do executes the "firebasehosting.sites.releases.create" call. Exactly one of *Release or error will be non-nil. 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 

func (c *SitesReleasesCreateCall) Fields(s ...googleapi.Field) *SitesReleasesCreateCall

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

func (*SitesReleasesCreateCall) Header 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 SitesReleasesListCall 

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

func (*SitesReleasesListCall) Context 

func (c *SitesReleasesListCall) Context(ctx context.Context) *SitesReleasesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesReleasesListCall) Do 

func (c *SitesReleasesListCall) Do(opts ...googleapi.CallOption) (*ListReleasesResponse, error)

Do executes the "firebasehosting.sites.releases.list" call. Exactly one of *ListReleasesResponse or error will be non-nil. 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 

func (c *SitesReleasesListCall) Fields(s ...googleapi.Field) *SitesReleasesListCall

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

func (*SitesReleasesListCall) Header 

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

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

func (*SitesReleasesListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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 

func (c *SitesReleasesListCall) Pages(ctx context.Context, f func(*ListReleasesResponse) error) error

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

func (r *SitesReleasesService) List(parent string) *SitesReleasesListCall

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 

func (c *SitesUpdateConfigCall) Context(ctx context.Context) *SitesUpdateConfigCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesUpdateConfigCall) Do 

func (c *SitesUpdateConfigCall) Do(opts ...googleapi.CallOption) (*SiteConfig, error)

Do executes the "firebasehosting.sites.updateConfig" call. Exactly one of *SiteConfig or error will be non-nil. 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 

func (c *SitesUpdateConfigCall) Fields(s ...googleapi.Field) *SitesUpdateConfigCall

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

func (*SitesUpdateConfigCall) Header 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *SitesVersionsCloneCall) Context(ctx context.Context) *SitesVersionsCloneCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesVersionsCloneCall) Do added in v0.16.0 

func (c *SitesVersionsCloneCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "firebasehosting.sites.versions.clone" call. Exactly one of *Operation or error will be non-nil. 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 

func (c *SitesVersionsCloneCall) Fields(s ...googleapi.Field) *SitesVersionsCloneCall

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

func (*SitesVersionsCloneCall) Header added in v0.16.0 

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

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

type SitesVersionsCreateCall 

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

func (*SitesVersionsCreateCall) Context 

func (c *SitesVersionsCreateCall) Context(ctx context.Context) *SitesVersionsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesVersionsCreateCall) Do 

func (c *SitesVersionsCreateCall) Do(opts ...googleapi.CallOption) (*Version, error)

Do executes the "firebasehosting.sites.versions.create" call. Exactly one of *Version or error will be non-nil. 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 

func (c *SitesVersionsCreateCall) Fields(s ...googleapi.Field) *SitesVersionsCreateCall

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

func (*SitesVersionsCreateCall) Header 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *SitesVersionsDeleteCall) Context(ctx context.Context) *SitesVersionsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesVersionsDeleteCall) Do 

func (c *SitesVersionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firebasehosting.sites.versions.delete" call. Exactly one of *Empty or error will be non-nil. 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 

func (c *SitesVersionsDeleteCall) Fields(s ...googleapi.Field) *SitesVersionsDeleteCall

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

func (*SitesVersionsDeleteCall) Header 

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

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

type SitesVersionsFilesListCall 

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

func (*SitesVersionsFilesListCall) Context 

func (c *SitesVersionsFilesListCall) Context(ctx context.Context) *SitesVersionsFilesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesVersionsFilesListCall) Do 

func (c *SitesVersionsFilesListCall) Do(opts ...googleapi.CallOption) (*ListVersionFilesResponse, error)

Do executes the "firebasehosting.sites.versions.files.list" call. Exactly one of *ListVersionFilesResponse or error will be non-nil. 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 

func (c *SitesVersionsFilesListCall) Fields(s ...googleapi.Field) *SitesVersionsFilesListCall

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

func (*SitesVersionsFilesListCall) Header 

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

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

func (*SitesVersionsFilesListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*SitesVersionsFilesListCall) PageSize 

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

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 

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

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 

func (c *SitesVersionsFilesListCall) Pages(ctx context.Context, f func(*ListVersionFilesResponse) error) error

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 

func (c *SitesVersionsFilesListCall) Status(status string) *SitesVersionsFilesListCall

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 

func (r *SitesVersionsFilesService) List(parent string) *SitesVersionsFilesListCall

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 SitesVersionsListCall added in v0.14.0 

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

func (*SitesVersionsListCall) Context added in v0.14.0 

func (c *SitesVersionsListCall) Context(ctx context.Context) *SitesVersionsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesVersionsListCall) Do added in v0.14.0 

func (c *SitesVersionsListCall) Do(opts ...googleapi.CallOption) (*ListVersionsResponse, error)

Do executes the "firebasehosting.sites.versions.list" call. Exactly one of *ListVersionsResponse or error will be non-nil. 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 

func (c *SitesVersionsListCall) Fields(s ...googleapi.Field) *SitesVersionsListCall

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

func (*SitesVersionsListCall) Filter added in v0.15.0 

func (c *SitesVersionsListCall) Filter(filter string) *SitesVersionsListCall

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 an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*SitesVersionsListCall) IfNoneMatch added in v0.14.0 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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 

func (c *SitesVersionsListCall) Pages(ctx context.Context, f func(*ListVersionsResponse) error) error

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 

func (c *SitesVersionsPatchCall) Context(ctx context.Context) *SitesVersionsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesVersionsPatchCall) Do 

func (c *SitesVersionsPatchCall) Do(opts ...googleapi.CallOption) (*Version, error)

Do executes the "firebasehosting.sites.versions.patch" call. Exactly one of *Version or error will be non-nil. 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 

func (c *SitesVersionsPatchCall) Fields(s ...googleapi.Field) *SitesVersionsPatchCall

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

func (*SitesVersionsPatchCall) Header 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (c *SitesVersionsPopulateFilesCall) Context(ctx context.Context) *SitesVersionsPopulateFilesCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*SitesVersionsPopulateFilesCall) Do 

func (c *SitesVersionsPopulateFilesCall) Do(opts ...googleapi.CallOption) (*PopulateVersionFilesResponse, error)

Do executes the "firebasehosting.sites.versions.populateFiles" call. Exactly one of *PopulateVersionFilesResponse or error will be non-nil. 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 

func (c *SitesVersionsPopulateFilesCall) Fields(s ...googleapi.Field) *SitesVersionsPopulateFilesCall

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

func (*SitesVersionsPopulateFilesCall) Header 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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 

func (r *SitesVersionsService) Delete(name string) *SitesVersionsDeleteCall

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) List added in v0.14.0 

func (r *SitesVersionsService) List(parent string) *SitesVersionsListCall

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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*VersionFile) MarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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