firebase

package
v0.7.0 Latest Latest
Warning

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

Go to latest
Published: Jun 24, 2019 License: BSD-3-Clause Imports: 14 Imported by: 4

Documentation

Overview

Package firebase provides access to the Firebase Management API.

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

Creating a client

Usage example:

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

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

firebaseService, err := firebase.NewService(ctx, option.WithScopes(firebase.FirebaseReadonlyScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

firebaseService, err := firebase.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View your data across Google Cloud Platform services
	CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"

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

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

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddFirebaseRequest

type AddFirebaseRequest struct {
	// LocationId: Deprecated. Instead, call FinalizeDefaultLocation after
	// you add
	// Firebase services to your project.
	// <br>
	// <br>The ID of the project's Cloud resource location. The location
	// should be
	// one of the AppEngine locations defined
	// here:
	// https://cloud.google.com/appengine/docs/locations
	LocationId string `json:"locationId,omitempty"`

	// RegionCode: The region code (CLDR) that the account will use for
	// Firebase Analytics
	// data.
	// <br>For example: US, GB, or DE
	// <br>
	// <br>In Java, use `com.google.i18n.identifiers.RegionCode`.
	RegionCode string `json:"regionCode,omitempty"`

	// TimeZone: The time zone that the account will use for Firebase
	// Analytics data.
	// <br>For example: America/Los_Angeles or Africa/Abidjan
	TimeZone string `json:"timeZone,omitempty"`

	// ForceSendFields is a list of field names (e.g. "LocationId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "LocationId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AddFirebaseRequest: All fields are required.

func (*AddFirebaseRequest) MarshalJSON

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

type AdminSdkConfig

type AdminSdkConfig struct {
	// DatabaseURL: The default Firebase Realtime Database URL.
	DatabaseURL string `json:"databaseURL,omitempty"`

	// LocationId: The default resource location of other Firebase
	// resources
	// (such as Cloud Firestore).
	// <br>For examples, see
	// https://cloud.google.com/appengine/docs/locations.
	LocationId string `json:"locationId,omitempty"`

	// ProjectId: Immutable. The globally unique, user-assigned project ID
	// of the parent
	// Project.
	ProjectId string `json:"projectId,omitempty"`

	// StorageBucket: The default Cloud Storage for Firebase storage bucket
	// name.
	StorageBucket string `json:"storageBucket,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DatabaseURL") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DatabaseURL") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*AdminSdkConfig) MarshalJSON

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

type AndroidApp

type AndroidApp struct {
	// AppId: Immutable. The globally unique, Firebase-assigned identifier
	// of the App.
	// <br>
	// <br>This identifier should be treated as an opaque token, as the
	// data
	// format is not specified.
	AppId string `json:"appId,omitempty"`

	// DisplayName: The user-assigned display name of the App.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The fully qualified resource name of the App, in the
	// format:
	// <br><code>projects/<var>projectId</var>/androidApps/<var>appId
	// </var></code>
	Name string `json:"name,omitempty"`

	// PackageName: The canonical package name of the Android App as would
	// appear in the
	// Google Play Developer Console.
	PackageName string `json:"packageName,omitempty"`

	// ProjectId: The globally unique, user-assigned ID of the parent
	// Project for the App.
	ProjectId string `json:"projectId,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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AndroidApp: Details of a Firebase App for Android.

func (*AndroidApp) MarshalJSON

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

type AndroidAppConfig

type AndroidAppConfig struct {
	// ConfigFileContents: The contents of the JSON configuration file.
	ConfigFileContents string `json:"configFileContents,omitempty"`

	// ConfigFilename: The filename that the configuration artifact is
	// typically saved as.
	// <br>For example: `google-services.json`
	ConfigFilename string `json:"configFilename,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ConfigFileContents")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConfigFileContents") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AndroidAppConfig: Configuration metadata of a single Firebase App for Android.

func (*AndroidAppConfig) MarshalJSON

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

type AvailableProjectsListCall

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

func (*AvailableProjectsListCall) Context

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

func (*AvailableProjectsListCall) Do

Do executes the "firebase.availableProjects.list" call. Exactly one of *ListAvailableProjectsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAvailableProjectsResponse.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 (*AvailableProjectsListCall) Fields

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

func (*AvailableProjectsListCall) Header

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

func (*AvailableProjectsListCall) IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AvailableProjectsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of GCP `Projects` to return in the response. <br> <br>The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. <br> <br>This value cannot be negative.

func (*AvailableProjectsListCall) PageToken

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListAvailableProjects` indicating where in the set of GCP `Projects` to resume listing.

func (*AvailableProjectsListCall) Pages

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

type AvailableProjectsService

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

func NewAvailableProjectsService

func NewAvailableProjectsService(s *Service) *AvailableProjectsService

func (*AvailableProjectsService) List

List: Returns a list of [Google Cloud Platform (GCP) `Projects`] (https://cloud.google.com/resource-manager/reference/rest/ v1/projects) that are available to have Firebase resources added to them. <br> <br>A GCP `Project` will only be returned if: <ol>

<li><p>The caller has sufficient
       [Google IAM](https://cloud.google.com/iam) permissions to

call

       AddFirebase.</p></li>
<li><p>The GCP `Project` is not already a

FirebaseProject.</p></li>

<li><p>The GCP `Project` is not in an Organization which has

policies

that prevent Firebase resources from being

added.</p></li> </ol>

type DefaultResources

type DefaultResources struct {
	// HostingSite: The default Firebase Hosting site name, in the
	// format:
	// <br><code><var>projectId</var></code>
	// <br>Though rare, your `projectId` might already be used as the name
	// for an
	// existing Hosting site in another project (learn more about
	// creating
	// non-default,
	// [additional
	// sites](https://firebase.google.com/docs/hosting/multisites)).
	// In these cases, your `projectId` is appended with a hyphen then
	// five
	// alphanumeric characters to create your default Hosting site name.
	// For
	// example, if your `projectId` is `myproject123`, your default Hosting
	// site
	// name might be:
	// <br><code>myproject123-a5c16</code>
	HostingSite string `json:"hostingSite,omitempty"`

	// LocationId: The default resource location of other Firebase
	// resources, such as
	// Cloud Firestore. This field is omitted if the default resource
	// location has
	// not been finalized yet.
	// <br>For examples, see
	// https://cloud.google.com/appengine/docs/locations.
	LocationId string `json:"locationId,omitempty"`

	// RealtimeDatabaseInstance: The default Firebase Realtime Database
	// instance name, in the
	// format:
	// <br><code><var>projectId</var></code>
	// <br>Though rare, your `projectId` might already be used as the name
	// for an
	// existing Realtime Database instance in another project (learn more
	// about
	// [database
	// sharding](https://firebase.google.com/docs/database/us
	// age/sharding)). In
	// these cases, your `projectId` is appended with a hyphen then
	// five
	// alphanumeric characters to create your default Realtime Database
	// instance
	// name. For example, if your `projectId` is `myproject123`, your
	// default
	// database instance name might be:
	// <br><code>myproject123-a5c16</code>
	RealtimeDatabaseInstance string `json:"realtimeDatabaseInstance,omitempty"`

	// StorageBucket: The default Cloud Storage for Firebase storage bucket,
	// in the format:
	// <br><code><var>projectId</var>.appspot.com</code>. This field is
	// omitted
	// if the default resource location has not been finalized yet.
	StorageBucket string `json:"storageBucket,omitempty"`

	// ForceSendFields is a list of field names (e.g. "HostingSite") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "HostingSite") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DefaultResources: The default resources associated with a `FirebaseProject`.

func (*DefaultResources) MarshalJSON

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

type Empty

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

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns

(google.protobuf.Empty);

}

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

type FirebaseAppInfo

type FirebaseAppInfo struct {
	// AppId: Immutable. The globally unique, Firebase-assigned identifier
	// of the App.
	// <br>
	// <br>This identifier should be treated as an opaque token, as the
	// data
	// format is not specified.
	AppId string `json:"appId,omitempty"`

	// DisplayName: The user-assigned display name of the Firebase App.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The fully qualified resource name of the Firebase App, in the
	// format:
	// <br><code>projects/<var>projectId</var>/iosApps/<var>appId</va
	// r></code>
	// or
	// <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var>
	// <
	// /code>
	Name string `json:"name,omitempty"`

	// Platform: The platform of the Firebase App.
	//
	// Possible values:
	//   "PLATFORM_UNSPECIFIED" - Unknown state. This is only used for
	// distinguishing unset values.
	//   "IOS" - The Firebase App is associated with iOS.
	//   "ANDROID" - The Firebase App is associated with Android.
	//   "WEB" - The Firebase App is associated with web.
	Platform string `json:"platform,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AppId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

FirebaseAppInfo: A high-level summary of an App.

func (*FirebaseAppInfo) MarshalJSON

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

type FirebaseProject

type FirebaseProject struct {
	// DisplayName: The user-assigned display name of the Project.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The fully qualified resource name of the Project, in the
	// format:
	// <br><code>projects/<var>projectId</var></code>
	Name string `json:"name,omitempty"`

	// ProjectId: Immutable. The globally unique, user-assigned ID of the
	// Project.
	ProjectId string `json:"projectId,omitempty"`

	// ProjectNumber: The globally unique, Google-assigned identifier of the
	// Project.
	ProjectNumber int64 `json:"projectNumber,omitempty,string"`

	// Resources: The default Firebase resources associated with the
	// Project.
	Resources *DefaultResources `json:"resources,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

FirebaseProject: A `FirebaseProject` is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and Google Cloud Platform (GCP) resources. <br> <br>You can create a new `FirebaseProject` in the [Firebase console](https://console.firebase.google.com/), or you can add Firebase resources to an existing [GCP `Project`](https://cloud.google.com/resource-manager/ref erence/rest/v1/projects) by calling AddFirebase. <br> <br>A `FirebaseProject` is actually also a GCP `Project`, so a `FirebaseProject` uses underlying GCP identifiers (most importantly, `projectId`) as its own for easy interop with GCP APIs.

func (*FirebaseProject) MarshalJSON

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

type IosApp

type IosApp struct {
	// AppId: Immutable. The globally unique, Firebase-assigned identifier
	// of the App.
	// <br>
	// <br>This identifier should be treated as an opaque token, as the
	// data
	// format is not specified.
	AppId string `json:"appId,omitempty"`

	// AppStoreId: The automatically generated Apple ID assigned to the App
	// by Apple in the
	// iOS App Store.
	AppStoreId string `json:"appStoreId,omitempty"`

	// BundleId: The canonical bundle ID of the iOS App as it would appear
	// in the iOS
	// AppStore.
	BundleId string `json:"bundleId,omitempty"`

	// DisplayName: The user-assigned display name of the App.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The fully qualified resource name of the App, in the
	// format:
	// <br><code>projects/<var>projectId</var>/iosApps/<var>appId</va
	// r></code>
	Name string `json:"name,omitempty"`

	// ProjectId: The globally unique, user-assigned ID of the parent
	// Project for the App.
	ProjectId string `json:"projectId,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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IosApp: Details of a Firebase App for iOS.

func (*IosApp) MarshalJSON

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

type IosAppConfig

type IosAppConfig struct {
	// ConfigFileContents: The content of the XML configuration file.
	ConfigFileContents string `json:"configFileContents,omitempty"`

	// ConfigFilename: The filename that the configuration artifact is
	// typically saved as.
	// <br>For example: `GoogleService-Info.plist`
	ConfigFilename string `json:"configFilename,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ConfigFileContents")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConfigFileContents") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

IosAppConfig: Configuration metadata of a single Firebase App for iOS.

func (*IosAppConfig) MarshalJSON

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

type ListAndroidAppsResponse

type ListAndroidAppsResponse struct {
	// Apps: List of each AndroidApp that is in the parent Firebase Project.
	Apps []*AndroidApp `json:"apps,omitempty"`

	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token
	// is returned. If the string is empty, then this response is the last
	// page of
	// results.
	// <br>
	// <br>This token can be used in a subsequent call to `ListAndroidApps`
	// to
	// find the next group of Apps.
	// <br>
	// <br>Page tokens are short-lived and should not be persisted.
	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. "Apps") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Apps") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListAndroidAppsResponse) MarshalJSON

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

type ListAvailableProjectsResponse

type ListAvailableProjectsResponse struct {
	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token
	// is returned. If the string is empty, then this response is the last
	// page of
	// results.
	// <br>
	// <br>This token can be used in a subsequent calls to
	// `ListAvailableProjects`
	// to find the next group of GCP `Projects`.
	// <br>
	// <br>Page tokens are short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ProjectInfo: The list of GCP `Projects` which can have Firebase
	// resources added to them.
	ProjectInfo []*ProjectInfo `json:"projectInfo,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListAvailableProjectsResponse) MarshalJSON

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

type ListFirebaseProjectsResponse

type ListFirebaseProjectsResponse struct {
	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token
	// is returned. If the string is empty, then this response is the last
	// page of
	// results.
	// <br>
	// <br>This token can be used in a subsequent calls to
	// `ListFirebaseProjects`
	// to find the next group of Projects.
	// <br>
	// <br>Page tokens are short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Results: One page of the list of Projects that are accessible to the
	// caller.
	Results []*FirebaseProject `json:"results,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListFirebaseProjectsResponse) MarshalJSON

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

type ListIosAppsResponse

type ListIosAppsResponse struct {
	// Apps: List of each IosApp that is in the parent Firebase Project.
	Apps []*IosApp `json:"apps,omitempty"`

	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token
	// is returned. If the string is empty, then this response is the last
	// page of
	// results.
	// <br>
	// <br>This token can be used in a subsequent call to `ListIosApps` to
	// find
	// the next group of Apps.
	// <br>
	// <br>Page tokens are short-lived and should not be persisted.
	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. "Apps") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Apps") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListIosAppsResponse) MarshalJSON

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

type ListShaCertificatesResponse

type ListShaCertificatesResponse struct {
	// Certificates: The list of SHA certificates associated with the App.
	Certificates []*ShaCertificate `json:"certificates,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Certificates") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Certificates") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListShaCertificatesResponse) MarshalJSON

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

type ListWebAppsResponse

type ListWebAppsResponse struct {
	// Apps: List of each WebApp that is in the parent Firebase Project.
	Apps []*WebApp `json:"apps,omitempty"`

	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token
	// is returned. If the string is empty, then this response is the last
	// page of
	// results.
	// <br>
	// <br>This token can be used in a subsequent call to `ListWebApps` to
	// find
	// the next group of Apps.
	// <br>
	// <br>Page tokens are short-lived and should not be persisted.
	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. "Apps") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Apps") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListWebAppsResponse) MarshalJSON

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

type MessageSet

type MessageSet struct {
}

MessageSet: This is proto2's version of MessageSet.

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in
	// progress.
	// If `true`, the operation is completed, and either `error` or
	// `response` is
	// available.
	Done bool `json:"done,omitempty"`

	// Error: The error result of the operation in case of failure or
	// cancellation.
	Error *Status `json:"error,omitempty"`

	// Metadata: Service-specific metadata associated with the operation.
	// It typically
	// contains progress information and common metadata such as create
	// time.
	// Some services might not provide such metadata.  Any method that
	// returns a
	// long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: The server-assigned name, which is only unique within the same
	// service that
	// originally returns it. If you use the default HTTP mapping,
	// the
	// `name` should be a resource name ending with
	// `operations/{unique_id}`.
	Name string `json:"name,omitempty"`

	// Response: The normal response of the operation in case of success.
	// If the original
	// method returns no data on success, such as `Delete`, the response
	// is
	// `google.protobuf.Empty`.  If the original method is
	// standard
	// `Get`/`Create`/`Update`, the response should be the resource.  For
	// other
	// methods, the response should have the type `XxxResponse`, where
	// `Xxx`
	// is the original method name.  For example, if the original method
	// name
	// is `TakeSnapshot()`, the inferred response type
	// is
	// `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Done") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Done") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*Operation) MarshalJSON

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

type OperationsGetCall

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

func (*OperationsGetCall) Context

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

func (*OperationsGetCall) Do

Do executes the "firebase.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsGetCall) Fields

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

func (*OperationsGetCall) Header

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

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

func (*OperationsGetCall) IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type OperationsService

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

func NewOperationsService

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService) Get

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.

type ProjectInfo

type ProjectInfo struct {
	// DisplayName: The user-assigned display name of the GCP `Project`, for
	// example:
	// <code>My App</code>
	DisplayName string `json:"displayName,omitempty"`

	// LocationId: The default resource location of other Firebase
	// resources
	// (such as Cloud Firestore).
	// <br>Not all projects will have this field populated. If it is
	// not populated, it means that the project is not yet associated with
	// any
	// region. Consequently, a call to AddFirebase <b>must</b> provide a
	// location
	// in this case.
	// <br>For examples, see
	// https://cloud.google.com/appengine/docs/locations.
	LocationId string `json:"locationId,omitempty"`

	// Project: The resource name of the GCP `Project` to which Firebase
	// resources can be
	// added, in the format:
	// <br><code>projects/<var>projectId</var></code>
	Project string `json:"project,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ProjectInfo: A reference to a Google Cloud Platform (GCP) `Project`.

func (*ProjectInfo) MarshalJSON

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

type ProjectsAddFirebaseCall

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

func (*ProjectsAddFirebaseCall) Context

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

func (*ProjectsAddFirebaseCall) Do

Do executes the "firebase.projects.addFirebase" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAddFirebaseCall) Fields

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

func (*ProjectsAddFirebaseCall) Header

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

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

type ProjectsAndroidAppsCreateCall

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

func (*ProjectsAndroidAppsCreateCall) Context

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

func (*ProjectsAndroidAppsCreateCall) Do

Do executes the "firebase.projects.androidApps.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAndroidAppsCreateCall) Fields

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

func (*ProjectsAndroidAppsCreateCall) Header

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

type ProjectsAndroidAppsGetCall

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

func (*ProjectsAndroidAppsGetCall) Context

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

func (*ProjectsAndroidAppsGetCall) Do

Do executes the "firebase.projects.androidApps.get" call. Exactly one of *AndroidApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AndroidApp.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 (*ProjectsAndroidAppsGetCall) Fields

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

func (*ProjectsAndroidAppsGetCall) Header

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

func (*ProjectsAndroidAppsGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsAndroidAppsGetConfigCall

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

func (*ProjectsAndroidAppsGetConfigCall) Context

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

func (*ProjectsAndroidAppsGetConfigCall) Do

Do executes the "firebase.projects.androidApps.getConfig" call. Exactly one of *AndroidAppConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AndroidAppConfig.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 (*ProjectsAndroidAppsGetConfigCall) Fields

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

func (*ProjectsAndroidAppsGetConfigCall) Header

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

func (*ProjectsAndroidAppsGetConfigCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsAndroidAppsListCall

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

func (*ProjectsAndroidAppsListCall) Context

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

func (*ProjectsAndroidAppsListCall) Do

Do executes the "firebase.projects.androidApps.list" call. Exactly one of *ListAndroidAppsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAndroidAppsResponse.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 (*ProjectsAndroidAppsListCall) Fields

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

func (*ProjectsAndroidAppsListCall) Header

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

func (*ProjectsAndroidAppsListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsAndroidAppsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of Apps to return in the response. <br> <br>The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

func (*ProjectsAndroidAppsListCall) PageToken

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListAndroidApps` indicating where in the set of Apps to resume listing.

func (*ProjectsAndroidAppsListCall) Pages

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

type ProjectsAndroidAppsPatchCall

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

func (*ProjectsAndroidAppsPatchCall) Context

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

func (*ProjectsAndroidAppsPatchCall) Do

Do executes the "firebase.projects.androidApps.patch" call. Exactly one of *AndroidApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AndroidApp.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 (*ProjectsAndroidAppsPatchCall) Fields

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

func (*ProjectsAndroidAppsPatchCall) Header

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

func (*ProjectsAndroidAppsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Specifies which fields to update. <br>Note that the fields `name`, `appId`, `projectId`, and `packageName` are all immutable.

type ProjectsAndroidAppsService

type ProjectsAndroidAppsService struct {
	Sha *ProjectsAndroidAppsShaService
	// contains filtered or unexported fields
}

func NewProjectsAndroidAppsService

func NewProjectsAndroidAppsService(s *Service) *ProjectsAndroidAppsService

func (*ProjectsAndroidAppsService) Create

Create: Requests that a new AndroidApp be created. <br> <br>The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.

func (*ProjectsAndroidAppsService) Get

Get: Gets the AndroidApp identified by the specified resource name.

func (*ProjectsAndroidAppsService) GetConfig

GetConfig: Gets the configuration artifact associated with the specified AndroidApp.

func (*ProjectsAndroidAppsService) List

List: Lists each AndroidApp associated with the specified parent Project. <br> <br>The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`.

func (*ProjectsAndroidAppsService) Patch

Patch: Updates the attributes of the AndroidApp identified by the specified resource name.

type ProjectsAndroidAppsShaCreateCall

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

func (*ProjectsAndroidAppsShaCreateCall) Context

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

func (*ProjectsAndroidAppsShaCreateCall) Do

Do executes the "firebase.projects.androidApps.sha.create" call. Exactly one of *ShaCertificate or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ShaCertificate.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 (*ProjectsAndroidAppsShaCreateCall) Fields

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

func (*ProjectsAndroidAppsShaCreateCall) Header

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

type ProjectsAndroidAppsShaDeleteCall

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

func (*ProjectsAndroidAppsShaDeleteCall) Context

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

func (*ProjectsAndroidAppsShaDeleteCall) Do

Do executes the "firebase.projects.androidApps.sha.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAndroidAppsShaDeleteCall) Fields

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

func (*ProjectsAndroidAppsShaDeleteCall) Header

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

type ProjectsAndroidAppsShaListCall

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

func (*ProjectsAndroidAppsShaListCall) Context

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

func (*ProjectsAndroidAppsShaListCall) Do

Do executes the "firebase.projects.androidApps.sha.list" call. Exactly one of *ListShaCertificatesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListShaCertificatesResponse.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 (*ProjectsAndroidAppsShaListCall) Fields

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

func (*ProjectsAndroidAppsShaListCall) Header

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

func (*ProjectsAndroidAppsShaListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsAndroidAppsShaService

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

func NewProjectsAndroidAppsShaService

func NewProjectsAndroidAppsShaService(s *Service) *ProjectsAndroidAppsShaService

func (*ProjectsAndroidAppsShaService) Create

Create: Adds a SHA certificate to the specified AndroidApp.

func (*ProjectsAndroidAppsShaService) Delete

Delete: Removes a SHA certificate from the specified AndroidApp.

func (*ProjectsAndroidAppsShaService) List

List: Returns the list of SHA-1 and SHA-256 certificates for the specified AndroidApp.

type ProjectsGetAdminSdkConfigCall

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

func (*ProjectsGetAdminSdkConfigCall) Context

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

func (*ProjectsGetAdminSdkConfigCall) Do

Do executes the "firebase.projects.getAdminSdkConfig" call. Exactly one of *AdminSdkConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AdminSdkConfig.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 (*ProjectsGetAdminSdkConfigCall) Fields

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

func (*ProjectsGetAdminSdkConfigCall) Header

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

func (*ProjectsGetAdminSdkConfigCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsGetCall

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

func (*ProjectsGetCall) Context

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

func (*ProjectsGetCall) Do

Do executes the "firebase.projects.get" call. Exactly one of *FirebaseProject or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *FirebaseProject.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 (*ProjectsGetCall) Fields

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

func (*ProjectsGetCall) Header

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

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

func (*ProjectsGetCall) IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsIosAppsCreateCall

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

func (*ProjectsIosAppsCreateCall) Context

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

func (*ProjectsIosAppsCreateCall) Do

Do executes the "firebase.projects.iosApps.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsIosAppsCreateCall) Fields

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

func (*ProjectsIosAppsCreateCall) Header

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

type ProjectsIosAppsGetCall

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

func (*ProjectsIosAppsGetCall) Context

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

func (*ProjectsIosAppsGetCall) Do

Do executes the "firebase.projects.iosApps.get" call. Exactly one of *IosApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IosApp.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 (*ProjectsIosAppsGetCall) Fields

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

func (*ProjectsIosAppsGetCall) Header

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

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

func (*ProjectsIosAppsGetCall) IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsIosAppsGetConfigCall

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

func (*ProjectsIosAppsGetConfigCall) Context

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

func (*ProjectsIosAppsGetConfigCall) Do

Do executes the "firebase.projects.iosApps.getConfig" call. Exactly one of *IosAppConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IosAppConfig.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 (*ProjectsIosAppsGetConfigCall) Fields

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

func (*ProjectsIosAppsGetConfigCall) Header

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

func (*ProjectsIosAppsGetConfigCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsIosAppsListCall

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

func (*ProjectsIosAppsListCall) Context

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

func (*ProjectsIosAppsListCall) Do

Do executes the "firebase.projects.iosApps.list" call. Exactly one of *ListIosAppsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListIosAppsResponse.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 (*ProjectsIosAppsListCall) Fields

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

func (*ProjectsIosAppsListCall) Header

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

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

func (*ProjectsIosAppsListCall) IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsIosAppsListCall) PageSize

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

PageSize sets the optional parameter "pageSize": The maximum number of Apps to return in the response. <br> <br>The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

func (*ProjectsIosAppsListCall) PageToken

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

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing.

func (*ProjectsIosAppsListCall) Pages

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

type ProjectsIosAppsPatchCall

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

func (*ProjectsIosAppsPatchCall) Context

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

func (*ProjectsIosAppsPatchCall) Do

Do executes the "firebase.projects.iosApps.patch" call. Exactly one of *IosApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IosApp.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 (*ProjectsIosAppsPatchCall) Fields

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

func (*ProjectsIosAppsPatchCall) Header

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

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

func (*ProjectsIosAppsPatchCall) UpdateMask

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

UpdateMask sets the optional parameter "updateMask": Specifies which fields to update. <br>Note that the fields `name`, `appId`, `projectId`, and `bundleId` are all immutable.

type ProjectsIosAppsService

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

func NewProjectsIosAppsService

func NewProjectsIosAppsService(s *Service) *ProjectsIosAppsService

func (*ProjectsIosAppsService) Create

func (r *ProjectsIosAppsService) Create(parent string, iosapp *IosApp) *ProjectsIosAppsCreateCall

Create: Requests that a new IosApp be created. <br> <br>The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.

func (*ProjectsIosAppsService) Get

Get: Gets the IosApp identified by the specified resource name.

func (*ProjectsIosAppsService) GetConfig

GetConfig: Gets the configuration artifact associated with the specified IosApp.

func (*ProjectsIosAppsService) List

List: Lists each IosApp associated with the specified parent Project. <br> <br>The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`.

func (*ProjectsIosAppsService) Patch

Patch: Updates the attributes of the IosApp identified by the specified resource name.

type ProjectsListCall

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

func (*ProjectsListCall) Context

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

func (*ProjectsListCall) Do

Do executes the "firebase.projects.list" call. Exactly one of *ListFirebaseProjectsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListFirebaseProjectsResponse.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 (*ProjectsListCall) Fields

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

func (*ProjectsListCall) Header

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

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

func (*ProjectsListCall) IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsListCall) PageSize

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

PageSize sets the optional parameter "pageSize": The maximum number of Projects to return in the response. <br> <br>The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. <br> <br>This value cannot be negative.

func (*ProjectsListCall) PageToken

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

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListFirebaseProjects` indicating where in the set of Projects to resume listing.

func (*ProjectsListCall) Pages

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

type ProjectsPatchCall

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

func (*ProjectsPatchCall) Context

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

func (*ProjectsPatchCall) Do

Do executes the "firebase.projects.patch" call. Exactly one of *FirebaseProject or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *FirebaseProject.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 (*ProjectsPatchCall) Fields

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

func (*ProjectsPatchCall) Header

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

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

func (*ProjectsPatchCall) UpdateMask

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

UpdateMask sets the optional parameter "updateMask": Specifies which fields to update. <br> <br>If this list is empty, then no state will be updated. <br>Note that the fields `name`, `project_id`, and `project_number` are all immutable.

type ProjectsSearchAppsCall

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

func (*ProjectsSearchAppsCall) Context

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

func (*ProjectsSearchAppsCall) Do

Do executes the "firebase.projects.searchApps" call. Exactly one of *SearchFirebaseAppsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SearchFirebaseAppsResponse.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 (*ProjectsSearchAppsCall) Fields

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

func (*ProjectsSearchAppsCall) Header

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

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

func (*ProjectsSearchAppsCall) IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsSearchAppsCall) PageSize

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

PageSize sets the optional parameter "pageSize": The maximum number of Apps to return in the response. <br> <br>The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. <br> <br>This value cannot be negative.

func (*ProjectsSearchAppsCall) PageToken

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

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to resume listing.

func (*ProjectsSearchAppsCall) Pages

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

type ProjectsService

type ProjectsService struct {
	AndroidApps *ProjectsAndroidAppsService

	IosApps *ProjectsIosAppsService

	WebApps *ProjectsWebAppsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) AddFirebase

func (r *ProjectsService) AddFirebase(project string, addfirebaserequest *AddFirebaseRequest) *ProjectsAddFirebaseCall

AddFirebase: Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v 1/projects). <br> <br>Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` uses underlying GCP identifiers (most importantly, the `projectId`) as its own for easy interop with GCP APIs. <br> <br>The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to a FirebaseProject; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. <br> <br>This method does not modify any billing account information on the underlying GCP `Project`. <br> <br>All fields listed in the [request body](#request-body) are required. <br> <br>To call `AddFirebase`, a member must be an Editor or Owner for the existing GCP `Project`. Service accounts cannot call `AddFirebase`.

func (*ProjectsService) Get

func (r *ProjectsService) Get(name string) *ProjectsGetCall

Get: Gets the FirebaseProject identified by the specified resource name.

func (*ProjectsService) GetAdminSdkConfig

func (r *ProjectsService) GetAdminSdkConfig(name string) *ProjectsGetAdminSdkConfigCall

GetAdminSdkConfig: Gets the configuration artifact used by servers to simplify initialization. <br> <br>Typically, this configuration is used with the Firebase Admin SDK [initializeApp](https://firebase.google.com/docs/admin/setup#initi alize_the_sdk) command.

func (*ProjectsService) List

func (r *ProjectsService) List() *ProjectsListCall

List: Lists each FirebaseProject accessible to the caller. <br> <br>The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a `pageToken`. <br> <br>This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects. <br> <br>Use GetFirebaseProject for consistent reads as well as for additional Project details.

func (*ProjectsService) Patch

func (r *ProjectsService) Patch(name string, firebaseproject *FirebaseProject) *ProjectsPatchCall

Patch: Updates the attributes of the FirebaseProject identified by the specified resource name. <br> <br>All [query parameters](#query-parameters) are required.

func (*ProjectsService) SearchApps

func (r *ProjectsService) SearchApps(parent string) *ProjectsSearchAppsCall

SearchApps: A convenience method that lists all available Apps for the specified FirebaseProject. <br> <br>Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces).

type ProjectsWebAppsCreateCall

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

func (*ProjectsWebAppsCreateCall) Context

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

func (*ProjectsWebAppsCreateCall) Do

Do executes the "firebase.projects.webApps.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsWebAppsCreateCall) Fields

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

func (*ProjectsWebAppsCreateCall) Header

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

type ProjectsWebAppsGetCall

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

func (*ProjectsWebAppsGetCall) Context

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

func (*ProjectsWebAppsGetCall) Do

Do executes the "firebase.projects.webApps.get" call. Exactly one of *WebApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WebApp.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 (*ProjectsWebAppsGetCall) Fields

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

func (*ProjectsWebAppsGetCall) Header

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

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

func (*ProjectsWebAppsGetCall) IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsWebAppsGetConfigCall

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

func (*ProjectsWebAppsGetConfigCall) Context

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

func (*ProjectsWebAppsGetConfigCall) Do

Do executes the "firebase.projects.webApps.getConfig" call. Exactly one of *WebAppConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WebAppConfig.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 (*ProjectsWebAppsGetConfigCall) Fields

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

func (*ProjectsWebAppsGetConfigCall) Header

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

func (*ProjectsWebAppsGetConfigCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsWebAppsListCall

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

func (*ProjectsWebAppsListCall) Context

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

func (*ProjectsWebAppsListCall) Do

Do executes the "firebase.projects.webApps.list" call. Exactly one of *ListWebAppsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListWebAppsResponse.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 (*ProjectsWebAppsListCall) Fields

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

func (*ProjectsWebAppsListCall) Header

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

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

func (*ProjectsWebAppsListCall) IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsWebAppsListCall) PageSize

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

PageSize sets the optional parameter "pageSize": The maximum number of Apps to return in the response. <br> <br>The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

func (*ProjectsWebAppsListCall) PageToken

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

PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListWebApps` indicating where in the set of Apps to resume listing.

func (*ProjectsWebAppsListCall) Pages

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

type ProjectsWebAppsPatchCall

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

func (*ProjectsWebAppsPatchCall) Context

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

func (*ProjectsWebAppsPatchCall) Do

Do executes the "firebase.projects.webApps.patch" call. Exactly one of *WebApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WebApp.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 (*ProjectsWebAppsPatchCall) Fields

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

func (*ProjectsWebAppsPatchCall) Header

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

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

func (*ProjectsWebAppsPatchCall) UpdateMask

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

UpdateMask sets the optional parameter "updateMask": Specifies which fields to update. <br>Note that the fields `name`, `appId`, and `projectId` are all immutable.

type ProjectsWebAppsService

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

func NewProjectsWebAppsService

func NewProjectsWebAppsService(s *Service) *ProjectsWebAppsService

func (*ProjectsWebAppsService) Create

func (r *ProjectsWebAppsService) Create(parent string, webapp *WebApp) *ProjectsWebAppsCreateCall

Create: Requests that a new WebApp be created. <br> <br>The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.

func (*ProjectsWebAppsService) Get

Get: Gets the WebApp identified by the specified resource name.

func (*ProjectsWebAppsService) GetConfig

GetConfig: Gets the configuration artifact associated with the specified WebApp.

func (*ProjectsWebAppsService) List

List: Lists each WebApp associated with the specified parent Project. <br> <br>The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`.

func (*ProjectsWebAppsService) Patch

Patch: Updates the attributes of the WebApp identified by the specified resource name.

type SearchFirebaseAppsResponse

type SearchFirebaseAppsResponse struct {
	// Apps: One page of results from a call to `SearchFirebaseApps`.
	Apps []*FirebaseAppInfo `json:"apps,omitempty"`

	// NextPageToken: If the result list is too large to fit in a single
	// response, then a token
	// is returned.
	// <br>
	// <br>This token can be used in a subsequent calls to
	// `SearchFirebaseApps`
	// to find the next group of Apps.
	// <br>If the string is empty, then this response is the last page of
	// results.
	// <br>Page tokens are short-lived and should not be persisted.
	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. "Apps") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Apps") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*SearchFirebaseAppsResponse) MarshalJSON

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

type Service

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

	AvailableProjects *AvailableProjectsService

	Operations *OperationsService

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

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

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

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

func NewService

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

NewService creates a new Service.

type ShaCertificate

type ShaCertificate struct {
	// CertType: The SHA certificate type.
	//
	// Possible values:
	//   "SHA_CERTIFICATE_TYPE_UNSPECIFIED" - Unknown state.  This is only
	// used for distinguishing unset values.
	//   "SHA_1" - Certificate is a SHA-1 type certificate.
	//   "SHA_256" - Certificate is a SHA-256 type certificate.
	CertType string `json:"certType,omitempty"`

	// Name: The fully qualified resource name of the `sha-key`, in the
	// format:
	// <br><code>projects/<var>projectId</var>/androidApps/<var>appId
	// </var>/sha/<var>shaHash</var></code>
	Name string `json:"name,omitempty"`

	// ShaHash: The certificate hash for the App.
	ShaHash string `json:"shaHash,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CertType") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CertType") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ShaCertificate: A SHA-1 or SHA-256 certificate associated with the AndroidApp.

func (*ShaCertificate) MarshalJSON

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

type Status

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

func (*Status) MarshalJSON

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

type StatusProto

type StatusProto struct {
	// CanonicalCode: The canonical error code (see codes.proto) that most
	// closely
	// corresponds to this status. May be missing.
	CanonicalCode int64 `json:"canonicalCode,omitempty"`

	// Code: Numeric code drawn from the space specified below. Often, this
	// is the
	// canonical error space, and code is drawn from
	// google3/util/task/codes.proto
	Code int64 `json:"code,omitempty"`

	// Message: Detail message
	Message string `json:"message,omitempty"`

	// MessageSet: message_set associates an arbitrary proto message with
	// the status.
	MessageSet *MessageSet `json:"messageSet,omitempty"`

	// Payload: DEPRECATED.
	//
	// This field was deprecated in 2011 with cl/20297133.  Java support
	// for the field was moved to a proto1 backward compatibility class
	// in April 2017 with cl/142615857 and cl/154123203.  There was
	// never support for this field in Go; if set Go will ignore it.
	// C++ stopped setting StatusProto::payload in October 2015 with
	// cl/106347055,
	// and stopped reading the field in October 2017 with cl/173324114.
	//
	// In general, newly written code should use only "message_set". If you
	// need
	// to maintain backward compatibility with code written before
	// 3/25/2011, do
	// the following:
	//
	// - During the transition period, either (1) set both "payload" and
	//   "message_set", or (2) write the consumer of StatusProto so that it
	// can
	//   forge a MessageSet object from "payload" if "message_set" is
	// missing.
	//   The C++ util::Status implementation does (2).
	//
	// - Once all the consumers are converted to accept "message_set", then
	//   remove the use of "payload" on the producer side.
	Payload *TypedMessage `json:"payload,omitempty"`

	// Space: The following are usually only present when code != 0
	// Space to which this status belongs
	Space string `json:"space,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CanonicalCode") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CanonicalCode") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

StatusProto: Wire-format for a Status object

func (*StatusProto) MarshalJSON

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

type TypedMessage

type TypedMessage struct {
	// Message: Message bytes.
	Message string `json:"message,omitempty"`

	// TypeId: Identifier for the type.
	TypeId int64 `json:"typeId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Message") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Message") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TypedMessage: Message that groups a protocol type_id (as defined by MessageSet), with an encoded message of that type. Its use is similar to MessageSet, except it represents a single (type, encoded message) instead of a set.

To fill for known protocol type:

MyProtocolMsg proto;
TypedMessage typed_msg;
typed_msg.set_type_id(MyProtocolMsg::MESSAGE_TYPE_ID);
proto.AppendToCord(typed_msg.mutable_message());

To fill for unknown protocol type:

ProtocolMessage proto;
TypedMessage typed_msg;
typed_msg.set_type_id(proto.GetMapper()->type_id());
proto.AppendToCord(typed_msg.mutable_message());

func (*TypedMessage) MarshalJSON

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

type WebApp

type WebApp struct {
	// AppId: Immutable. The globally unique, Firebase-assigned identifier
	// of the App.
	// <br>
	// <br>This identifier should be treated as an opaque token, as the
	// data
	// format is not specified.
	AppId string `json:"appId,omitempty"`

	// AppUrls: The fully qualified URLs where the App is hosted.
	AppUrls []string `json:"appUrls,omitempty"`

	// DisplayName: The user-assigned display name of the App.
	DisplayName string `json:"displayName,omitempty"`

	// Name: The fully qualified resource name of the App, for
	// example:
	// <br><code>projects/<var>projectId</var>/webApps/<var>appId</v
	// ar></code>
	Name string `json:"name,omitempty"`

	// ProjectId: The globally unique, user-assigned ID of the parent
	// Project for the App.
	ProjectId string `json:"projectId,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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

WebApp: Details of a Firebase App for the web.

func (*WebApp) MarshalJSON

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

type WebAppConfig

type WebAppConfig struct {
	// ApiKey: The API key associated with the web App.
	ApiKey string `json:"apiKey,omitempty"`

	// AppId: Immutable. The globally unique, Firebase-assigned identifier
	// of the App.
	AppId string `json:"appId,omitempty"`

	// AuthDomain: The domain Firebase Auth configures for OAuth redirects,
	// in the format:
	// <br><code><var>projectId</var>.firebaseapp.com</code>
	AuthDomain string `json:"authDomain,omitempty"`

	// DatabaseURL: The default Firebase Realtime Database URL.
	DatabaseURL string `json:"databaseURL,omitempty"`

	// LocationId: The default resource location of other Firebase
	// resources
	// (such as Cloud Firestore).
	// <br>For examples, see
	// https://cloud.google.com/appengine/docs/locations.
	LocationId string `json:"locationId,omitempty"`

	// MessagingSenderId: The sender ID for use with Firebase Cloud
	// Messaging.
	MessagingSenderId string `json:"messagingSenderId,omitempty"`

	// ProjectId: Immutable. The globally unique, user-assigned project ID
	// of the parent
	// Project for the App.
	ProjectId string `json:"projectId,omitempty"`

	// StorageBucket: The default Cloud Storage for Firebase storage bucket
	// name.
	StorageBucket string `json:"storageBucket,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ApiKey") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ApiKey") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

WebAppConfig: Configuration metadata of a single Firebase App for the web.

func (*WebAppConfig) MarshalJSON

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

Jump to

Keyboard shortcuts

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