OAuth2 scopes used by this API.
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"
)
ActingUser: Contains metadata about the user who performed an action, such as creating a release or finalizing a version.
type ActingUser struct {
// Email: The email address of the user when the user performed the action.
Email string `json:"email,omitempty"`
// ImageUrl: A profile image URL for the user. May not be present if the user
// has changed their email address or deleted their account.
ImageUrl string `json:"imageUrl,omitempty"`
// ForceSendFields is a list of field names (e.g. "Email") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Email") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ActingUser) MarshalJSON() ([]byte, error)
CertDnsChallenge: Represents a DNS certificate challenge.
type CertDnsChallenge struct {
// DomainName: The domain name upon which the DNS challenge must be satisfied.
DomainName string `json:"domainName,omitempty"`
// Token: The value that must be present as a TXT record on the domain name to
// satisfy the challenge.
Token string `json:"token,omitempty"`
// ForceSendFields is a list of field names (e.g. "DomainName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DomainName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CertDnsChallenge) MarshalJSON() ([]byte, error)
CertHttpChallenge: Represents an HTTP certificate challenge.
type CertHttpChallenge struct {
// Path: The URL path on which to serve the specified token to satisfy the
// certificate challenge.
Path string `json:"path,omitempty"`
// Token: The token to serve at the specified URL path to satisfy the
// certificate challenge.
Token string `json:"token,omitempty"`
// ForceSendFields is a list of field names (e.g. "Path") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Path") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CertHttpChallenge) MarshalJSON() ([]byte, error)
CertVerification: A set of ACME challenges you can use to allow Hosting to create an SSL certificate for your domain name before directing traffic to Hosting servers. Use either the DNS or HTTP challenge; it's not necessary to provide both.
type CertVerification struct {
// Dns: Output only. A `TXT` record to add to your DNS records that confirms
// your intent to let Hosting create an SSL cert for your domain name.
Dns *DnsUpdates `json:"dns,omitempty"`
// Http: Output only. A file to add to your existing, non-Hosting hosting
// service that confirms your intent to let Hosting create an SSL cert for your
// domain name.
Http *HttpUpdate `json:"http,omitempty"`
// ForceSendFields is a list of field names (e.g. "Dns") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Dns") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CertVerification) MarshalJSON() ([]byte, error)
Certificate: An SSL certificate used to provide end-to-end encryption for requests against your domain name. A `Certificate` can be an actual SSL certificate or, for newly-created custom domains, Hosting's intent to create one.
type Certificate struct {
// CreateTime: Output only. The certificate's creation time. For `TEMPORARY`
// certs this is the time Hosting first generated challenges for your domain
// name. For all other cert types, it's the time the actual cert was created.
CreateTime string `json:"createTime,omitempty"`
// ExpireTime: Output only. The certificate's expiration time. After this time,
// the cert can no longer be used to provide secure communication between
// Hosting and your site's visitors.
ExpireTime string `json:"expireTime,omitempty"`
// Issues: Output only. A set of errors Hosting encountered when attempting to
// create a cert for your domain name. Resolve these issues to ensure Hosting
// is able to provide secure communication with your site's visitors.
Issues []*Status `json:"issues,omitempty"`
// State: Output only. The state of the certificate. Only the `CERT_ACTIVE` and
// `CERT_EXPIRING_SOON` states provide SSL coverage for a domain name. If the
// state is `PROPAGATING` and Hosting had an active cert for the domain name
// before, that formerly-active cert provides SSL coverage for the domain name
// until the current cert propagates.
//
// Possible values:
// "CERT_STATE_UNSPECIFIED" - The certificate's state is unspecified. The
// message is invalid if this is unspecified.
// "CERT_PREPARING" - The initial state of every certificate, represents
// Hosting's intent to create a certificate, before requests to a Certificate
// Authority are made.
// "CERT_VALIDATING" - Hosting is validating whether a domain name's DNS
// records are in a state that allow certificate creation on its behalf.
// "CERT_PROPAGATING" - The certificate was recently created, and needs time
// to propagate in Hosting's CDN.
// "CERT_ACTIVE" - The certificate is active, providing secure connections
// for the domain names it represents.
// "CERT_EXPIRING_SOON" - The certificate is expiring, all domain names on it
// will be given new certificates.
// "CERT_EXPIRED" - The certificate has expired. Hosting can no longer serve
// secure content on your domain name.
State string `json:"state,omitempty"`
// Type: Output only. The certificate's type.
//
// Possible values:
// "TYPE_UNSPECIFIED" - The certificate's type is unspecified. The message is
// invalid if this is unspecified.
// "TEMPORARY" - A short-lived certificate type that covers a domain name
// temporarily, while Hosting creates a more permanent certificate.
// "GROUPED" - The standard certificate for Spark plan custom domains.
// "PROJECT_GROUPED" - Blaze plan only. A certificate that covers from 1 to
// 100 domain names with custom domains on the same Firebase project.
// "DEDICATED" - Blaze plan only. A certificate that covers a single domain
// name.
Type string `json:"type,omitempty"`
// Verification: Output only. A set of ACME challenges you can add to your DNS
// records or existing, non-Hosting hosting provider to allow Hosting to create
// an SSL certificate for your domain name before you point traffic toward
// hosting. You can use thse challenges as part of a zero downtime transition
// from your old provider to Hosting.
Verification *CertVerification `json:"verification,omitempty"`
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreateTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Certificate) MarshalJSON() ([]byte, error)
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.
type Channel struct {
// CreateTime: Output only. The time at which the channel was created.
CreateTime string `json:"createTime,omitempty"`
// ExpireTime: The time at which the channel will be automatically deleted. If
// null, the channel will not be automatically deleted. This field is present
// in the output whether it's set directly or via the `ttl` field.
ExpireTime string `json:"expireTime,omitempty"`
// Labels: Text labels used for extra metadata and/or filtering.
Labels map[string]string `json:"labels,omitempty"`
// Name: The fully-qualified resource name for the channel, in the format:
// sites/ SITE_ID/channels/CHANNEL_ID
Name string `json:"name,omitempty"`
// Release: Output only. The current release for the channel, if any.
Release *Release `json:"release,omitempty"`
// RetainedReleaseCount: The number of previous releases to retain on the
// channel for rollback or other purposes. Must be a number between 1-100.
// Defaults to 10 for new channels.
RetainedReleaseCount int64 `json:"retainedReleaseCount,omitempty"`
// Ttl: Input only. A time-to-live for this channel. Sets `expire_time` to the
// provided duration past the time of the request.
Ttl string `json:"ttl,omitempty"`
// UpdateTime: Output only. The time at which the channel was last updated.
UpdateTime string `json:"updateTime,omitempty"`
// Url: Output only. The URL at which the content of this channel's current
// release can be viewed. This URL is a Firebase-provided subdomain of
// `web.app`. The content of this channel's current release can also be viewed
// at the Firebase-provided subdomain of `firebaseapp.com`. If this channel is
// the `live` channel for the Hosting site, then the content of this channel's
// current release can also be viewed at any connected custom domains.
Url string `json:"url,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreateTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Channel) MarshalJSON() ([]byte, error)
type CloneVersionRequest struct {
// Exclude: If provided, only paths that do not match any of the RegEx values
// in this list will be included in the new version.
Exclude *PathFilter `json:"exclude,omitempty"`
// Finalize: If true, the call to `CloneVersion` immediately finalizes the
// version after cloning is complete. If false, the cloned version will have a
// status of `CREATED`. Use `UpdateVersion` (patch) to set the status of the
// version to `FINALIZED`.
Finalize bool `json:"finalize,omitempty"`
// Include: If provided, only paths that match one or more RegEx values in this
// list will be included in the new version.
Include *PathFilter `json:"include,omitempty"`
// SourceVersion: Required. The unique identifier for the version to be cloned,
// in the format: sites/SITE_ID/versions/VERSION_ID
SourceVersion string `json:"sourceVersion,omitempty"`
// ForceSendFields is a list of field names (e.g. "Exclude") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Exclude") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CloneVersionRequest) MarshalJSON() ([]byte, error)
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).
type CloudRunRewrite struct {
// Region: Optional. User-provided region where the Cloud Run service is
// hosted. Defaults to `us-central1` if not supplied.
Region string `json:"region,omitempty"`
// ServiceId: Required. User-defined ID of the Cloud Run service.
ServiceId string `json:"serviceId,omitempty"`
// Tag: Optional. User-provided TrafficConfig tag to send traffic to. When
// omitted, traffic is sent to the service-wide URI
Tag string `json:"tag,omitempty"`
// ForceSendFields is a list of field names (e.g. "Region") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Region") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CloudRunRewrite) MarshalJSON() ([]byte, error)
CustomDomain: A `CustomDomain` is an entity that links a domain name to a Firebase Hosting site. Add a `CustomDomain` to your site to allow Hosting to serve the site's content in response to requests against your domain name.
type CustomDomain struct {
// Annotations: Annotations you can add to leave both human- and
// machine-readable metadata about your `CustomDomain`.
Annotations map[string]string `json:"annotations,omitempty"`
// Cert: Output only. The SSL certificate Hosting has for this custom domain's
// domain name. For new custom domains, this often represents Hosting's intent
// to create a certificate, rather than an actual cert. Check the `state` field
// for more.
Cert *Certificate `json:"cert,omitempty"`
// CertPreference: A field that lets you specify which SSL certificate type
// Hosting creates for your domain name. Spark plan custom domains only have
// access to the `GROUPED` cert type, while Blaze plan domains can select any
// option.
//
// Possible values:
// "TYPE_UNSPECIFIED" - The certificate's type is unspecified. The message is
// invalid if this is unspecified.
// "TEMPORARY" - A short-lived certificate type that covers a domain name
// temporarily, while Hosting creates a more permanent certificate.
// "GROUPED" - The standard certificate for Spark plan custom domains.
// "PROJECT_GROUPED" - Blaze plan only. A certificate that covers from 1 to
// 100 domain names with custom domains on the same Firebase project.
// "DEDICATED" - Blaze plan only. A certificate that covers a single domain
// name.
CertPreference string `json:"certPreference,omitempty"`
// CreateTime: Output only. The custom domain's create time.
CreateTime string `json:"createTime,omitempty"`
// DeleteTime: Output only. The time the `CustomDomain` was deleted; null for
// custom domains that haven't been deleted. Deleted custom domains persist for
// approximately 30 days, after which time Hosting removes them completely. To
// restore a deleted custom domain, make an `UndeleteCustomDomain` request.
DeleteTime string `json:"deleteTime,omitempty"`
// Etag: Output only. A string that represents the current state of the
// `CustomDomain` and allows you to confirm its initial state in requests that
// would modify it. Use the tag to ensure consistency when making
// `UpdateCustomDomain`, `DeleteCustomDomain`, and `UndeleteCustomDomain`
// requests.
Etag string `json:"etag,omitempty"`
// ExpireTime: Output only. The minimum time before a soft-deleted
// `CustomDomain` is completely removed from Hosting; null for custom domains
// that haven't been deleted.
ExpireTime string `json:"expireTime,omitempty"`
// HostState: Output only. The `HostState` of the domain name this
// `CustomDomain` refers to.
//
// Possible values:
// "HOST_STATE_UNSPECIFIED" - Your custom domain's host state is unspecified.
// The message is invalid if this is unspecified.
// "HOST_UNHOSTED" - Your custom domain's domain name isn't associated with
// any IP addresses.
// "HOST_UNREACHABLE" - Your custom domain's domain name can't be reached.
// Hosting services' DNS queries to find your domain name's IP addresses
// resulted in errors. See your `CustomDomain` object's `issues` field for more
// details.
// "HOST_MISMATCH" - Your custom domain's domain name has IP addresses that
// don't ultimately resolve to Hosting.
// "HOST_CONFLICT" - Your custom domain's domain name has IP addresses that
// resolve to both Hosting and other services. To ensure consistent results,
// remove `A` and `AAAA` records related to non-Hosting services.
// "HOST_ACTIVE" - All requests against your custom domain's domain name are
// served by Hosting. If the custom domain's `OwnershipState` is also `ACTIVE`,
// Hosting serves your Hosting site's content on the domain name.
HostState string `json:"hostState,omitempty"`
// Issues: Output only. A set of errors Hosting systems encountered when trying
// to establish Hosting's ability to serve secure content for your domain name.
// Resolve these issues to ensure your `CustomDomain` behaves properly.
Issues []*Status `json:"issues,omitempty"`
// Labels: Labels used for extra metadata and/or filtering.
Labels map[string]string `json:"labels,omitempty"`
// Name: Output only. The fully-qualified name of the `CustomDomain`.
Name string `json:"name,omitempty"`
// OwnershipState: Output only. The `OwnershipState` of the domain name this
// `CustomDomain` refers to.
//
// Possible values:
// "OWNERSHIP_STATE_UNSPECIFIED" - Your custom domain's ownership state is
// unspecified. This should never happen.
// "OWNERSHIP_MISSING" - Your custom domain's domain name has no
// Hosting-related ownership records; no Firebase project has permission to act
// on the domain name's behalf.
// "OWNERSHIP_UNREACHABLE" - Your custom domain's domain name can't be
// reached. Hosting services' DNS queries to find your domain name's ownership
// records resulted in errors. See your `CustomDomain` object's `issues` field
// for more details.
// "OWNERSHIP_MISMATCH" - Your custom domain's domain name is owned by
// another Firebase project. Remove the conflicting `TXT` records and replace
// them with project-specific records for your current Firebase project.
// "OWNERSHIP_CONFLICT" - Your custom domain's domain name has conflicting
// `TXT` records that indicate ownership by both your current Firebase project
// and another project. Remove the other project's ownership records to grant
// the current project ownership.
// "OWNERSHIP_PENDING" - Your custom domain's DNS records are configured
// correctly. Hosting will transfer ownership of your domain to this
// `CustomDomain` within 24 hours.
// "OWNERSHIP_ACTIVE" - Your custom domain's domain name has `TXT` records
// that grant its project permission to act on its behalf.
OwnershipState string `json:"ownershipState,omitempty"`
// Reconciling: Output only. A field that, if true, indicates that Hosting's
// systems are attmepting to make the custom domain's state match your
// preferred state. This is most frequently `true` when initially provisioning
// a `CustomDomain` after a `CreateCustomDomain` request or when creating a new
// SSL certificate to match an updated `cert_preference` after an
// `UpdateCustomDomain` request.
Reconciling bool `json:"reconciling,omitempty"`
// RedirectTarget: A domain name that this `CustomDomain` should direct traffic
// towards. If specified, Hosting will respond to requests against this custom
// domain with an HTTP 301 code, and route traffic to the specified
// `redirect_target` instead.
RedirectTarget string `json:"redirectTarget,omitempty"`
// RequiredDnsUpdates: Output only. A set of updates you should make to the
// domain name's DNS records to let Hosting serve secure content on its behalf.
RequiredDnsUpdates *DnsUpdates `json:"requiredDnsUpdates,omitempty"`
// UpdateTime: Output only. The last time the `CustomDomain` was updated.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Annotations") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Annotations") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomDomain) MarshalJSON() ([]byte, error)
CustomDomainMetadata: Metadata associated with a`CustomDomain` operation.
type CustomDomainMetadata struct {
// CertState: The `CertState` of the domain name's SSL certificate.
//
// Possible values:
// "CERT_STATE_UNSPECIFIED" - The certificate's state is unspecified. The
// message is invalid if this is unspecified.
// "CERT_PREPARING" - The initial state of every certificate, represents
// Hosting's intent to create a certificate, before requests to a Certificate
// Authority are made.
// "CERT_VALIDATING" - Hosting is validating whether a domain name's DNS
// records are in a state that allow certificate creation on its behalf.
// "CERT_PROPAGATING" - The certificate was recently created, and needs time
// to propagate in Hosting's CDN.
// "CERT_ACTIVE" - The certificate is active, providing secure connections
// for the domain names it represents.
// "CERT_EXPIRING_SOON" - The certificate is expiring, all domain names on it
// will be given new certificates.
// "CERT_EXPIRED" - The certificate has expired. Hosting can no longer serve
// secure content on your domain name.
CertState string `json:"certState,omitempty"`
// HostState: The `HostState` of the domain name this `CustomDomain` refers to.
//
// Possible values:
// "HOST_STATE_UNSPECIFIED" - Your custom domain's host state is unspecified.
// The message is invalid if this is unspecified.
// "HOST_UNHOSTED" - Your custom domain's domain name isn't associated with
// any IP addresses.
// "HOST_UNREACHABLE" - Your custom domain's domain name can't be reached.
// Hosting services' DNS queries to find your domain name's IP addresses
// resulted in errors. See your `CustomDomain` object's `issues` field for more
// details.
// "HOST_MISMATCH" - Your custom domain's domain name has IP addresses that
// don't ultimately resolve to Hosting.
// "HOST_CONFLICT" - Your custom domain's domain name has IP addresses that
// resolve to both Hosting and other services. To ensure consistent results,
// remove `A` and `AAAA` records related to non-Hosting services.
// "HOST_ACTIVE" - All requests against your custom domain's domain name are
// served by Hosting. If the custom domain's `OwnershipState` is also `ACTIVE`,
// Hosting serves your Hosting site's content on the domain name.
HostState string `json:"hostState,omitempty"`
// Issues: A list of issues that are currently preventing Hosting from
// completing the operation. These are generally DNS-related issues that
// Hosting encounters when querying a domain name's records or attempting to
// mint an SSL certificate.
Issues []*Status `json:"issues,omitempty"`
// LiveMigrationSteps: A set of DNS record updates and ACME challenges that
// allow you to transition domain names to Firebase Hosting with zero downtime.
// These updates allow Hosting to create an SSL certificate and establish
// ownership for your custom domain before Hosting begins serving traffic on
// it. If your domain name is already in active use with another provider, add
// one of the challenges and make the recommended DNS updates. After adding
// challenges and adjusting DNS records as necessary, wait for the
// `ownershipState` to be `OWNERSHIP_ACTIVE` and the `certState` to be
// `CERT_ACTIVE` before sending traffic to Hosting.
LiveMigrationSteps []*LiveMigrationStep `json:"liveMigrationSteps,omitempty"`
// OwnershipState: The `OwnershipState` of the domain name this `CustomDomain`
// refers to.
//
// Possible values:
// "OWNERSHIP_STATE_UNSPECIFIED" - Your custom domain's ownership state is
// unspecified. This should never happen.
// "OWNERSHIP_MISSING" - Your custom domain's domain name has no
// Hosting-related ownership records; no Firebase project has permission to act
// on the domain name's behalf.
// "OWNERSHIP_UNREACHABLE" - Your custom domain's domain name can't be
// reached. Hosting services' DNS queries to find your domain name's ownership
// records resulted in errors. See your `CustomDomain` object's `issues` field
// for more details.
// "OWNERSHIP_MISMATCH" - Your custom domain's domain name is owned by
// another Firebase project. Remove the conflicting `TXT` records and replace
// them with project-specific records for your current Firebase project.
// "OWNERSHIP_CONFLICT" - Your custom domain's domain name has conflicting
// `TXT` records that indicate ownership by both your current Firebase project
// and another project. Remove the other project's ownership records to grant
// the current project ownership.
// "OWNERSHIP_PENDING" - Your custom domain's DNS records are configured
// correctly. Hosting will transfer ownership of your domain to this
// `CustomDomain` within 24 hours.
// "OWNERSHIP_ACTIVE" - Your custom domain's domain name has `TXT` records
// that grant its project permission to act on its behalf.
OwnershipState string `json:"ownershipState,omitempty"`
// QuickSetupUpdates: A set of DNS record updates that allow Hosting to serve
// secure content on your domain name. The record type determines the update's
// purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that
// they direct traffic to Hosting servers. - `TXT`: Updates ownership
// permissions on your domain name, letting Hosting know that your custom
// domain's project has permission to perform actions for that domain name. -
// `CAA`: Updates your domain name's list of authorized Certificate Authorities
// (CAs). Only present if you have existing `CAA` records that prohibit
// Hosting's CA from minting certs for your domain name. These updates include
// all DNS changes you'll need to get started with Hosting, but, if made all at
// once, can result in a brief period of downtime for your domain name--while
// Hosting creates and uploads an SSL cert, for example. If you'd like to add
// your domain name to Hosting without downtime, complete the
// `liveMigrationSteps` first, before making the remaining updates in this
// field.
QuickSetupUpdates *DnsUpdates `json:"quickSetupUpdates,omitempty"`
// ForceSendFields is a list of field names (e.g. "CertState") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CertState") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomDomainMetadata) MarshalJSON() ([]byte, error)
DnsRecord: DNS records are resource records that define how systems and services should behave when handling requests for a domain name. For example, when you add `A` records to your domain name's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain name (such as your Hosting site files).
type DnsRecord struct {
// DomainName: Output only. The domain name the record pertains to, e.g.
// `foo.bar.com.`.
DomainName string `json:"domainName,omitempty"`
// Rdata: Output only. The data of the record. The meaning of the value depends
// on record type: - A and AAAA: IP addresses for the domain name. - CNAME:
// Another domain to check for records. - TXT: Arbitrary text strings
// associated with the domain name. Hosting uses TXT records to determine which
// Firebase projects have permission to act on the domain name's behalf. - CAA:
// The record's flags, tag, and value, e.g. `0 issue "pki.goog".
Rdata string `json:"rdata,omitempty"`
// RequiredAction: Output only. An enum that indicates the a required action
// for this record.
//
// Possible values:
// "NONE" - No action necessary.
// "ADD" - Add this record to your DNS records.
// "REMOVE" - Remove this record from your DNS records.
RequiredAction string `json:"requiredAction,omitempty"`
// Type: Output only. The record's type, which determines what data the record
// contains.
//
// Possible values:
// "TYPE_UNSPECIFIED" - The record's type is unspecified. The message is
// invalid if this is unspecified.
// "A" - An `A` record, as defined in [RFC
// 1035](https://tools.ietf.org/html/rfc1035). A records determine which IPv4
// addresses a domain name directs traffic towards.
// "CNAME" - A `CNAME` record, as defined in [RFC
// 1035](https://tools.ietf.org/html/rfc1035). `CNAME` or Canonical Name
// records map a domain name to a different, canonical domain name. If a
// `CNAME` record is present, it should be the only record on the domain name.
// "TXT" - A `TXT` record, as defined in [RFC
// 1035](https://tools.ietf.org/html/rfc1035). `TXT` records hold arbitrary
// text data on a domain name. Hosting uses `TXT` records to establish which
// Firebase Project has permission to act on a domain name.
// "AAAA" - An AAAA record, as defined in [RFC
// 3596](https://tools.ietf.org/html/rfc3596) AAAA records determine which IPv6
// addresses a domain name directs traffic towards.
// "CAA" - A CAA record, as defined in [RFC
// 6844](https://tools.ietf.org/html/rfc6844). CAA, or Certificate Authority
// Authorization, records determine which Certificate Authorities (SSL
// certificate minting organizations) are authorized to mint a certificate for
// the domain name. Firebase Hosting uses `pki.goog` as its primary CA. CAA
// records cascade. A CAA record on `foo.com` also applies to `bar.foo.com`
// unless `bar.foo.com` has its own set of CAA records. CAA records are
// optional. If a domain name and its parents have no CAA records, all CAs are
// authorized to mint certificates on its behalf. In general, Hosting only asks
// you to modify CAA records when doing so is required to unblock SSL cert
// creation.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "DomainName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DomainName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DnsRecord) MarshalJSON() ([]byte, error)
DnsRecordSet: A set of DNS records relevant to the setup and maintenance of a custom domain in Firebase Hosting.
type DnsRecordSet struct {
// CheckError: Output only. An error Hosting services encountered when querying
// your domain name's DNS records. Note: Hosting ignores `NXDOMAIN` errors, as
// those generally just mean that a domain name hasn't been set up yet.
CheckError *Status `json:"checkError,omitempty"`
// DomainName: Output only. The domain name the record set pertains to.
DomainName string `json:"domainName,omitempty"`
// Records: Output only. Records on the domain.
Records []*DnsRecord `json:"records,omitempty"`
// ForceSendFields is a list of field names (e.g. "CheckError") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CheckError") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DnsRecordSet) MarshalJSON() ([]byte, error)
DnsUpdates: A set of DNS record updates that you should make to allow Hosting to serve secure content in response to requests against your domain name. These updates present the current state of your domain name's DNS records when Hosting last queried them, and the desired set of records that Hosting needs to see before your custom domain can be fully active.
type DnsUpdates struct {
// CheckTime: The last time Hosting checked your custom domain's DNS records.
CheckTime string `json:"checkTime,omitempty"`
// Desired: The set of DNS records Hosting needs to serve secure content on the
// domain.
Desired []*DnsRecordSet `json:"desired,omitempty"`
// Discovered: The set of DNS records Hosting discovered when inspecting a
// domain.
Discovered []*DnsRecordSet `json:"discovered,omitempty"`
// ForceSendFields is a list of field names (e.g. "CheckTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CheckTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DnsUpdates) MarshalJSON() ([]byte, error)
Domain: The intended behavior and status information of a domain.
type Domain struct {
// DomainName: Required. The domain name of the association.
DomainName string `json:"domainName,omitempty"`
// DomainRedirect: If set, the domain should redirect with the provided
// parameters.
DomainRedirect *DomainRedirect `json:"domainRedirect,omitempty"`
// Provisioning: Output only. Information about the provisioning of
// certificates and the health of the DNS resolution for the domain.
Provisioning *DomainProvisioning `json:"provisioning,omitempty"`
// Site: Required. The site name of the association.
Site string `json:"site,omitempty"`
// Status: Output only. Additional status of the domain association.
//
// Possible values:
// "DOMAIN_STATUS_UNSPECIFIED" - Unspecified domain association status.
// "DOMAIN_CHANGE_PENDING" - An external operation is in progress on the
// domain association and no further operations can be performed until it is
// complete. Formerly used for metabase updates. Not currently used
// "DOMAIN_ACTIVE" - The domain association is active and no additional
// action is required.
// "DOMAIN_VERIFICATION_REQUIRED" - The domain was previously verified in the
// legacy system. User must reverify the domain through the ownership service.
// "DOMAIN_VERIFICATION_LOST" - The domain verification has been lost and the
// domain is in the grace period before being removed from the Firebase Hosting
// site.
Status string `json:"status,omitempty"`
// UpdateTime: Output only. The time at which the domain was last updated.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DomainName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DomainName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Domain) MarshalJSON() ([]byte, error)
DomainProvisioning: The current certificate provisioning status information for a domain.
type DomainProvisioning struct {
// CertChallengeDiscoveredTxt: The TXT records (for the certificate challenge)
// that were found at the last DNS fetch.
CertChallengeDiscoveredTxt []string `json:"certChallengeDiscoveredTxt,omitempty"`
// CertChallengeDns: The DNS challenge for generating a certificate.
CertChallengeDns *CertDnsChallenge `json:"certChallengeDns,omitempty"`
// CertChallengeHttp: The HTTP challenge for generating a certificate.
CertChallengeHttp *CertHttpChallenge `json:"certChallengeHttp,omitempty"`
// CertStatus: The certificate provisioning status; updated when Firebase
// Hosting provisions an SSL certificate for the domain.
//
// Possible values:
// "CERT_STATUS_UNSPECIFIED" - Unspecified certificate provisioning status.
// "CERT_PENDING" - Waiting for certificate challenge to be created.
// "CERT_MISSING" - Waiting for certificate challenge to be met.
// "CERT_PROCESSING" - Certificate challenge met; attempting to
// acquire/propagate certificate.
// "CERT_PROPAGATING" - Certificate obtained; propagating to the CDN.
// "CERT_ACTIVE" - Certificate provisioned and deployed across the CDN.
// "CERT_ERROR" - Certificate provisioning failed in a non-recoverable
// manner.
CertStatus string `json:"certStatus,omitempty"`
// DiscoveredIps: The IPs found at the last DNS fetch.
DiscoveredIps []string `json:"discoveredIps,omitempty"`
// DnsFetchTime: The time at which the last DNS fetch occurred.
DnsFetchTime string `json:"dnsFetchTime,omitempty"`
// DnsStatus: The DNS record match status as of the last DNS fetch.
//
// Possible values:
// "DNS_STATUS_UNSPECIFIED" - Unspecified DNS status.
// "DNS_PENDING" - No DNS records have been specified for this domain yet.
// "DNS_MISSING" - None of the required DNS records have been detected on the
// domain.
// "DNS_PARTIAL_MATCH" - Some of the required DNS records were detected, but
// not all of them. No extra (non-required) DNS records were detected.
// "DNS_MATCH" - All required DNS records were detected. No extra
// (non-required) DNS records were detected.
// "DNS_EXTRANEOUS_MATCH" - The domain has at least one of the required DNS
// records, and it has at least one extra (non-required) DNS record.
DnsStatus string `json:"dnsStatus,omitempty"`
// ExpectedIps: The list of IPs to which the domain is expected to resolve.
ExpectedIps []string `json:"expectedIps,omitempty"`
// ForceSendFields is a list of field names (e.g. "CertChallengeDiscoveredTxt")
// to unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CertChallengeDiscoveredTxt") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DomainProvisioning) MarshalJSON() ([]byte, error)
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.
type DomainRedirect struct {
// DomainName: Required. The domain name to redirect to.
DomainName string `json:"domainName,omitempty"`
// Type: Required. The redirect status code.
//
// Possible values:
// "REDIRECT_TYPE_UNSPECIFIED" - The default redirect type; should not be
// intentionlly used.
// "MOVED_PERMANENTLY" - The redirect will respond with an HTTP status code
// of `301 Moved Permanently`.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "DomainName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DomainName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DomainRedirect) MarshalJSON() ([]byte, error)
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 Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `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.
type Header struct {
// Glob: The user-supplied glob
// (https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching)
// to match against the request URL path.
Glob string `json:"glob,omitempty"`
// Headers: Required. The additional headers to add to the response.
Headers map[string]string `json:"headers,omitempty"`
// Regex: The user-supplied RE2 regular expression to match against the request
// URL path.
Regex string `json:"regex,omitempty"`
// ForceSendFields is a list of field names (e.g. "Glob") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Glob") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Header) MarshalJSON() ([]byte, error)
HttpUpdate: A file you can add to your existing, non-Hosting hosting service that confirms your intent to allow Hosting's Certificate Authorities to create an SSL certificate for your domain.
type HttpUpdate struct {
// CheckError: Output only. An error encountered during the last contents
// check. If null, the check completed successfully.
CheckError *Status `json:"checkError,omitempty"`
// Desired: Output only. A text string to serve at the path.
Desired string `json:"desired,omitempty"`
// Discovered: Output only. Whether Hosting was able to find the required file
// contents on the specified path during its last check.
Discovered string `json:"discovered,omitempty"`
// LastCheckTime: Output only. The last time Hosting systems checked for the
// file contents.
LastCheckTime string `json:"lastCheckTime,omitempty"`
// Path: Output only. The path to the file.
Path string `json:"path,omitempty"`
// ForceSendFields is a list of field names (e.g. "CheckError") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CheckError") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *HttpUpdate) MarshalJSON() ([]byte, error)
I18nConfig: If provided, i18n rewrites are enabled.
type I18nConfig struct {
// Root: Required. The user-supplied path where country and language specific
// content will be looked for within the public directory.
Root string `json:"root,omitempty"`
// ForceSendFields is a list of field names (e.g. "Root") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Root") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *I18nConfig) MarshalJSON() ([]byte, error)
type ListChannelsResponse struct {
// Channels: The list of channels.
Channels []*Channel `json:"channels,omitempty"`
// NextPageToken: The pagination token, if more results exist beyond the ones
// in this response. Include this token in your next call to `ListChannels`.
// Page tokens are short-lived and should not be stored.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Channels") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Channels") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListChannelsResponse) MarshalJSON() ([]byte, error)
ListCustomDomainsResponse: The response from `ListCustomDomains`.
type ListCustomDomainsResponse struct {
// CustomDomains: A list of `CustomDomain` entities associated with the
// specified Firebase `Site`.
CustomDomains []*CustomDomain `json:"customDomains,omitempty"`
// NextPageToken: The pagination token, if more results exist beyond the ones
// in this response. Include this token in your next call to
// `ListCustomDomains`. Page tokens are short-lived and should not be stored.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CustomDomains") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CustomDomains") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListCustomDomainsResponse) MarshalJSON() ([]byte, error)
ListDomainsResponse: The response to listing Domains.
type ListDomainsResponse struct {
// Domains: The list of domains, if any exist.
Domains []*Domain `json:"domains,omitempty"`
// NextPageToken: The pagination token, if more results exist.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Domains") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Domains") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListDomainsResponse) MarshalJSON() ([]byte, error)
ListOperationsResponse: The response message for Operations.ListOperations.
type ListOperationsResponse struct {
// NextPageToken: The standard List next-page token.
NextPageToken string `json:"nextPageToken,omitempty"`
// Operations: A list of operations that matches the specified filter in the
// request.
Operations []*Operation `json:"operations,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
type ListReleasesResponse struct {
// NextPageToken: The pagination token, if more results exist beyond the ones
// in this response. Include this token in your next call to `ListReleases`.
// Page tokens are short-lived and should not be stored.
NextPageToken string `json:"nextPageToken,omitempty"`
// Releases: The list of hashes of files that still need to be uploaded, if any
// exist.
Releases []*Release `json:"releases,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListReleasesResponse) MarshalJSON() ([]byte, error)
type ListSitesResponse struct {
// NextPageToken: The pagination token, if more results exist beyond the ones
// in this response. Include this token in your next call to `ListSites`. Page
// tokens are short-lived and should not be stored.
NextPageToken string `json:"nextPageToken,omitempty"`
// Sites: A list of Site objects associated with the specified Firebase
// project.
Sites []*Site `json:"sites,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListSitesResponse) MarshalJSON() ([]byte, error)
type ListVersionFilesResponse struct {
// Files: The list of paths to the hashes of the files in the specified
// version.
Files []*VersionFile `json:"files,omitempty"`
// NextPageToken: The pagination token, if more results exist beyond the ones
// in this response. Include this token in your next call to
// `ListVersionFiles`. Page tokens are short-lived and should not be stored.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Files") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Files") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListVersionFilesResponse) MarshalJSON() ([]byte, error)
type ListVersionsResponse struct {
// NextPageToken: The pagination token, if more results exist beyond the ones
// in this response. Include this token in your next call to `ListVersions`.
// Page tokens are short-lived and should not be stored.
NextPageToken string `json:"nextPageToken,omitempty"`
// Versions: The list of versions, if any exist.
Versions []*Version `json:"versions,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListVersionsResponse) MarshalJSON() ([]byte, error)
LiveMigrationStep: A set of updates including ACME challenges and DNS records that allow Hosting to create an SSL certificate and establish project ownership for your domain name before you direct traffic to Hosting servers. Use these updates to facilitate zero downtime migrations to Hosting from other services. After you've made the recommended updates, check your custom domain's `ownershipState` and `certState`. To avoid downtime, they should be `OWNERSHIP_ACTIVE` and `CERT_ACTIVE`, respectively, before you update your `A` and `AAAA` records.
type LiveMigrationStep struct {
// CertVerification: Output only. A pair of ACME challenges that Hosting's
// Certificate Authority (CA) can use to create an SSL cert for your domain
// name. Use either the DNS or HTTP challenge; it's not necessary to provide
// both.
CertVerification *CertVerification `json:"certVerification,omitempty"`
// DnsUpdates: Output only. DNS updates to facilitate your domain's
// zero-downtime migration to Hosting.
DnsUpdates *DnsUpdates `json:"dnsUpdates,omitempty"`
// Issues: Output only. Issues that prevent the current step from completing.
Issues []*Status `json:"issues,omitempty"`
// State: Output only. The state of the live migration step, indicates whether
// you should work to complete the step now, in the future, or have already
// completed it.
//
// Possible values:
// "STATE_UNSPECIFIED" - The step's state is unspecified. The message is
// invalid if this is unspecified.
// "PREPARING" - Hosting doesn't have enough information to construct the
// step yet. Complete any prior steps and/or resolve this step's issue to
// proceed.
// "PENDING" - The step's state is pending. Complete prior steps before
// working on a `PENDING` step.
// "INCOMPLETE" - The step is incomplete. You should complete any
// `certVerification` or `dnsUpdates` changes to complete it.
// "PROCESSING" - You've done your part to update records and present
// challenges as necessary. Hosting is now completing background processes to
// complete the step, e.g. minting an SSL cert for your domain name.
// "COMPLETE" - The step is complete. You've already made the necessary
// changes to your domain and/or prior hosting service to advance to the next
// step. Once all steps are complete, Hosting is ready to serve secure content
// on your domain.
State string `json:"state,omitempty"`
// ForceSendFields is a list of field names (e.g. "CertVerification") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CertVerification") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *LiveMigrationStep) MarshalJSON() ([]byte, error)
Operation: This resource represents a long-running operation that is the result of a network API call.
type Operation struct {
// Done: If the value is `false`, it means the operation is still in progress.
// If `true`, the operation is completed, and either `error` or `response` is
// available.
Done bool `json:"done,omitempty"`
// Error: The error result of the operation in case of failure or cancellation.
Error *Status `json:"error,omitempty"`
// Metadata: Service-specific metadata associated with the operation. It
// typically contains progress information and common metadata such as create
// time. Some services might not provide such metadata. Any method that returns
// a long-running operation should document the metadata type, if any.
Metadata googleapi.RawMessage `json:"metadata,omitempty"`
// Name: The server-assigned name, which is only unique within the same service
// that originally returns it. If you use the default HTTP mapping, the `name`
// should be a resource name ending with `operations/{unique_id}`.
Name string `json:"name,omitempty"`
// Response: The normal, successful response of the operation. If the original
// method returns no data on success, such as `Delete`, the response is
// `google.protobuf.Empty`. If the original method is standard
// `Get`/`Create`/`Update`, the response should be the resource. For other
// methods, the response should have the type `XxxResponse`, where `Xxx` is the
// original method name. For example, if the original method name is
// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Response googleapi.RawMessage `json:"response,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Done") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Operation) MarshalJSON() ([]byte, error)
PathFilter: A representation of filter path.
type PathFilter struct {
// Regexes: An array of RegEx values by which to filter.
Regexes []string `json:"regexes,omitempty"`
// ForceSendFields is a list of field names (e.g. "Regexes") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Regexes") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PathFilter) MarshalJSON() ([]byte, error)
type PopulateVersionFilesRequest struct {
// Files: A set of file paths to the hashes corresponding to assets that should
// be added to the version. A file path to an empty hash will remove the path
// from the version. Calculate a hash by Gzipping the file then taking the
// SHA256 hash of the newly compressed file.
Files map[string]string `json:"files,omitempty"`
// ForceSendFields is a list of field names (e.g. "Files") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Files") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PopulateVersionFilesRequest) MarshalJSON() ([]byte, error)
type PopulateVersionFilesResponse struct {
// UploadRequiredHashes: The content hashes of the specified files that need to
// be uploaded to the specified URL.
UploadRequiredHashes []string `json:"uploadRequiredHashes,omitempty"`
// UploadUrl: The URL to which the files should be uploaded, in the format:
// "https://upload-firebasehosting.googleapis.com/upload/sites/SITE_ID
// /versions/VERSION_ID/files" Perform a multipart `POST` of the Gzipped file
// contents to the URL using a forward slash and the hash of the file appended
// to the end.
UploadUrl string `json:"uploadUrl,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "UploadRequiredHashes") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "UploadRequiredHashes") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PopulateVersionFilesResponse) MarshalJSON() ([]byte, error)
type ProjectsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "firebasehosting.projects.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsOperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsOperationsService(s *Service) *ProjectsOperationsService
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 struct {
Operations *ProjectsOperationsService
Sites *ProjectsSitesService
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
type ProjectsSitesChannelsCreateCall struct {
// contains filtered or unexported fields
}
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 (c *ProjectsSitesChannelsCreateCall) Context(ctx context.Context) *ProjectsSitesChannelsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesChannelsCreateCall) Do(opts ...googleapi.CallOption) (*Channel, error)
Do executes the "firebasehosting.projects.sites.channels.create" call. Any non-2xx status code is an error. Response headers are in either *Channel.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesChannelsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSitesChannelsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesChannelsDeleteCall) Context(ctx context.Context) *ProjectsSitesChannelsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesChannelsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "firebasehosting.projects.sites.channels.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesChannelsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSitesChannelsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesChannelsGetCall) Context(ctx context.Context) *ProjectsSitesChannelsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesChannelsGetCall) Do(opts ...googleapi.CallOption) (*Channel, error)
Do executes the "firebasehosting.projects.sites.channels.get" call. Any non-2xx status code is an error. Response headers are in either *Channel.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesChannelsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesChannelsGetCall) IfNoneMatch(entityTag string) *ProjectsSitesChannelsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsSitesChannelsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesChannelsListCall) Context(ctx context.Context) *ProjectsSitesChannelsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesChannelsListCall) Do(opts ...googleapi.CallOption) (*ListChannelsResponse, error)
Do executes the "firebasehosting.projects.sites.channels.list" call. Any non-2xx status code is an error. Response headers are in either *ListChannelsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesChannelsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesChannelsListCall) IfNoneMatch(entityTag string) *ProjectsSitesChannelsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesChannelsPatchCall) Context(ctx context.Context) *ProjectsSitesChannelsPatchCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesChannelsPatchCall) Do(opts ...googleapi.CallOption) (*Channel, error)
Do executes the "firebasehosting.projects.sites.channels.patch" call. Any non-2xx status code is an error. Response headers are in either *Channel.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesChannelsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesChannelsReleasesCreateCall) Context(ctx context.Context) *ProjectsSitesChannelsReleasesCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesChannelsReleasesCreateCall) Do(opts ...googleapi.CallOption) (*Release, error)
Do executes the "firebasehosting.projects.sites.channels.releases.create" call. Any non-2xx status code is an error. Response headers are in either *Release.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesChannelsReleasesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 ProjectsSitesChannelsReleasesGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesChannelsReleasesGetCall) Context(ctx context.Context) *ProjectsSitesChannelsReleasesGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesChannelsReleasesGetCall) Do(opts ...googleapi.CallOption) (*Release, error)
Do executes the "firebasehosting.projects.sites.channels.releases.get" call. Any non-2xx status code is an error. Response headers are in either *Release.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesChannelsReleasesGetCall) Fields(s ...googleapi.Field) *ProjectsSitesChannelsReleasesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesChannelsReleasesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesChannelsReleasesGetCall) IfNoneMatch(entityTag string) *ProjectsSitesChannelsReleasesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsSitesChannelsReleasesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesChannelsReleasesListCall) Context(ctx context.Context) *ProjectsSitesChannelsReleasesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesChannelsReleasesListCall) Do(opts ...googleapi.CallOption) (*ListReleasesResponse, error)
Do executes the "firebasehosting.projects.sites.channels.releases.list" call. Any non-2xx status code is an error. Response headers are in either *ListReleasesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesChannelsReleasesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesChannelsReleasesListCall) IfNoneMatch(entityTag string) *ProjectsSitesChannelsReleasesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 struct {
// contains filtered or unexported fields
}
func NewProjectsSitesChannelsReleasesService(s *Service) *ProjectsSitesChannelsReleasesService
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).
func (r *ProjectsSitesChannelsReleasesService) Get(name string) *ProjectsSitesChannelsReleasesGetCall
Get: Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default `live` channel and any active preview channels for the specified site.
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.
type ProjectsSitesChannelsService struct {
Releases *ProjectsSitesChannelsReleasesService
// contains filtered or unexported fields
}
func NewProjectsSitesChannelsService(s *Service) *ProjectsSitesChannelsService
func (r *ProjectsSitesChannelsService) Create(parent string, channel *Channel) *ProjectsSitesChannelsCreateCall
Create: Creates a new channel in the specified site.
func (r *ProjectsSitesChannelsService) Delete(name string) *ProjectsSitesChannelsDeleteCall
Delete: Deletes the specified channel of the specified site. The `live` channel cannot be deleted.
func (r *ProjectsSitesChannelsService) Get(name string) *ProjectsSitesChannelsGetCall
Get: Retrieves information for the specified channel of the specified site.
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 (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.
type ProjectsSitesCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesCreateCall) Context(ctx context.Context) *ProjectsSitesCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesCreateCall) Do(opts ...googleapi.CallOption) (*Site, error)
Do executes the "firebasehosting.projects.sites.create" call. Any non-2xx status code is an error. Response headers are in either *Site.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (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.
func (c *ProjectsSitesCreateCall) ValidateOnly(validateOnly bool) *ProjectsSitesCreateCall
ValidateOnly sets the optional parameter "validateOnly": If set, validates that the site_id is available and that the request would succeed, returning the expected resulting site or error.
type ProjectsSitesCustomDomainsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesCustomDomainsCreateCall) Context(ctx context.Context) *ProjectsSitesCustomDomainsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesCustomDomainsCreateCall) CustomDomainId(customDomainId string) *ProjectsSitesCustomDomainsCreateCall
CustomDomainId sets the optional parameter "customDomainId": Required. The ID of the `CustomDomain`, which is the domain name you'd like to use with Firebase Hosting.
func (c *ProjectsSitesCustomDomainsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "firebasehosting.projects.sites.customDomains.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesCustomDomainsCreateCall) Fields(s ...googleapi.Field) *ProjectsSitesCustomDomainsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesCustomDomainsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesCustomDomainsCreateCall) ValidateOnly(validateOnly bool) *ProjectsSitesCustomDomainsCreateCall
ValidateOnly sets the optional parameter "validateOnly": If true, Hosting validates that it's possible to complete your request but doesn't actually create a new `CustomDomain`.
type ProjectsSitesCustomDomainsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesCustomDomainsDeleteCall) AllowMissing(allowMissing bool) *ProjectsSitesCustomDomainsDeleteCall
AllowMissing sets the optional parameter "allowMissing": If true, the request succeeds even if the `CustomDomain` doesn't exist.
func (c *ProjectsSitesCustomDomainsDeleteCall) Context(ctx context.Context) *ProjectsSitesCustomDomainsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesCustomDomainsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "firebasehosting.projects.sites.customDomains.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesCustomDomainsDeleteCall) Etag(etag string) *ProjectsSitesCustomDomainsDeleteCall
Etag sets the optional parameter "etag": A tag that represents the state of the `CustomDomain` as you know it. If present, the supplied tag must match the current value on your `CustomDomain`, or the request fails.
func (c *ProjectsSitesCustomDomainsDeleteCall) Fields(s ...googleapi.Field) *ProjectsSitesCustomDomainsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesCustomDomainsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesCustomDomainsDeleteCall) ValidateOnly(validateOnly bool) *ProjectsSitesCustomDomainsDeleteCall
ValidateOnly sets the optional parameter "validateOnly": If true, Hosting validates that it's possible to complete your request but doesn't actually delete the `CustomDomain`.
type ProjectsSitesCustomDomainsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesCustomDomainsGetCall) Context(ctx context.Context) *ProjectsSitesCustomDomainsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesCustomDomainsGetCall) Do(opts ...googleapi.CallOption) (*CustomDomain, error)
Do executes the "firebasehosting.projects.sites.customDomains.get" call. Any non-2xx status code is an error. Response headers are in either *CustomDomain.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesCustomDomainsGetCall) Fields(s ...googleapi.Field) *ProjectsSitesCustomDomainsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesCustomDomainsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesCustomDomainsGetCall) IfNoneMatch(entityTag string) *ProjectsSitesCustomDomainsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsSitesCustomDomainsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesCustomDomainsListCall) Context(ctx context.Context) *ProjectsSitesCustomDomainsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesCustomDomainsListCall) Do(opts ...googleapi.CallOption) (*ListCustomDomainsResponse, error)
Do executes the "firebasehosting.projects.sites.customDomains.list" call. Any non-2xx status code is an error. Response headers are in either *ListCustomDomainsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesCustomDomainsListCall) Fields(s ...googleapi.Field) *ProjectsSitesCustomDomainsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesCustomDomainsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesCustomDomainsListCall) IfNoneMatch(entityTag string) *ProjectsSitesCustomDomainsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsSitesCustomDomainsListCall) PageSize(pageSize int64) *ProjectsSitesCustomDomainsListCall
PageSize sets the optional parameter "pageSize": The max number of `CustomDomain` entities to return in a request. Defaults to 10.
func (c *ProjectsSitesCustomDomainsListCall) PageToken(pageToken string) *ProjectsSitesCustomDomainsListCall
PageToken sets the optional parameter "pageToken": A token from a previous call to `ListCustomDomains` that tells the server where to resume listing.
func (c *ProjectsSitesCustomDomainsListCall) Pages(ctx context.Context, f func(*ListCustomDomainsResponse) 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 (c *ProjectsSitesCustomDomainsListCall) ShowDeleted(showDeleted bool) *ProjectsSitesCustomDomainsListCall
ShowDeleted sets the optional parameter "showDeleted": If true, the request returns soft-deleted `CustomDomain`s that haven't been fully-deleted yet. To restore deleted `CustomDomain`s, make an `UndeleteCustomDomain` request.
type ProjectsSitesCustomDomainsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesCustomDomainsOperationsGetCall) Context(ctx context.Context) *ProjectsSitesCustomDomainsOperationsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesCustomDomainsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "firebasehosting.projects.sites.customDomains.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesCustomDomainsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsSitesCustomDomainsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesCustomDomainsOperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesCustomDomainsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsSitesCustomDomainsOperationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsSitesCustomDomainsOperationsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesCustomDomainsOperationsListCall) Context(ctx context.Context) *ProjectsSitesCustomDomainsOperationsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesCustomDomainsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "firebasehosting.projects.sites.customDomains.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesCustomDomainsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsSitesCustomDomainsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesCustomDomainsOperationsListCall) Filter(filter string) *ProjectsSitesCustomDomainsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (c *ProjectsSitesCustomDomainsOperationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesCustomDomainsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsSitesCustomDomainsOperationsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsSitesCustomDomainsOperationsListCall) PageSize(pageSize int64) *ProjectsSitesCustomDomainsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (c *ProjectsSitesCustomDomainsOperationsListCall) PageToken(pageToken string) *ProjectsSitesCustomDomainsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (c *ProjectsSitesCustomDomainsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) 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 ProjectsSitesCustomDomainsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsSitesCustomDomainsOperationsService(s *Service) *ProjectsSitesCustomDomainsOperationsService
func (r *ProjectsSitesCustomDomainsOperationsService) Get(name string) *ProjectsSitesCustomDomainsOperationsGetCall
Get: Gets the latest state of a long-running operation. Use this method to poll the operation result at intervals as recommended by the API service.
- name: The name of the operation resource.
func (r *ProjectsSitesCustomDomainsOperationsService) List(name string) *ProjectsSitesCustomDomainsOperationsListCall
List: Lists operations that match the specified filter in the request.
- name: The name of the operation's parent resource.
type ProjectsSitesCustomDomainsPatchCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesCustomDomainsPatchCall) AllowMissing(allowMissing bool) *ProjectsSitesCustomDomainsPatchCall
AllowMissing sets the optional parameter "allowMissing": If true, Hosting creates the `CustomDomain` if it doesn't already exist.
func (c *ProjectsSitesCustomDomainsPatchCall) Context(ctx context.Context) *ProjectsSitesCustomDomainsPatchCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesCustomDomainsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "firebasehosting.projects.sites.customDomains.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesCustomDomainsPatchCall) Fields(s ...googleapi.Field) *ProjectsSitesCustomDomainsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesCustomDomainsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesCustomDomainsPatchCall) UpdateMask(updateMask string) *ProjectsSitesCustomDomainsPatchCall
UpdateMask sets the optional parameter "updateMask": The set of field names from your `CustomDomain` that you want to update. A field will be overwritten if, and only if, it's in the mask. If you don't provide a mask, Hosting updates the entire `CustomDomain`.
func (c *ProjectsSitesCustomDomainsPatchCall) ValidateOnly(validateOnly bool) *ProjectsSitesCustomDomainsPatchCall
ValidateOnly sets the optional parameter "validateOnly": If true, Hosting validates that it's possible to complete your request but doesn't actually create or update the `CustomDomain`.
type ProjectsSitesCustomDomainsService struct {
Operations *ProjectsSitesCustomDomainsOperationsService
// contains filtered or unexported fields
}
func NewProjectsSitesCustomDomainsService(s *Service) *ProjectsSitesCustomDomainsService
func (r *ProjectsSitesCustomDomainsService) Create(parent string, customdomain *CustomDomain) *ProjectsSitesCustomDomainsCreateCall
Create: Creates a `CustomDomain`.
func (r *ProjectsSitesCustomDomainsService) Delete(name string) *ProjectsSitesCustomDomainsDeleteCall
Delete: Deletes the specified `CustomDomain`.
- name: The name of the `CustomDomain` to delete.
func (r *ProjectsSitesCustomDomainsService) Get(name string) *ProjectsSitesCustomDomainsGetCall
Get: Gets the specified `CustomDomain`.
- name: The name of the `CustomDomain` to get.
func (r *ProjectsSitesCustomDomainsService) List(parent string) *ProjectsSitesCustomDomainsListCall
List: Lists each `CustomDomain` associated with the specified parent Hosting site. Returns `CustomDomain`s in a consistent, but undefined, order to facilitate pagination.
func (r *ProjectsSitesCustomDomainsService) Patch(name string, customdomain *CustomDomain) *ProjectsSitesCustomDomainsPatchCall
Patch: Updates the specified `CustomDomain`.
- name: Output only. The fully-qualified name of the `CustomDomain`.
func (r *ProjectsSitesCustomDomainsService) Undelete(name string, undeletecustomdomainrequest *UndeleteCustomDomainRequest) *ProjectsSitesCustomDomainsUndeleteCall
Undelete: Undeletes the specified `CustomDomain` if it has been soft-deleted. Hosting retains soft-deleted custom domains for around 30 days before permanently deleting them.
- name: The name of the `CustomDomain` to delete.
type ProjectsSitesCustomDomainsUndeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesCustomDomainsUndeleteCall) Context(ctx context.Context) *ProjectsSitesCustomDomainsUndeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesCustomDomainsUndeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "firebasehosting.projects.sites.customDomains.undelete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesCustomDomainsUndeleteCall) Fields(s ...googleapi.Field) *ProjectsSitesCustomDomainsUndeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesCustomDomainsUndeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSitesDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesDeleteCall) Context(ctx context.Context) *ProjectsSitesDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "firebasehosting.projects.sites.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSitesDomainsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesDomainsCreateCall) Context(ctx context.Context) *ProjectsSitesDomainsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesDomainsCreateCall) Do(opts ...googleapi.CallOption) (*Domain, error)
Do executes the "firebasehosting.projects.sites.domains.create" call. Any non-2xx status code is an error. Response headers are in either *Domain.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesDomainsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSitesDomainsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesDomainsDeleteCall) Context(ctx context.Context) *ProjectsSitesDomainsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesDomainsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "firebasehosting.projects.sites.domains.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesDomainsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSitesDomainsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesDomainsGetCall) Context(ctx context.Context) *ProjectsSitesDomainsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesDomainsGetCall) Do(opts ...googleapi.CallOption) (*Domain, error)
Do executes the "firebasehosting.projects.sites.domains.get" call. Any non-2xx status code is an error. Response headers are in either *Domain.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesDomainsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesDomainsGetCall) IfNoneMatch(entityTag string) *ProjectsSitesDomainsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsSitesDomainsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesDomainsListCall) Context(ctx context.Context) *ProjectsSitesDomainsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesDomainsListCall) Do(opts ...googleapi.CallOption) (*ListDomainsResponse, error)
Do executes the "firebasehosting.projects.sites.domains.list" call. Any non-2xx status code is an error. Response headers are in either *ListDomainsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesDomainsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesDomainsListCall) IfNoneMatch(entityTag string) *ProjectsSitesDomainsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsSitesDomainsListCall) PageSize(pageSize int64) *ProjectsSitesDomainsListCall
PageSize sets the optional parameter "pageSize": The page size to return. Defaults to 50.
func (c *ProjectsSitesDomainsListCall) PageToken(pageToken string) *ProjectsSitesDomainsListCall
PageToken sets the optional parameter "pageToken": The next_page_token from a previous request, if provided.
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 struct {
// contains filtered or unexported fields
}
func NewProjectsSitesDomainsService(s *Service) *ProjectsSitesDomainsService
func (r *ProjectsSitesDomainsService) Create(parent string, domain *Domain) *ProjectsSitesDomainsCreateCall
Create: Creates a domain mapping on the specified site.
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 (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 (r *ProjectsSitesDomainsService) List(parent string) *ProjectsSitesDomainsListCall
List: Lists the domains for the specified site.
func (r *ProjectsSitesDomainsService) Update(name string, domain *Domain) *ProjectsSitesDomainsUpdateCall
Update: Updates the specified domain mapping, creating the mapping as if it does not exist.
type ProjectsSitesDomainsUpdateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesDomainsUpdateCall) Context(ctx context.Context) *ProjectsSitesDomainsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesDomainsUpdateCall) Do(opts ...googleapi.CallOption) (*Domain, error)
Do executes the "firebasehosting.projects.sites.domains.update" call. Any non-2xx status code is an error. Response headers are in either *Domain.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesDomainsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSitesGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesGetCall) Context(ctx context.Context) *ProjectsSitesGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesGetCall) Do(opts ...googleapi.CallOption) (*Site, error)
Do executes the "firebasehosting.projects.sites.get" call. Any non-2xx status code is an error. Response headers are in either *Site.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesGetCall) IfNoneMatch(entityTag string) *ProjectsSitesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsSitesGetConfigCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesGetConfigCall) Context(ctx context.Context) *ProjectsSitesGetConfigCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesGetConfigCall) Do(opts ...googleapi.CallOption) (*SiteConfig, error)
Do executes the "firebasehosting.projects.sites.getConfig" call. Any non-2xx status code is an error. Response headers are in either *SiteConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesGetConfigCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesGetConfigCall) IfNoneMatch(entityTag string) *ProjectsSitesGetConfigCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsSitesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesListCall) Context(ctx context.Context) *ProjectsSitesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesListCall) Do(opts ...googleapi.CallOption) (*ListSitesResponse, error)
Do executes the "firebasehosting.projects.sites.list" call. Any non-2xx status code is an error. Response headers are in either *ListSitesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesListCall) IfNoneMatch(entityTag string) *ProjectsSitesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesPatchCall) Context(ctx context.Context) *ProjectsSitesPatchCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesPatchCall) Do(opts ...googleapi.CallOption) (*Site, error)
Do executes the "firebasehosting.projects.sites.patch" call. Any non-2xx status code is an error. Response headers are in either *Site.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesReleasesCreateCall) Context(ctx context.Context) *ProjectsSitesReleasesCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesReleasesCreateCall) Do(opts ...googleapi.CallOption) (*Release, error)
Do executes the "firebasehosting.projects.sites.releases.create" call. Any non-2xx status code is an error. Response headers are in either *Release.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesReleasesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 ProjectsSitesReleasesGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesReleasesGetCall) Context(ctx context.Context) *ProjectsSitesReleasesGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesReleasesGetCall) Do(opts ...googleapi.CallOption) (*Release, error)
Do executes the "firebasehosting.projects.sites.releases.get" call. Any non-2xx status code is an error. Response headers are in either *Release.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesReleasesGetCall) Fields(s ...googleapi.Field) *ProjectsSitesReleasesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesReleasesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesReleasesGetCall) IfNoneMatch(entityTag string) *ProjectsSitesReleasesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsSitesReleasesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesReleasesListCall) Context(ctx context.Context) *ProjectsSitesReleasesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesReleasesListCall) Do(opts ...googleapi.CallOption) (*ListReleasesResponse, error)
Do executes the "firebasehosting.projects.sites.releases.list" call. Any non-2xx status code is an error. Response headers are in either *ListReleasesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesReleasesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesReleasesListCall) IfNoneMatch(entityTag string) *ProjectsSitesReleasesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 struct {
// contains filtered or unexported fields
}
func NewProjectsSitesReleasesService(s *Service) *ProjectsSitesReleasesService
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).
func (r *ProjectsSitesReleasesService) Get(name string) *ProjectsSitesReleasesGetCall
Get: Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default `live` channel and any active preview channels for the specified site.
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.
type ProjectsSitesService struct {
Channels *ProjectsSitesChannelsService
CustomDomains *ProjectsSitesCustomDomainsService
Domains *ProjectsSitesDomainsService
Releases *ProjectsSitesReleasesService
Versions *ProjectsSitesVersionsService
// contains filtered or unexported fields
}
func NewProjectsSitesService(s *Service) *ProjectsSitesService
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.
func (r *ProjectsSitesService) Delete(name string) *ProjectsSitesDeleteCall
Delete: Deletes the specified Hosting Site from the specified parent Firebase project.
func (r *ProjectsSitesService) Get(nameid string) *ProjectsSitesGetCall
Get: Gets the specified Hosting Site.
func (r *ProjectsSitesService) GetConfig(name string) *ProjectsSitesGetConfigCall
GetConfig: Gets the Hosting metadata for a specific site.
func (r *ProjectsSitesService) List(parent string) *ProjectsSitesListCall
List: Lists each Hosting Site associated with the specified parent Firebase project.
func (r *ProjectsSitesService) Patch(nameid string, site *Site) *ProjectsSitesPatchCall
Patch: Updates attributes of the specified Hosting Site.
func (r *ProjectsSitesService) UpdateConfig(name string, siteconfig *SiteConfig) *ProjectsSitesUpdateConfigCall
UpdateConfig: Sets the Hosting metadata for a specific site.
type ProjectsSitesUpdateConfigCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesUpdateConfigCall) Context(ctx context.Context) *ProjectsSitesUpdateConfigCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesUpdateConfigCall) Do(opts ...googleapi.CallOption) (*SiteConfig, error)
Do executes the "firebasehosting.projects.sites.updateConfig" call. Any non-2xx status code is an error. Response headers are in either *SiteConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesUpdateConfigCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesVersionsCloneCall) Context(ctx context.Context) *ProjectsSitesVersionsCloneCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesVersionsCloneCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "firebasehosting.projects.sites.versions.clone" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesVersionsCloneCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSitesVersionsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesVersionsCreateCall) Context(ctx context.Context) *ProjectsSitesVersionsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesVersionsCreateCall) Do(opts ...googleapi.CallOption) (*Version, error)
Do executes the "firebasehosting.projects.sites.versions.create" call. Any non-2xx status code is an error. Response headers are in either *Version.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesVersionsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 (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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesVersionsDeleteCall) Context(ctx context.Context) *ProjectsSitesVersionsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesVersionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "firebasehosting.projects.sites.versions.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesVersionsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSitesVersionsFilesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesVersionsFilesListCall) Context(ctx context.Context) *ProjectsSitesVersionsFilesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesVersionsFilesListCall) Do(opts ...googleapi.CallOption) (*ListVersionFilesResponse, error)
Do executes the "firebasehosting.projects.sites.versions.files.list" call. Any non-2xx status code is an error. Response headers are in either *ListVersionFilesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesVersionsFilesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesVersionsFilesListCall) IfNoneMatch(entityTag string) *ProjectsSitesVersionsFilesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 (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 struct {
// contains filtered or unexported fields
}
func NewProjectsSitesVersionsFilesService(s *Service) *ProjectsSitesVersionsFilesService
func (r *ProjectsSitesVersionsFilesService) List(parent string) *ProjectsSitesVersionsFilesListCall
List: Lists the remaining files to be uploaded for the specified version.
type ProjectsSitesVersionsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesVersionsGetCall) Context(ctx context.Context) *ProjectsSitesVersionsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesVersionsGetCall) Do(opts ...googleapi.CallOption) (*Version, error)
Do executes the "firebasehosting.projects.sites.versions.get" call. Any non-2xx status code is an error. Response headers are in either *Version.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsSitesVersionsGetCall) Fields(s ...googleapi.Field) *ProjectsSitesVersionsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsSitesVersionsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesVersionsGetCall) IfNoneMatch(entityTag string) *ProjectsSitesVersionsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsSitesVersionsListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesVersionsListCall) Context(ctx context.Context) *ProjectsSitesVersionsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesVersionsListCall) Do(opts ...googleapi.CallOption) (*ListVersionsResponse, error)
Do executes the "firebasehosting.projects.sites.versions.list" call. Any non-2xx status code is an error. Response headers are in either *ListVersionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
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 (c *ProjectsSitesVersionsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsSitesVersionsListCall) IfNoneMatch(entityTag string) *ProjectsSitesVersionsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesVersionsPatchCall) Context(ctx context.Context) *ProjectsSitesVersionsPatchCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesVersionsPatchCall) Do(opts ...googleapi.CallOption) (*Version, error)
Do executes the "firebasehosting.projects.sites.versions.patch" call. Any non-2xx status code is an error. Response headers are in either *Version.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesVersionsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsSitesVersionsPopulateFilesCall) Context(ctx context.Context) *ProjectsSitesVersionsPopulateFilesCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsSitesVersionsPopulateFilesCall) Do(opts ...googleapi.CallOption) (*PopulateVersionFilesResponse, error)
Do executes the "firebasehosting.projects.sites.versions.populateFiles" call. Any non-2xx status code is an error. Response headers are in either *PopulateVersionFilesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *ProjectsSitesVersionsPopulateFilesCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsSitesVersionsService struct {
Files *ProjectsSitesVersionsFilesService
// contains filtered or unexported fields
}
func NewProjectsSitesVersionsService(s *Service) *ProjectsSitesVersionsService
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.
func (r *ProjectsSitesVersionsService) Create(parent string, version *Version) *ProjectsSitesVersionsCreateCall
Create: Creates a new version for the specified site.
func (r *ProjectsSitesVersionsService) Delete(name string) *ProjectsSitesVersionsDeleteCall
Delete: Deletes the specified version.
func (r *ProjectsSitesVersionsService) Get(name string) *ProjectsSitesVersionsGetCall
Get: Get the specified version that has been created for the specified site. This can include versions that were created for the default `live` channel or for any active preview channels for the specified site.
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.
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`.
func (r *ProjectsSitesVersionsService) PopulateFiles(parent string, populateversionfilesrequest *PopulateVersionFilesRequest) *ProjectsSitesVersionsPopulateFilesCall
PopulateFiles: Adds content files to the specified version. Each file must be under 2 GB.
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.
type Redirect struct {
// Glob: The user-supplied glob
// (https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching)
// to match against the request URL path.
Glob string `json:"glob,omitempty"`
// Location: Required. The value to put in the HTTP location header of the
// response. The location can contain capture group values from the pattern
// using a `:` prefix to identify the segment and an optional `*` to capture
// the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301,
// "location": "https://example.com/foo/:capture"
Location string `json:"location,omitempty"`
// Regex: The user-supplied RE2 regular expression to match against the request
// URL path.
Regex string `json:"regex,omitempty"`
// StatusCode: Required. The status HTTP code to return in the response. It
// must be a valid 3xx status code.
StatusCode int64 `json:"statusCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "Glob") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Glob") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Redirect) MarshalJSON() ([]byte, error)
Release: A `Release` is a particular collection of configurations and files (sites.versions) that is set to be public at a particular time.
type Release struct {
// Message: The deploy description when the release was created. The value can
// be up to 512 characters.
Message string `json:"message,omitempty"`
// Name: Output only. The unique identifier for the release, in either of the
// following formats: - sites/SITE_ID/releases/RELEASE_ID -
// sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided
// in the response body when you call `releases.create` (sites.releases/create)
// or `channels.releases.create` (sites.channels.releases/create).
Name string `json:"name,omitempty"`
// ReleaseTime: Output only. The time at which the version is set to be public.
ReleaseTime string `json:"releaseTime,omitempty"`
// ReleaseUser: Output only. Identifies the user who created the release.
ReleaseUser *ActingUser `json:"releaseUser,omitempty"`
// Type: Explains the reason for the release. Specify a value for this field
// only when creating a `SITE_DISABLE` type release.
//
// Possible values:
// "TYPE_UNSPECIFIED" - An unspecified type. Indicates that a version was
// released. This is the default value when no other `type` is explicitly
// specified.
// "DEPLOY" - A version was uploaded to Firebase Hosting and released.
// "ROLLBACK" - The release points back to a previously deployed version.
// "SITE_DISABLE" - The release prevents the site from serving content.
// Firebase Hosting acts as if the site never existed.
Type string `json:"type,omitempty"`
// Version: Output only. The configuration and content that was released.
Version *Version `json:"version,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Message") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Message") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Release) MarshalJSON() ([]byte, error)
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.
type Rewrite struct {
// DynamicLinks: The request will be forwarded to Firebase Dynamic Links.
DynamicLinks bool `json:"dynamicLinks,omitempty"`
// Function: The function to proxy requests to. Must match the exported
// function name exactly.
Function string `json:"function,omitempty"`
// FunctionRegion: Optional. Specify a Cloud region for rewritten Functions
// invocations. If not provided, defaults to us-central1.
FunctionRegion string `json:"functionRegion,omitempty"`
// Glob: The user-supplied glob
// (https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching)
// to match against the request URL path.
Glob string `json:"glob,omitempty"`
// Path: The URL path to rewrite the request to.
Path string `json:"path,omitempty"`
// Regex: The user-supplied RE2 regular expression to match against the request
// URL path.
Regex string `json:"regex,omitempty"`
// Run: The request will be forwarded to Cloud Run.
Run *CloudRunRewrite `json:"run,omitempty"`
// ForceSendFields is a list of field names (e.g. "DynamicLinks") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DynamicLinks") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Rewrite) MarshalJSON() ([]byte, error)
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(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(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
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).
type ServingConfig struct {
// AppAssociation: How to handle well known App Association files.
//
// Possible values:
// "AUTO" - The app association files will be automatically created from the
// apps that exist in the Firebase project.
// "NONE" - No special handling of the app association files will occur,
// these paths will result in a 404 unless caught with a Rewrite.
AppAssociation string `json:"appAssociation,omitempty"`
// CleanUrls: Defines whether to drop the file extension from uploaded files.
CleanUrls bool `json:"cleanUrls,omitempty"`
// Headers: An array of objects, where each object specifies a URL pattern
// that, if matched to the request URL path, triggers Hosting to apply the
// specified custom response headers.
Headers []*Header `json:"headers,omitempty"`
// I18n: Optional. Defines i18n rewrite behavior.
I18n *I18nConfig `json:"i18n,omitempty"`
// Redirects: An array of objects (called redirect rules), where each rule
// specifies a URL pattern that, if matched to the request URL path, triggers
// Hosting to respond with a redirect to the specified destination path.
Redirects []*Redirect `json:"redirects,omitempty"`
// Rewrites: An array of objects (called rewrite rules), where each rule
// specifies a URL pattern that, if matched to the request URL path, triggers
// Hosting to respond as if the service were given the specified destination
// URL.
Rewrites []*Rewrite `json:"rewrites,omitempty"`
// TrailingSlashBehavior: Defines how to handle a trailing slash in the URL
// path.
//
// Possible values:
// "TRAILING_SLASH_BEHAVIOR_UNSPECIFIED" - No behavior is specified. Files
// are served at their exact location only, and trailing slashes are only added
// to directory indexes.
// "ADD" - Trailing slashes are _added_ to directory indexes as well as to
// any URL path not ending in a file extension.
// "REMOVE" - Trailing slashes are _removed_ from directory indexes as well
// as from any URL path not ending in a file extension.
TrailingSlashBehavior string `json:"trailingSlashBehavior,omitempty"`
// ForceSendFields is a list of field names (e.g. "AppAssociation") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AppAssociation") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ServingConfig) MarshalJSON() ([]byte, error)
Site: A `Site` represents a Firebase Hosting site.
type Site struct {
// AppId: Optional. The ID of a Web App
// (https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id)
// associated with the Hosting site.
AppId string `json:"appId,omitempty"`
// DefaultUrl: Output only. The default URL for the Hosting site.
DefaultUrl string `json:"defaultUrl,omitempty"`
// Labels: Optional. User-specified labels for the Hosting site.
Labels map[string]string `json:"labels,omitempty"`
// Name: Output only. The fully-qualified resource name of the Hosting site, in
// the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER:
// the Firebase project's `ProjectNumber`
// (https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number)
// ***(recommended)*** or its `ProjectId`
// (https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id).
// Learn more about using project identifiers in Google's AIP 2510 standard
// (https://google.aip.dev/cloud/2510).
Name string `json:"name,omitempty"`
// Type: Output only. The type of Hosting site. Every Firebase project has a
// `DEFAULT_SITE`, which is created when Hosting is provisioned for the
// project. All additional sites are `USER_SITE`.
//
// Possible values:
// "TYPE_UNSPECIFIED" - Unknown state, likely the result of an error on the
// backend.
// "DEFAULT_SITE" - The default Hosting site that is provisioned when a
// Firebase project is created.
// "USER_SITE" - A Hosting site that the user created.
Type string `json:"type,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AppId") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AppId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Site) MarshalJSON() ([]byte, error)
SiteConfig: A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior
type SiteConfig struct {
// CloudLoggingEnabled: Whether or not web requests made by site visitors are
// logged via Cloud Logging.
CloudLoggingEnabled bool `json:"cloudLoggingEnabled,omitempty"`
// MaxVersions: The number of FINALIZED versions that will be held for a site
// before automatic deletion. When a new version is deployed, content for
// versions in storage in excess of this number will be deleted, and will no
// longer be billed for storage usage. Oldest versions will be deleted first;
// sites are created with an unlimited number of max_versions by default.
MaxVersions int64 `json:"maxVersions,omitempty,string"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CloudLoggingEnabled") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CloudLoggingEnabled") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SiteConfig) MarshalJSON() ([]byte, error)
type SitesChannelsCreateCall struct {
// contains filtered or unexported fields
}
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 (c *SitesChannelsCreateCall) Context(ctx context.Context) *SitesChannelsCreateCall
Context sets the context to be used in this call's Do method.
func (c *SitesChannelsCreateCall) Do(opts ...googleapi.CallOption) (*Channel, error)
Do executes the "firebasehosting.sites.channels.create" call. Any non-2xx status code is an error. Response headers are in either *Channel.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesChannelsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SitesChannelsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *SitesChannelsDeleteCall) Context(ctx context.Context) *SitesChannelsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *SitesChannelsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "firebasehosting.sites.channels.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesChannelsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SitesChannelsGetCall struct {
// contains filtered or unexported fields
}
func (c *SitesChannelsGetCall) Context(ctx context.Context) *SitesChannelsGetCall
Context sets the context to be used in this call's Do method.
func (c *SitesChannelsGetCall) Do(opts ...googleapi.CallOption) (*Channel, error)
Do executes the "firebasehosting.sites.channels.get" call. Any non-2xx status code is an error. Response headers are in either *Channel.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesChannelsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesChannelsGetCall) IfNoneMatch(entityTag string) *SitesChannelsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type SitesChannelsListCall struct {
// contains filtered or unexported fields
}
func (c *SitesChannelsListCall) Context(ctx context.Context) *SitesChannelsListCall
Context sets the context to be used in this call's Do method.
func (c *SitesChannelsListCall) Do(opts ...googleapi.CallOption) (*ListChannelsResponse, error)
Do executes the "firebasehosting.sites.channels.list" call. Any non-2xx status code is an error. Response headers are in either *ListChannelsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesChannelsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesChannelsListCall) IfNoneMatch(entityTag string) *SitesChannelsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *SitesChannelsPatchCall) Context(ctx context.Context) *SitesChannelsPatchCall
Context sets the context to be used in this call's Do method.
func (c *SitesChannelsPatchCall) Do(opts ...googleapi.CallOption) (*Channel, error)
Do executes the "firebasehosting.sites.channels.patch" call. Any non-2xx status code is an error. Response headers are in either *Channel.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesChannelsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (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 struct {
// contains filtered or unexported fields
}
func (c *SitesChannelsReleasesCreateCall) Context(ctx context.Context) *SitesChannelsReleasesCreateCall
Context sets the context to be used in this call's Do method.
func (c *SitesChannelsReleasesCreateCall) Do(opts ...googleapi.CallOption) (*Release, error)
Do executes the "firebasehosting.sites.channels.releases.create" call. Any non-2xx status code is an error. Response headers are in either *Release.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesChannelsReleasesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 SitesChannelsReleasesGetCall struct {
// contains filtered or unexported fields
}
func (c *SitesChannelsReleasesGetCall) Context(ctx context.Context) *SitesChannelsReleasesGetCall
Context sets the context to be used in this call's Do method.
func (c *SitesChannelsReleasesGetCall) Do(opts ...googleapi.CallOption) (*Release, error)
Do executes the "firebasehosting.sites.channels.releases.get" call. Any non-2xx status code is an error. Response headers are in either *Release.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SitesChannelsReleasesGetCall) Fields(s ...googleapi.Field) *SitesChannelsReleasesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SitesChannelsReleasesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesChannelsReleasesGetCall) IfNoneMatch(entityTag string) *SitesChannelsReleasesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type SitesChannelsReleasesListCall struct {
// contains filtered or unexported fields
}
func (c *SitesChannelsReleasesListCall) Context(ctx context.Context) *SitesChannelsReleasesListCall
Context sets the context to be used in this call's Do method.
func (c *SitesChannelsReleasesListCall) Do(opts ...googleapi.CallOption) (*ListReleasesResponse, error)
Do executes the "firebasehosting.sites.channels.releases.list" call. Any non-2xx status code is an error. Response headers are in either *ListReleasesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesChannelsReleasesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesChannelsReleasesListCall) IfNoneMatch(entityTag string) *SitesChannelsReleasesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 struct {
// contains filtered or unexported fields
}
func NewSitesChannelsReleasesService(s *Service) *SitesChannelsReleasesService
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).
func (r *SitesChannelsReleasesService) Get(name string) *SitesChannelsReleasesGetCall
Get: Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default `live` channel and any active preview channels for the specified site.
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.
type SitesChannelsService struct {
Releases *SitesChannelsReleasesService
// contains filtered or unexported fields
}
func NewSitesChannelsService(s *Service) *SitesChannelsService
func (r *SitesChannelsService) Create(parent string, channel *Channel) *SitesChannelsCreateCall
Create: Creates a new channel in the specified site.
func (r *SitesChannelsService) Delete(name string) *SitesChannelsDeleteCall
Delete: Deletes the specified channel of the specified site. The `live` channel cannot be deleted.
func (r *SitesChannelsService) Get(name string) *SitesChannelsGetCall
Get: Retrieves information for the specified channel of the specified site.
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 (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.
type SitesDomainsCreateCall struct {
// contains filtered or unexported fields
}
func (c *SitesDomainsCreateCall) Context(ctx context.Context) *SitesDomainsCreateCall
Context sets the context to be used in this call's Do method.
func (c *SitesDomainsCreateCall) Do(opts ...googleapi.CallOption) (*Domain, error)
Do executes the "firebasehosting.sites.domains.create" call. Any non-2xx status code is an error. Response headers are in either *Domain.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesDomainsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SitesDomainsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *SitesDomainsDeleteCall) Context(ctx context.Context) *SitesDomainsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *SitesDomainsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "firebasehosting.sites.domains.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesDomainsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SitesDomainsGetCall struct {
// contains filtered or unexported fields
}
func (c *SitesDomainsGetCall) Context(ctx context.Context) *SitesDomainsGetCall
Context sets the context to be used in this call's Do method.
func (c *SitesDomainsGetCall) Do(opts ...googleapi.CallOption) (*Domain, error)
Do executes the "firebasehosting.sites.domains.get" call. Any non-2xx status code is an error. Response headers are in either *Domain.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesDomainsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesDomainsGetCall) IfNoneMatch(entityTag string) *SitesDomainsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type SitesDomainsListCall struct {
// contains filtered or unexported fields
}
func (c *SitesDomainsListCall) Context(ctx context.Context) *SitesDomainsListCall
Context sets the context to be used in this call's Do method.
func (c *SitesDomainsListCall) Do(opts ...googleapi.CallOption) (*ListDomainsResponse, error)
Do executes the "firebasehosting.sites.domains.list" call. Any non-2xx status code is an error. Response headers are in either *ListDomainsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesDomainsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesDomainsListCall) IfNoneMatch(entityTag string) *SitesDomainsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *SitesDomainsListCall) PageSize(pageSize int64) *SitesDomainsListCall
PageSize sets the optional parameter "pageSize": The page size to return. Defaults to 50.
func (c *SitesDomainsListCall) PageToken(pageToken string) *SitesDomainsListCall
PageToken sets the optional parameter "pageToken": The next_page_token from a previous request, if provided.
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 struct {
// contains filtered or unexported fields
}
func NewSitesDomainsService(s *Service) *SitesDomainsService
func (r *SitesDomainsService) Create(parent string, domain *Domain) *SitesDomainsCreateCall
Create: Creates a domain mapping on the specified site.
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 (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 (r *SitesDomainsService) List(parent string) *SitesDomainsListCall
List: Lists the domains for the specified site.
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 struct {
// contains filtered or unexported fields
}
func (c *SitesDomainsUpdateCall) Context(ctx context.Context) *SitesDomainsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *SitesDomainsUpdateCall) Do(opts ...googleapi.CallOption) (*Domain, error)
Do executes the "firebasehosting.sites.domains.update" call. Any non-2xx status code is an error. Response headers are in either *Domain.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesDomainsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SitesGetConfigCall struct {
// contains filtered or unexported fields
}
func (c *SitesGetConfigCall) Context(ctx context.Context) *SitesGetConfigCall
Context sets the context to be used in this call's Do method.
func (c *SitesGetConfigCall) Do(opts ...googleapi.CallOption) (*SiteConfig, error)
Do executes the "firebasehosting.sites.getConfig" call. Any non-2xx status code is an error. Response headers are in either *SiteConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesGetConfigCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesGetConfigCall) IfNoneMatch(entityTag string) *SitesGetConfigCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type SitesReleasesCreateCall struct {
// contains filtered or unexported fields
}
func (c *SitesReleasesCreateCall) Context(ctx context.Context) *SitesReleasesCreateCall
Context sets the context to be used in this call's Do method.
func (c *SitesReleasesCreateCall) Do(opts ...googleapi.CallOption) (*Release, error)
Do executes the "firebasehosting.sites.releases.create" call. Any non-2xx status code is an error. Response headers are in either *Release.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesReleasesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesReleasesCreateCall) VersionName(versionName string) *SitesReleasesCreateCall
VersionName sets the optional parameter "versionName": The unique identifier for a version, in the format: sites/SITE_ID/versions/ VERSION_ID The SITE_ID in this version identifier must match the SITE_ID in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.
type SitesReleasesGetCall struct {
// contains filtered or unexported fields
}
func (c *SitesReleasesGetCall) Context(ctx context.Context) *SitesReleasesGetCall
Context sets the context to be used in this call's Do method.
func (c *SitesReleasesGetCall) Do(opts ...googleapi.CallOption) (*Release, error)
Do executes the "firebasehosting.sites.releases.get" call. Any non-2xx status code is an error. Response headers are in either *Release.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SitesReleasesGetCall) Fields(s ...googleapi.Field) *SitesReleasesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SitesReleasesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesReleasesGetCall) IfNoneMatch(entityTag string) *SitesReleasesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type SitesReleasesListCall struct {
// contains filtered or unexported fields
}
func (c *SitesReleasesListCall) Context(ctx context.Context) *SitesReleasesListCall
Context sets the context to be used in this call's Do method.
func (c *SitesReleasesListCall) Do(opts ...googleapi.CallOption) (*ListReleasesResponse, error)
Do executes the "firebasehosting.sites.releases.list" call. Any non-2xx status code is an error. Response headers are in either *ListReleasesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesReleasesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesReleasesListCall) IfNoneMatch(entityTag string) *SitesReleasesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 struct {
// contains filtered or unexported fields
}
func NewSitesReleasesService(s *Service) *SitesReleasesService
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).
func (r *SitesReleasesService) Get(name string) *SitesReleasesGetCall
Get: Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default `live` channel and any active preview channels for the specified site.
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.
type SitesService struct {
Channels *SitesChannelsService
Domains *SitesDomainsService
Releases *SitesReleasesService
Versions *SitesVersionsService
// contains filtered or unexported fields
}
func NewSitesService(s *Service) *SitesService
func (r *SitesService) GetConfig(name string) *SitesGetConfigCall
GetConfig: Gets the Hosting metadata for a specific site.
func (r *SitesService) UpdateConfig(name string, siteconfig *SiteConfig) *SitesUpdateConfigCall
UpdateConfig: Sets the Hosting metadata for a specific site.
type SitesUpdateConfigCall struct {
// contains filtered or unexported fields
}
func (c *SitesUpdateConfigCall) Context(ctx context.Context) *SitesUpdateConfigCall
Context sets the context to be used in this call's Do method.
func (c *SitesUpdateConfigCall) Do(opts ...googleapi.CallOption) (*SiteConfig, error)
Do executes the "firebasehosting.sites.updateConfig" call. Any non-2xx status code is an error. Response headers are in either *SiteConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesUpdateConfigCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (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 struct {
// contains filtered or unexported fields
}
func (c *SitesVersionsCloneCall) Context(ctx context.Context) *SitesVersionsCloneCall
Context sets the context to be used in this call's Do method.
func (c *SitesVersionsCloneCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "firebasehosting.sites.versions.clone" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesVersionsCloneCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SitesVersionsCreateCall struct {
// contains filtered or unexported fields
}
func (c *SitesVersionsCreateCall) Context(ctx context.Context) *SitesVersionsCreateCall
Context sets the context to be used in this call's Do method.
func (c *SitesVersionsCreateCall) Do(opts ...googleapi.CallOption) (*Version, error)
Do executes the "firebasehosting.sites.versions.create" call. Any non-2xx status code is an error. Response headers are in either *Version.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesVersionsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (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 (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 struct {
// contains filtered or unexported fields
}
func (c *SitesVersionsDeleteCall) Context(ctx context.Context) *SitesVersionsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *SitesVersionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "firebasehosting.sites.versions.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesVersionsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SitesVersionsFilesListCall struct {
// contains filtered or unexported fields
}
func (c *SitesVersionsFilesListCall) Context(ctx context.Context) *SitesVersionsFilesListCall
Context sets the context to be used in this call's Do method.
func (c *SitesVersionsFilesListCall) Do(opts ...googleapi.CallOption) (*ListVersionFilesResponse, error)
Do executes the "firebasehosting.sites.versions.files.list" call. Any non-2xx status code is an error. Response headers are in either *ListVersionFilesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesVersionsFilesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesVersionsFilesListCall) IfNoneMatch(entityTag string) *SitesVersionsFilesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 (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 struct {
// contains filtered or unexported fields
}
func NewSitesVersionsFilesService(s *Service) *SitesVersionsFilesService
func (r *SitesVersionsFilesService) List(parent string) *SitesVersionsFilesListCall
List: Lists the remaining files to be uploaded for the specified version.
type SitesVersionsGetCall struct {
// contains filtered or unexported fields
}
func (c *SitesVersionsGetCall) Context(ctx context.Context) *SitesVersionsGetCall
Context sets the context to be used in this call's Do method.
func (c *SitesVersionsGetCall) Do(opts ...googleapi.CallOption) (*Version, error)
Do executes the "firebasehosting.sites.versions.get" call. Any non-2xx status code is an error. Response headers are in either *Version.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SitesVersionsGetCall) Fields(s ...googleapi.Field) *SitesVersionsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SitesVersionsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesVersionsGetCall) IfNoneMatch(entityTag string) *SitesVersionsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type SitesVersionsListCall struct {
// contains filtered or unexported fields
}
func (c *SitesVersionsListCall) Context(ctx context.Context) *SitesVersionsListCall
Context sets the context to be used in this call's Do method.
func (c *SitesVersionsListCall) Do(opts ...googleapi.CallOption) (*ListVersionsResponse, error)
Do executes the "firebasehosting.sites.versions.list" call. Any non-2xx status code is an error. Response headers are in either *ListVersionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
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 (c *SitesVersionsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SitesVersionsListCall) IfNoneMatch(entityTag string) *SitesVersionsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *SitesVersionsPatchCall) Context(ctx context.Context) *SitesVersionsPatchCall
Context sets the context to be used in this call's Do method.
func (c *SitesVersionsPatchCall) Do(opts ...googleapi.CallOption) (*Version, error)
Do executes the "firebasehosting.sites.versions.patch" call. Any non-2xx status code is an error. Response headers are in either *Version.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesVersionsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (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 struct {
// contains filtered or unexported fields
}
func (c *SitesVersionsPopulateFilesCall) Context(ctx context.Context) *SitesVersionsPopulateFilesCall
Context sets the context to be used in this call's Do method.
func (c *SitesVersionsPopulateFilesCall) Do(opts ...googleapi.CallOption) (*PopulateVersionFilesResponse, error)
Do executes the "firebasehosting.sites.versions.populateFiles" call. Any non-2xx status code is an error. Response headers are in either *PopulateVersionFilesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (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 details.
func (c *SitesVersionsPopulateFilesCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SitesVersionsService struct {
Files *SitesVersionsFilesService
// contains filtered or unexported fields
}
func NewSitesVersionsService(s *Service) *SitesVersionsService
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.
func (r *SitesVersionsService) Create(parent string, version *Version) *SitesVersionsCreateCall
Create: Creates a new version for the specified site.
func (r *SitesVersionsService) Delete(name string) *SitesVersionsDeleteCall
Delete: Deletes the specified version.
func (r *SitesVersionsService) Get(name string) *SitesVersionsGetCall
Get: Get the specified version that has been created for the specified site. This can include versions that were created for the default `live` channel or for any active preview channels for the specified site.
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.
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`.
func (r *SitesVersionsService) PopulateFiles(parent string, populateversionfilesrequest *PopulateVersionFilesRequest) *SitesVersionsPopulateFilesCall
PopulateFiles: Adds content files to the specified version. Each file must be under 2 GB.
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (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).
type Status struct {
// Code: The status code, which should be an enum value of google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There is a common
// set of message types for APIs to use.
Details []googleapi.RawMessage `json:"details,omitempty"`
// Message: A developer-facing error message, which should be in English. Any
// user-facing error message should be localized and sent in the
// google.rpc.Status.details field, or localized by the client.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error)
UndeleteCustomDomainRequest: The request sent to `UndeleteCustomDomain`.
type UndeleteCustomDomainRequest struct {
// Etag: A tag that represents the state of the `CustomDomain` as you know it.
// If present, the supplied tag must match the current value on your
// `CustomDomain`, or the request fails.
Etag string `json:"etag,omitempty"`
// ValidateOnly: If true, Hosting validates that it's possible to complete your
// request but doesn't actually delete the `CustomDomain`.
ValidateOnly bool `json:"validateOnly,omitempty"`
// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Etag") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UndeleteCustomDomainRequest) MarshalJSON() ([]byte, error)
Version: A `Version` is a configuration and a collection of static files which determine how a site is displayed.
type Version struct {
// Config: The configuration for the behavior of the site. This configuration
// exists in the `firebase.json`
// (https://firebase.google.com/docs/cli/#the_firebasejson_file) file.
Config *ServingConfig `json:"config,omitempty"`
// CreateTime: Output only. The time at which the version was created.
CreateTime string `json:"createTime,omitempty"`
// CreateUser: Output only. Identifies the user who created the version.
CreateUser *ActingUser `json:"createUser,omitempty"`
// DeleteTime: Output only. The time at which the version was `DELETED`.
DeleteTime string `json:"deleteTime,omitempty"`
// DeleteUser: Output only. Identifies the user who `DELETED` the version.
DeleteUser *ActingUser `json:"deleteUser,omitempty"`
// FileCount: Output only. The total number of files associated with the
// version. This value is calculated after a version is `FINALIZED`.
FileCount int64 `json:"fileCount,omitempty,string"`
// FinalizeTime: Output only. The time at which the version was `FINALIZED`.
FinalizeTime string `json:"finalizeTime,omitempty"`
// FinalizeUser: Output only. Identifies the user who `FINALIZED` the version.
FinalizeUser *ActingUser `json:"finalizeUser,omitempty"`
// Labels: The labels used for extra metadata and/or filtering.
Labels map[string]string `json:"labels,omitempty"`
// Name: The fully-qualified resource name for the version, in the format:
// sites/ SITE_ID/versions/VERSION_ID This name is provided in the response
// body when you call `CreateVersion` (sites.versions/create).
Name string `json:"name,omitempty"`
// Status: The deploy status of the version. For a successful deploy, call
// `CreateVersion` (sites.versions/create) to make a new version (`CREATED`
// status), upload all desired files (sites.versions/populateFiles) to the
// version, then update (sites.versions/patch) the version to the `FINALIZED`
// status. Note that if you leave the version in the `CREATED` state for more
// than 12 hours, the system will automatically mark the version as
// `ABANDONED`. You can also change the status of a version to `DELETED` by
// calling `DeleteVersion` (sites.versions/delete).
//
// Possible values:
// "VERSION_STATUS_UNSPECIFIED" - The default status; should not be
// intentionally used.
// "CREATED" - The version has been created, and content is currently being
// added to the version.
// "FINALIZED" - All content has been added to the version, and the version
// can no longer be changed.
// "DELETED" - The version has been deleted.
// "ABANDONED" - The version was not updated to `FINALIZED` within 12 hours
// and was automatically deleted.
// "EXPIRED" - The version is outside the site-configured limit for the
// number of retained versions, so the version's content is scheduled for
// deletion.
// "CLONING" - The version is being cloned from another version. All content
// is still being copied over.
Status string `json:"status,omitempty"`
// VersionBytes: Output only. The total stored bytesize of the version. This
// value is calculated after a version is `FINALIZED`.
VersionBytes int64 `json:"versionBytes,omitempty,string"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Config") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Config") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Version) MarshalJSON() ([]byte, error)
VersionFile: A static content file that is part of a version.
type VersionFile struct {
// Hash: The SHA256 content hash of the file.
Hash string `json:"hash,omitempty"`
// Path: The URI at which the file's content should display.
Path string `json:"path,omitempty"`
// Status: Output only. The current status of a particular file in the
// specified version. The value will be either `pending upload` or `uploaded`.
//
// Possible values:
// "STATUS_UNSPECIFIED" - The default status; should not be intentionally
// used.
// "EXPECTED" - The file has been included in the version and is expected to
// be uploaded in the near future.
// "ACTIVE" - The file has already been uploaded to Firebase Hosting.
Status string `json:"status,omitempty"`
// ForceSendFields is a list of field names (e.g. "Hash") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Hash") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *VersionFile) MarshalJSON() ([]byte, error)