Documentation

Google_Service_Firestore_Resource_ProjectsDatabasesCollectionGroupsIndexes extends Google_Service_Resource
in package

The "indexes" collection of methods.

Typical usage is: $firestoreService = new Google_Service_Firestore(...); $indexes = $firestoreService->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_Firestore_GoogleLongrunningOperation
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. (indexes.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Firestore_FirestoreEmpty
Deletes a composite index. (indexes.delete)
get()  : Google_Service_Firestore_GoogleFirestoreAdminV1Index
Gets a composite index. (indexes.get)
listProjectsDatabasesCollectionGroupsIndexes()  : Google_Service_Firestore_GoogleFirestoreAdminV1ListIndexesResponse
Lists composite indexes.
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 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. (indexes.create)

public create(string $parent, Google_Service_Firestore_GoogleFirestoreAdminV1Index $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Firestore_GoogleLongrunningOperation
Parameters
$parent : string

Required. A parent name of the form projects/{project_ id}/databases/{database_id}/collectionGroups/{collection_id}

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

Optional parameters.

Return values
Google_Service_Firestore_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 a composite index. (indexes.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Firestore_FirestoreEmpty
Parameters
$name : string

Required. A name of the form projects/{project_id}/datab ases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

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

Optional parameters.

Return values
Google_Service_Firestore_FirestoreEmpty —

get()

Gets a composite index. (indexes.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Firestore_GoogleFirestoreAdminV1Index
Parameters
$name : string

Required. A name of the form projects/{project_id}/datab ases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

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

Optional parameters.

Return values
Google_Service_Firestore_GoogleFirestoreAdminV1Index —

listProjectsDatabasesCollectionGroupsIndexes()

Lists composite indexes.

public listProjectsDatabasesCollectionGroupsIndexes(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Firestore_GoogleFirestoreAdminV1ListIndexesResponse

(indexes.listProjectsDatabasesCollectionGroupsIndexes)

Parameters
$parent : string

Required. A parent name of the form projects/{project_ id}/databases/{database_id}/collectionGroups/{collection_id}

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

Optional parameters.

Tags
opt_param

int pageSize The number of results to return.

opt_param

string filter The filter to apply to list results.

opt_param

string pageToken A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

Return values
Google_Service_Firestore_GoogleFirestoreAdminV1ListIndexesResponse —

convertToArrayAndStripNulls()

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

Search results