Class ProjectsResource.LocationsResource.InstancesResource

The "instances" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.InstancesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.FirebaseRealtimeDatabase.v1beta

Assembly: Google.Apis.FirebaseRealtimeDatabase.v1beta.dll

Syntax

public class ProjectsResource.LocationsResource.InstancesResource

Constructors

InstancesResource(IClientService)

Constructs a new resource.

Declaration

public InstancesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(DatabaseInstance, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.CreateRequest Create(DatabaseInstance body, string parent)

Parameters

Type	Name	Description
DatabaseInstance	body	The body of the request.
string	parent	Required. The parent project for which to create a database instance, in the form: projects/{project-number}/locations/{location-id}.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.CreateRequest

Delete(string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.DeleteRequest

Disable(DisableDatabaseInstanceRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.DisableRequest Disable(DisableDatabaseInstanceRequest body, string name)

Parameters

Type	Name	Description
DisableDatabaseInstanceRequest	body	The body of the request.
string	name	Required. The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.DisableRequest

Get(string)

Gets the DatabaseInstance identified by the specified resource name.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	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 under projects and locations. The resulting wildcarding form of the method is: projects/-/locations/-/instances/{database-id}.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.GetRequest

List(string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	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/-

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ListRequest

Reenable(ReenableDatabaseInstanceRequest, string)

Enables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled DatabaseInstance is ACTIVE.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.ReenableRequest Reenable(ReenableDatabaseInstanceRequest body, string name)

Parameters

Type	Name	Description
ReenableDatabaseInstanceRequest	body	The body of the request.
string	name	Required. The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ReenableRequest

Undelete(UndeleteDatabaseInstanceRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.UndeleteRequest Undelete(UndeleteDatabaseInstanceRequest body, string name)

Parameters

Type	Name	Description
UndeleteDatabaseInstanceRequest	body	The body of the request.
string	name	Required. The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.UndeleteRequest