instances

Overview

Name	instances
Type	Resource
Id	firebase.firebasedatabase.instances

Fields

Name	Datatype	Description
name	string	The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}.
project	string	Output only. The resource name of the project this instance belongs to. For example: projects/{project-number}.
state	string	Output only. The database's lifecycle state. Read-only.
type	string	Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
databaseUrl	string	Output only. Output Only. The globally unique hostname of the database.

Methods

Name	Accessible by	Required Params	Description
projects_locations_instances_get	SELECT	instancesId, locationsId, projectsId	Gets the DatabaseInstance identified by the specified resource name.
projects_locations_instances_list	SELECT	locationsId, projectsId	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.
projects_locations_instances_create	INSERT	locationsId, projectsId	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.
projects_locations_instances_delete	DELETE	instancesId, locationsId, projectsId	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.
projects_locations_instances_disable	EXEC	instancesId, locationsId, projectsId	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.
projects_locations_instances_reenable	EXEC	instancesId, locationsId, projectsId	Enables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled DatabaseInstance is ACTIVE.
projects_locations_instances_undelete	EXEC	instancesId, locationsId, projectsId	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.