firebasehosting

package
v0.3.1-alpha Latest Latest
Warning

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

 Go to latest Published: Apr 8, 2019 License: BSD-3-Clause Imports: 14 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 (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View your data across Google Cloud Platform services
	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 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 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 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 CloudRunRewrite added in v0.2.0 

type CloudRunRewrite struct {
	// Region: Optional. The region where the Cloud Run service is hosted.
	// Defaults to
	// `us-central1` if not supplied.
	Region string `json:"region,omitempty"`

	// ServiceId: Required. User supplied 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 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 will direct any 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 will fail. Any errors from the Cloud Run service (including when the service has been deleted) will be passed back down to the end user.

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 operation is in progress on the domain
	// association and no further
	// operations can be performed until it is complete.
	//   "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 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 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 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); 

}

The JSON representation for `Empty` is empty JSON object `{}`. 

type Header struct {
	// Glob: Required. The user-supplied
	// [glob pattern](/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"`

	// ForceSendFields is a list of field names (e.g. "Glob") to
	// unconditionally include in API requests. By default, fields with
	// empty 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`](/docs/hosting/full-config#headers) defines custom headers to add to a response should the request URL path match the pattern.

func (*Header) MarshalJSON 

func (s *Header) 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 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:"-"`
}

func (*ListDomainsResponse) MarshalJSON 

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

type ListReleasesResponse 

type ListReleasesResponse struct {
	// NextPageToken: If there are additional releases remaining beyond the
	// ones in this
	// response, then supply this token in the
	// next
	// [`list`](../sites.versions.files/list) call to continue with the next
	// set
	// of releases.
	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 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 ListVersionFilesResponse 

type ListVersionFilesResponse struct {
	// Files: The list path/hashes in the specified version.
	Files []*VersionFile `json:"files,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. "Files") to
	// unconditionally include in API requests. By default, fields with
	// empty 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 PopulateVersionFilesRequest 

type PopulateVersionFilesRequest struct {
	// Files: A set of file paths to the hashes corresponding to assets that
	// should be
	// added to the version. Note that 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 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 endpoint.
	UploadRequiredHashes []string `json:"uploadRequiredHashes,omitempty"`

	// UploadUrl: The URL to which the files should be uploaded, in the
	// format:
	// <br>"https://upload-firebasehosting.googleapis.com/upload/site
	// s/<var>site-name</var>/versions/<var>versionID</var>/files".
	// <br>Perfo
	// rm 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 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 Redirect 

type Redirect struct {
	// Glob: Required. The user-supplied
	// [glob pattern](/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.
	// <br>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:
	// <code>"glob": "/:capture*",
	// <br>"statusCode": 301,
	// <br>"location": "https://example.com/foo/:capture"</code>
	Location string `json:"location,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 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`](/docs/hosting/full-config#redirects) represents the configuration for returning an HTTP redirect response given a matching request URL 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&nbsp;characters.
	Message string `json:"message,omitempty"`

	// Name: Output only. The unique identifier for the release, in the
	// format:
	// <code>sites/<var>site-name</var>/releases/<var>releaseID</var>
	// </code>
	// This name is provided in the response body when you call
	// the
	// [`CreateRelease`](sites.releases/create) endpoint.
	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.
	// <br>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.
	// <br>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 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: Required. The user-supplied
	// [glob pattern](/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"`

	// 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 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`](/docs/hosting/full-config#rewrites) represents an internal content rewrite on the version. If the pattern matches, the request will be handled as if it were to the destination path specified in the configuration.

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

	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 automattically 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: A list of custom response headers that are added to the
	// content if the
	// request URL path matches the glob.
	Headers []*Header `json:"headers,omitempty"`

	// Redirects: A list of globs that will cause the response to redirect
	// to another
	// location.
	Redirects []*Redirect `json:"redirects,omitempty"`

	// Rewrites: A list of rewrites that will act as if the service were
	// given the
	// 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.
	// <br>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 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 patterns are matched and applied according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order).

func (*ServingConfig) MarshalJSON 

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

type SiteConfig 

type SiteConfig struct {
	// 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. "MaxVersions") to
	// unconditionally include in API requests. By default, fields with
	// empty 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. "MaxVersions") 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 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.

func (*SitesDomainsService) Delete 

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

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

func (*SitesDomainsService) Get 

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

Get: Gets a domain mapping on the specified site.

func (*SitesDomainsService) List 

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

List: Lists the domains for the specified site.

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.

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: <code>/sites/<var>site-name</var>/versions/<var>versionID</var ></code> The <var>site-name</var> in this version identifier must match the <var>site-name</var> in the `parent` parameter. <br> <br>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 page size to return. Defaults to 100.

func (*SitesReleasesListCall) PageToken 

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

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

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

func (*SitesReleasesService) List 

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

List: Lists the releases that have been created on the specified site.

type SitesService 

type SitesService struct {
	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.

func (*SitesService) UpdateConfig 

func (r *SitesService) UpdateConfig(name string, siteconfig *SiteConfig) *SitesUpdateConfigCall

UpdateConfig: Sets the Hosting metadata for a specific site.

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. <br>A field will be overwritten if, and only if, it's in the mask. <br>If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used.

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 only specified for legacy version creations.

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 page size to return. Defaults to 1000.

func (*SitesVersionsFilesListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.

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 in the version that should be listed.

Possible values: 

"STATUS_UNSPECIFIED"
"EXPECTED"
"ACTIVE"

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.

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. <br>A field will be overwritten if, and only if, it's in the mask. <br>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) Create 

func (r *SitesVersionsService) Create(parent string, version *Version) *SitesVersionsCreateCall

Create: Creates a new version for a site.

func (*SitesVersionsService) Delete 

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

Delete: Deletes the specified version.

func (*SitesVersionsService) Patch 

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

Patch: Updates the specified metadata for a version. Note that this method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The only valid transition for a version is currently from a `CREATED` status to a `FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the status of a version to `DELETED`.

func (*SitesVersionsService) PopulateFiles 

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

PopulateFiles: Adds content files to a version.

type Version 

type Version struct {
	// Config: The configuration for the behavior of the site. This
	// configuration exists
	// in the [`firebase.json`](/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.
	// <br>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 unique identifier for a version, in the
	// format:
	// <code>sites/<var>site-name</var>/versions/<var>versionID</var>
	// </code>
	// This name is provided in the response body when you call
	// the
	// [`CreateVersion`](../sites.versions/create) endpoint.
	Name string `json:"name,omitempty"`

	// Status: The deploy status of a version.
	// <br>
	// <br>For a successful deploy, call
	// the
	// [`CreateVersion`](sites.versions/create) endpoint 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.
	// <br>
	// <br>Note that if you leave the version in the `CREATED` state for
	// more
	// than 12&nbsp;hours, the system will automatically mark the version
	// as
	// `ABANDONED`.
	// <br>
	// <br>You can also change the status of a version to `DELETED` by
	// calling the
	// [`DeleteVersion`](sites.versions/delete) endpoint.
	//
	// 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&nbsp;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.
	Status string `json:"status,omitempty"`

	// VersionBytes: Output only. The total stored bytesize of the
	// version.
	// <br>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 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 the collection of configuration and [static files](sites.versions.files) that 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.
	// <br>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 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.