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
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ indexes
↳ 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.
setIndexes
The indexes supported for this field.
$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.
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.
var
bool
$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).
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).
var
string
$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
.
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
.
var
bool
$this
