Class ProjectsResource.DatabasesResource.IndexesResource

The "indexes" collection of methods.

Inheritance

object

ProjectsResource.DatabasesResource.IndexesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Firestore.v1beta1

Assembly: Google.Apis.Firestore.v1beta1.dll

Syntax

public class ProjectsResource.DatabasesResource.IndexesResource

Constructors

IndexesResource(IClientService)

Constructs a new resource.

Declaration

public IndexesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(GoogleFirestoreAdminV1beta1Index, string)

Creates the specified index. A newly created index's initial state is CREATING. On completion of the returned google.longrunning.Operation, the state will be READY. If the index already exists, the call will return an ALREADY_EXISTS status. During creation, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single field cannot be created.

Declaration

public virtual ProjectsResource.DatabasesResource.IndexesResource.CreateRequest Create(GoogleFirestoreAdminV1beta1Index body, string parent)

Parameters

Type	Name	Description
GoogleFirestoreAdminV1beta1Index	body	The body of the request.
string	parent	The name of the database this index will apply to. For example: projects/{project_id}/databases/{database_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.IndexesResource.CreateRequest

Delete(string)

Deletes an index.

Declaration

public virtual ProjectsResource.DatabasesResource.IndexesResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	The index name. For example: projects/{project_id}/databases/{database_id}/indexes/{index_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.IndexesResource.DeleteRequest

Get(string)

Gets an index.

Declaration

public virtual ProjectsResource.DatabasesResource.IndexesResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	The name of the index. For example: projects/{project_id}/databases/{database_id}/indexes/{index_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.IndexesResource.GetRequest

List(string)

Lists the indexes that match the specified filters.

Declaration

public virtual ProjectsResource.DatabasesResource.IndexesResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	The database name. For example: projects/{project_id}/databases/{database_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.IndexesResource.ListRequest