Class ProjectsResource.IndexesResource

The "indexes" collection of methods.

Inheritance

System.Object

ProjectsResource.IndexesResource

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Datastore.v1

Assembly: Google.Apis.Datastore.v1.dll

Syntax

public class IndexesResource

Constructors

IndexesResource(IClientService)

Constructs a new resource.

Declaration

public IndexesResource(IClientService service)

Parameters

Type	Name	Description
Google.Apis.Services.IClientService	service

Methods

Create(GoogleDatastoreAdminV1Index, 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 index 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 property cannot be created.

Declaration

public virtual ProjectsResource.IndexesResource.CreateRequest Create(GoogleDatastoreAdminV1Index body, string projectId)

Parameters

Type	Name	Description
GoogleDatastoreAdminV1Index	body	The body of the request.
System.String	projectId	Project ID against which to make the request.

Returns

Type	Description
ProjectsResource.IndexesResource.CreateRequest

Delete(String, String)

Deletes an existing index. An index can only be deleted if it is in a READY or ERROR state. On successful execution of the request, the index will be in a DELETING state. And on completion of the returned google.longrunning.Operation, the index will be removed.

During index deletion, 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, followed by calling delete again.

Declaration

public virtual ProjectsResource.IndexesResource.DeleteRequest Delete(string projectId, string indexId)

Parameters

Type	Name	Description
System.String	projectId	Project ID against which to make the request.
System.String	indexId	The resource ID of the index to delete.

Returns

Type	Description
ProjectsResource.IndexesResource.DeleteRequest

Get(String, String)

Gets an index.

Declaration

public virtual ProjectsResource.IndexesResource.GetRequest Get(string projectId, string indexId)

Parameters

Type	Name	Description
System.String	projectId	Project ID against which to make the request.
System.String	indexId	The resource ID of the index to get.

Returns

Type	Description
ProjectsResource.IndexesResource.GetRequest

List(String)

Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results.

Declaration

public virtual ProjectsResource.IndexesResource.ListRequest List(string projectId)

Parameters

Type	Name	Description
System.String	projectId	Project ID against which to make the request.

Returns

Type	Description
ProjectsResource.IndexesResource.ListRequest