Documentation

Google_Service_Datastore_Resource_ProjectsIndexes extends Google_Service_Resource
in package

The "indexes" collection of methods.

Typical usage is: $datastoreService = new Google_Service_Datastore(...); $indexes = $datastoreService->indexes;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Datastore_GoogleLongrunningOperation
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)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Datastore_GoogleLongrunningOperation
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)
get()  : Google_Service_Datastore_GoogleDatastoreAdminV1Index
Gets an index. (indexes.get)
listProjectsIndexes()  : Google_Service_Datastore_GoogleDatastoreAdminV1ListIndexesResponse
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)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

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)

public create(string $projectId, Google_Service_Datastore_GoogleDatastoreAdminV1Index $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_GoogleLongrunningOperation
Parameters
$projectId : string

Project ID against which to make the request.

$postBody : Google_Service_Datastore_GoogleDatastoreAdminV1Index
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Datastore_GoogleLongrunningOperation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

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)

public delete(string $projectId, string $indexId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_GoogleLongrunningOperation
Parameters
$projectId : string

Project ID against which to make the request.

$indexId : string

The resource ID of the index to delete.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Datastore_GoogleLongrunningOperation —

listProjectsIndexes()

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)

public listProjectsIndexes(string $projectId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_GoogleDatastoreAdminV1ListIndexesResponse
Parameters
$projectId : string

Project ID against which to make the request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken The next_page_token value returned from a previous List request, if any.

opt_param

int pageSize The maximum number of items to return. If zero, then all results will be returned.

opt_param

string filter

Return values
Google_Service_Datastore_GoogleDatastoreAdminV1ListIndexesResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results