Class ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource

The "indexes" collection of methods.

Inheritance

object

ProjectsResource.DatabasesResource.CollectionGroupsResource.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.v1

Assembly: Google.Apis.Firestore.v1.dll

Syntax

public class ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource

Constructors

IndexesResource(IClientService)

Constructs a new resource.

Declaration

public IndexesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(GoogleFirestoreAdminV1Index, string)

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.

Declaration

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

Parameters

Type	Name	Description
GoogleFirestoreAdminV1Index	body	The body of the request.
string	parent	Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.CreateRequest

Delete(string)

Deletes a composite index.

Declaration

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

Parameters

Type	Name	Description
string	name	Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.DeleteRequest

Get(string)

Gets a composite index.

Declaration

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

Parameters

Type	Name	Description
string	name	Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.GetRequest

List(string)

Lists composite indexes.

Declaration

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

Parameters

Type	Name	Description
string	parent	Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.ListRequest