ProjectsIndexes
class ProjectsIndexes extends Resource (View source)
The "indexes" collection of methods.
Typical usage is:
$datastoreService = new Google\Service\Datastore(...);
$indexes = $datastoreService->projects_indexes;
Methods
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. (indexes.create)
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. (indexes.delete)
Gets an index. (indexes.get)
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. (indexes.listProjectsIndexes)
Details
GoogleLongrunningOperation
create(string $projectId, GoogleDatastoreAdminV1Index $postBody, array $optParams = [])
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. (indexes.create)
GoogleLongrunningOperation
delete(string $projectId, string $indexId, array $optParams = [])
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. (indexes.delete)
GoogleDatastoreAdminV1Index
get(string $projectId, string $indexId, array $optParams = [])
Gets an index. (indexes.get)
GoogleDatastoreAdminV1ListIndexesResponse
listProjectsIndexes(string $projectId, array $optParams = [])
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. (indexes.listProjectsIndexes)