View Source GoogleApi.FirebaseDatabase.V1beta.Api.Projects (google_api_firebase_database v0.4.0)
API calls for all endpoints tagged Projects
.
Summary
Functions
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.
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.
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.
Gets the DatabaseInstance identified by the specified resource name.
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.
Enables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled DatabaseInstance is ACTIVE.
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.
Functions
firebasedatabase_projects_locations_instances_create(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasedatabase_projects_locations_instances_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.FirebaseDatabase.V1beta.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent project for which to create a database instance, in the form:projects/{project-number}/locations/{location-id}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:databaseId
(type:String.t
) - The globally unique identifier of the database instance. -
:validateOnly
(type:boolean()
) - When set to true, the request will be validated but not submitted. -
:body
(type:GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance{}}
on success -
{:error, info}
on failure
firebasedatabase_projects_locations_instances_delete(connection, name, optional_params \\ [], opts \\ [])
@spec firebasedatabase_projects_locations_instances_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.FirebaseDatabase.V1beta.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully qualified resource name of the database instance, in the form:projects/{project-number}/locations/{location-id}/instances/{database-id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance{}}
on success -
{:error, info}
on failure
firebasedatabase_projects_locations_instances_disable(connection, name, optional_params \\ [], opts \\ [])
@spec firebasedatabase_projects_locations_instances_disable( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.FirebaseDatabase.V1beta.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully qualified resource name of the database instance, in the form:projects/{project-number}/locations/{location-id}/instances/{database-id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.FirebaseDatabase.V1beta.Model.DisableDatabaseInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance{}}
on success -
{:error, info}
on failure
firebasedatabase_projects_locations_instances_get(connection, name, optional_params \\ [], opts \\ [])
@spec firebasedatabase_projects_locations_instances_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the DatabaseInstance identified by the specified resource name.
Parameters
-
connection
(type:GoogleApi.FirebaseDatabase.V1beta.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully qualified resource name of the database instance, in the form:projects/{project-number}/locations/{location-id}/instances/{database-id}
.database-id
is a globally unique identifier across all parent collections. For convenience, this method allows you to supply-
as a wildcard character in place of specific collections underprojects
andlocations
. The resulting wildcarding form of the method is:projects/-/locations/-/instances/{database-id}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance{}}
on success -
{:error, info}
on failure
firebasedatabase_projects_locations_instances_list(connection, parent, optional_params \\ [], opts \\ [])
@spec firebasedatabase_projects_locations_instances_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseDatabase.V1beta.Model.ListDatabaseInstancesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.FirebaseDatabase.V1beta.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent project for which to list database instances, in the form:projects/{project-number}/locations/{location-id}
To list across all locations, use a parent in the form:projects/{project-number}/locations/-
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - Token returned from a previous call toListDatabaseInstances
indicating where in the set of database instances to resume listing. -
:showDeleted
(type:boolean()
) - Indicate that DatabaseInstances in theDELETED
state should also be returned.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseDatabase.V1beta.Model.ListDatabaseInstancesResponse{}}
on success -
{:error, info}
on failure
firebasedatabase_projects_locations_instances_reenable(connection, name, optional_params \\ [], opts \\ [])
@spec firebasedatabase_projects_locations_instances_reenable( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Enables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled DatabaseInstance is ACTIVE.
Parameters
-
connection
(type:GoogleApi.FirebaseDatabase.V1beta.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully qualified resource name of the database instance, in the form:projects/{project-number}/locations/{location-id}/instances/{database-id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.FirebaseDatabase.V1beta.Model.ReenableDatabaseInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance{}}
on success -
{:error, info}
on failure
firebasedatabase_projects_locations_instances_undelete(connection, name, optional_params \\ [], opts \\ [])
@spec firebasedatabase_projects_locations_instances_undelete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.FirebaseDatabase.V1beta.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The fully qualified resource name of the database instance, in the form:projects/{project-number}/locations/{location-id}/instances/{database-id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.FirebaseDatabase.V1beta.Model.UndeleteDatabaseInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.FirebaseDatabase.V1beta.Model.DatabaseInstance{}}
on success -
{:error, info}
on failure