OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the email
// address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// View your data across Google Cloud services and see the email address of
// your Google Account
CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
// View and administer all your Firebase data and settings
FirebaseScope = "https://www.googleapis.com/auth/firebase"
// View all your Firebase data and settings
FirebaseReadonlyScope = "https://www.googleapis.com/auth/firebase.readonly"
)
DatabaseInstance: Representation of a Realtime Database instance. Details on interacting with contents of a DatabaseInstance can be found at: https://firebase.google.com/docs/database/rest/start.
type DatabaseInstance struct {
// DatabaseUrl: Output only. Output Only. The globally unique hostname of the
// database.
DatabaseUrl string `json:"databaseUrl,omitempty"`
// Name: The fully qualified resource name of the database instance, in the
// form:
// `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
Name string `json:"name,omitempty"`
// Project: Output only. The resource name of the project this instance belongs
// to. For example: `projects/{project-number}`.
Project string `json:"project,omitempty"`
// State: Output only. The database's lifecycle state. Read-only.
//
// Possible values:
// "LIFECYCLE_STATE_UNSPECIFIED" - Unspecified state, likely the result of an
// error on the backend. This is only used for distinguishing unset values.
// "ACTIVE" - The normal and active state.
// "DISABLED" - The database is in a disabled state. It can be re-enabled
// later.
// "DELETED" - The database is in a deleted state.
State string `json:"state,omitempty"`
// Type: Immutable. The database instance type. On creation only USER_DATABASE
// is allowed, which is also the default when omitted.
//
// Possible values:
// "DATABASE_INSTANCE_TYPE_UNSPECIFIED" - Unknown state, likely the result of
// an error on the backend. This is only used for distinguishing unset values.
// "DEFAULT_DATABASE" - The default database that is provisioned when a
// project is created.
// "USER_DATABASE" - A database that the user created.
Type string `json:"type,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DatabaseUrl") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DatabaseUrl") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DatabaseInstance) MarshalJSON() ([]byte, error)
DisableDatabaseInstanceRequest: The request sent to the DisableDatabaseInstance method.
type DisableDatabaseInstanceRequest struct {
}
ListDatabaseInstancesResponse: The response from the ListDatabaseInstances method.
type ListDatabaseInstancesResponse struct {
// Instances: List of each DatabaseInstance that is in the parent Firebase
// project.
Instances []*DatabaseInstance `json:"instances,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. This token can be used in a subsequent call to
// `ListDatabaseInstances` to find the next group of database instances. 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. "Instances") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Instances") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListDatabaseInstancesResponse) MarshalJSON() ([]byte, error)
type ProjectsLocationsInstancesCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsInstancesCreateCall) Context(ctx context.Context) *ProjectsLocationsInstancesCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsInstancesCreateCall) DatabaseId(databaseId string) *ProjectsLocationsInstancesCreateCall
DatabaseId sets the optional parameter "databaseId": The globally unique identifier of the database instance.
func (c *ProjectsLocationsInstancesCreateCall) Do(opts ...googleapi.CallOption) (*DatabaseInstance, error)
Do executes the "firebasedatabase.projects.locations.instances.create" call. Any non-2xx status code is an error. Response headers are in either *DatabaseInstance.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsInstancesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsInstancesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsInstancesCreateCall) ValidateOnly(validateOnly bool) *ProjectsLocationsInstancesCreateCall
ValidateOnly sets the optional parameter "validateOnly": When set to true, the request will be validated but not submitted.
type ProjectsLocationsInstancesDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsInstancesDeleteCall) Context(ctx context.Context) *ProjectsLocationsInstancesDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsInstancesDeleteCall) Do(opts ...googleapi.CallOption) (*DatabaseInstance, error)
Do executes the "firebasedatabase.projects.locations.instances.delete" call. Any non-2xx status code is an error. Response headers are in either *DatabaseInstance.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsInstancesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsInstancesDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsInstancesDisableCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsInstancesDisableCall) Context(ctx context.Context) *ProjectsLocationsInstancesDisableCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsInstancesDisableCall) Do(opts ...googleapi.CallOption) (*DatabaseInstance, error)
Do executes the "firebasedatabase.projects.locations.instances.disable" call. Any non-2xx status code is an error. Response headers are in either *DatabaseInstance.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsInstancesDisableCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesDisableCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsInstancesDisableCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsInstancesGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsInstancesGetCall) Context(ctx context.Context) *ProjectsLocationsInstancesGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsInstancesGetCall) Do(opts ...googleapi.CallOption) (*DatabaseInstance, error)
Do executes the "firebasedatabase.projects.locations.instances.get" call. Any non-2xx status code is an error. Response headers are in either *DatabaseInstance.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsInstancesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsInstancesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsInstancesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ProjectsLocationsInstancesListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsInstancesListCall) Context(ctx context.Context) *ProjectsLocationsInstancesListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsInstancesListCall) Do(opts ...googleapi.CallOption) (*ListDatabaseInstancesResponse, error)
Do executes the "firebasedatabase.projects.locations.instances.list" call. Any non-2xx status code is an error. Response headers are in either *ListDatabaseInstancesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsInstancesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsInstancesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsInstancesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsLocationsInstancesListCall) PageSize(pageSize int64) *ProjectsLocationsInstancesListCall
PageSize sets the optional parameter "pageSize": The maximum number of database instances to return in the response. 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 (c *ProjectsLocationsInstancesListCall) PageToken(pageToken string) *ProjectsLocationsInstancesListCall
PageToken sets the optional parameter "pageToken": Token returned from a previous call to `ListDatabaseInstances` indicating where in the set of database instances to resume listing.
func (c *ProjectsLocationsInstancesListCall) Pages(ctx context.Context, f func(*ListDatabaseInstancesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (c *ProjectsLocationsInstancesListCall) ShowDeleted(showDeleted bool) *ProjectsLocationsInstancesListCall
ShowDeleted sets the optional parameter "showDeleted": Indicate that DatabaseInstances in the `DELETED` state should also be returned.
type ProjectsLocationsInstancesReenableCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsInstancesReenableCall) Context(ctx context.Context) *ProjectsLocationsInstancesReenableCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsInstancesReenableCall) Do(opts ...googleapi.CallOption) (*DatabaseInstance, error)
Do executes the "firebasedatabase.projects.locations.instances.reenable" call. Any non-2xx status code is an error. Response headers are in either *DatabaseInstance.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsInstancesReenableCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesReenableCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsInstancesReenableCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsInstancesService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsInstancesService(s *Service) *ProjectsLocationsInstancesService
func (r *ProjectsLocationsInstancesService) Create(parent string, databaseinstance *DatabaseInstance) *ProjectsLocationsInstancesCreateCall
Create: Requests that a new DatabaseInstance be created. The state of a successfully created DatabaseInstance is ACTIVE. Only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Note that it might take a few minutes for billing enablement state to propagate to Firebase systems.
func (r *ProjectsLocationsInstancesService) Delete(name string) *ProjectsLocationsInstancesDeleteCall
Delete: Marks a DatabaseInstance to be deleted. The DatabaseInstance will be set to the DELETED state for 20 days, and will be purged within 30 days. The default database cannot be deleted. IDs for deleted database instances may never be recovered or re-used. The Database may only be deleted if it is already in a DISABLED state.
func (r *ProjectsLocationsInstancesService) Disable(name string, disabledatabaseinstancerequest *DisableDatabaseInstanceRequest) *ProjectsLocationsInstancesDisableCall
Disable: Disables a DatabaseInstance. The database can be re-enabled later using ReenableDatabaseInstance. When a database is disabled, all reads and writes are denied, including view access in the Firebase console.
func (r *ProjectsLocationsInstancesService) Get(nameid string) *ProjectsLocationsInstancesGetCall
Get: Gets the DatabaseInstance identified by the specified resource name.
func (r *ProjectsLocationsInstancesService) List(parent string) *ProjectsLocationsInstancesListCall
List: Lists each DatabaseInstance associated with the specified parent project. The list items are returned in no particular order, but will be a consistent view of the database instances when additional requests are made with a `pageToken`. The resulting list contains instances in any STATE. The list results may be stale by a few seconds. Use GetDatabaseInstance for consistent reads.
func (r *ProjectsLocationsInstancesService) Reenable(name string, reenabledatabaseinstancerequest *ReenableDatabaseInstanceRequest) *ProjectsLocationsInstancesReenableCall
Reenable: Enables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled DatabaseInstance is ACTIVE.
func (r *ProjectsLocationsInstancesService) Undelete(name string, undeletedatabaseinstancerequest *UndeleteDatabaseInstanceRequest) *ProjectsLocationsInstancesUndeleteCall
Undelete: Restores a DatabaseInstance that was previously marked to be deleted. After the delete method is used, DatabaseInstances are set to the DELETED state for 20 days, and will be purged within 30 days. Databases in the DELETED state can be undeleted without losing any data. This method may only be used on a DatabaseInstance in the DELETED state. Purged DatabaseInstances may not be recovered.
type ProjectsLocationsInstancesUndeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsInstancesUndeleteCall) Context(ctx context.Context) *ProjectsLocationsInstancesUndeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsInstancesUndeleteCall) Do(opts ...googleapi.CallOption) (*DatabaseInstance, error)
Do executes the "firebasedatabase.projects.locations.instances.undelete" call. Any non-2xx status code is an error. Response headers are in either *DatabaseInstance.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsLocationsInstancesUndeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesUndeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsInstancesUndeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsService struct {
Instances *ProjectsLocationsInstancesService
// contains filtered or unexported fields
}
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
type ProjectsService struct {
Locations *ProjectsLocationsService
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
ReenableDatabaseInstanceRequest: The request sent to the ReenableDatabaseInstance method.
type ReenableDatabaseInstanceRequest struct {
}
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Projects *ProjectsService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
UndeleteDatabaseInstanceRequest: The request sent to UndeleteDatabaseInstance method.
type UndeleteDatabaseInstanceRequest struct {
}