Resource: 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.
JSON representation |
---|
{ "name": string, "project": string, "databaseUrl": string, "type": enum ( |
Fields | |
---|---|
name |
The fully qualified resource name of the database instance, in the form: |
project |
Output only. The resource name of the project this instance belongs to. For example: |
databaseUrl |
Output only. Output Only. The globally unique hostname of the database. |
type |
Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted. |
state |
Output only. The database's lifecycle state. Read-only. |
DatabaseInstanceType
The possible types of a database instance.
Enums | |
---|---|
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. |
State
Database lifecycle states.
Enums | |
---|---|
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. |
Methods |
|
---|---|
|
Requests that a new DatabaseInstance be created. |
|
Marks a DatabaseInstance to be deleted. |
|
Disables a DatabaseInstance . |
|
Gets the DatabaseInstance identified by the specified resource name. |
|
Lists each DatabaseInstance associated with the specified parent project. |
|
Enables a DatabaseInstance . |
|
Restores a DatabaseInstance that was previously marked to be deleted. |