Class ProjectsResource.LocationsResource.InstancesResource.ListRequest
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.
Inheritance
Inherited Members
Namespace: Google.Apis.FirebaseRealtimeDatabase.v1beta
Assembly: Google.Apis.FirebaseRealtimeDatabase.v1beta.dll
Syntax
public class ProjectsResource.LocationsResource.InstancesResource.ListRequest : FirebaseRealtimeDatabaseBaseServiceRequest<ListDatabaseInstancesResponse>, IClientServiceRequest<ListDatabaseInstancesResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | parent |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
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.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
Token returned from a previous call to ListDatabaseInstances
indicating where in the set of
database instances to resume listing.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | 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/-
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
ShowDeleted
Indicate that DatabaseInstances in the DELETED
state should also be returned.
Declaration
[RequestParameter("showDeleted", RequestParameterType.Query)]
public virtual bool? ShowDeleted { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()