Cloud Firestore V1 Client - Class Index (1.33.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class Index.

Cloud Firestore indexes enable simple and complex queries against documents in a database.

Generated from protobuf message google.firestore.admin.v1.Index

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.

↳ query_scope int

Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.

↳ api_scope int

The API scope supported by this index.

↳ fields array<Google\Cloud\Firestore\Admin\V1\Index\IndexField>

The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.

↳ state int

Output only. The serving state of the index.

getName

Output only. A server defined name for this index.

The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.

Returns
TypeDescription
string

setName

Output only. A server defined name for this index.

The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getQueryScope

Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id.

Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.

Returns
TypeDescription
int

setQueryScope

Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id.

Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getApiScope

The API scope supported by this index.

Returns
TypeDescription
int

setApiScope

The API scope supported by this index.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFields

The fields supported by this index.

For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFields

The fields supported by this index.

For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.

Parameter
NameDescription
var array<Google\Cloud\Firestore\Admin\V1\Index\IndexField>
Returns
TypeDescription
$this

getState

Output only. The serving state of the index.

Returns
TypeDescription
int

setState

Output only. The serving state of the index.

Parameter
NameDescription
var int
Returns
TypeDescription
$this