Cloud Firestore V1 Client - Class IndexConfig (1.54.2)

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

The index configuration for this field.

Generated from protobuf message google.firestore.admin.v1.Field.IndexConfig

Namespace

Google \ Cloud \ Firestore \ Admin \ V1 \ Field

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ indexes array<Google\Cloud\Firestore\Admin\V1\Index>

The indexes supported for this field.
↳ uses_ancestor_config bool

Output only. When true, the Field's index configuration is set from the configuration specified by the ancestor_field. When false, the Field's index configuration is defined explicitly.
↳ ancestor_field string

Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).
↳ reverting bool

Output only When true, the Field's index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by ancestor_field, at which point uses_ancestor_config will be true and reverting will be false.

getIndexes

The indexes supported for this field.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setIndexes

The indexes supported for this field.

Parameter
Name Description
var array<Google\Cloud\Firestore\Admin\V1\Index>
Returns
Type Description
$this

getUsesAncestorConfig

Output only. When true, the Field's index configuration is set from the configuration specified by the ancestor_field.

When false, the Field's index configuration is defined explicitly.

Returns
Type Description
bool

setUsesAncestorConfig

Output only. When true, the Field's index configuration is set from the configuration specified by the ancestor_field.

When false, the Field's index configuration is defined explicitly.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAncestorField

Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).

Returns
Type Description
string

setAncestorField

Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).

Parameter
Name Description
var string
Returns
Type Description
$this

getReverting

Output only When true, the Field's index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by ancestor_field, at which point uses_ancestor_config will be true and reverting will be false.

Returns
Type Description
bool

setReverting

Output only When true, the Field's index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by ancestor_field, at which point uses_ancestor_config will be true and reverting will be false.

Parameter
Name Description
var bool
Returns
Type Description
$this