Interface Field.IndexConfigOrBuilder (3.12.1)

Version 3.12.1

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static interface Field.IndexConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAncestorField()

public abstract String 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 ancestor_field = 3;

Returns
Type	Description
String	The ancestorField.

getAncestorFieldBytes()

public abstract ByteString getAncestorFieldBytes()

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 ancestor_field = 3;

Returns
Type	Description
ByteString	The bytes for ancestorField.

getIndexes(int index)

public abstract Index getIndexes(int index)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Index

getIndexesCount()

public abstract int getIndexesCount()

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Returns
Type	Description
int

getIndexesList()

public abstract List<Index> getIndexesList()

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Returns
Type	Description
List<Index>

getIndexesOrBuilder(int index)

public abstract IndexOrBuilder getIndexesOrBuilder(int index)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
IndexOrBuilder

getIndexesOrBuilderList()

public abstract List<? extends IndexOrBuilder> getIndexesOrBuilderList()

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Returns
Type	Description
List<? extends com.google.firestore.admin.v1.IndexOrBuilder>

getReverting()

public abstract boolean 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 reverting = 4;

Returns
Type	Description
boolean	The reverting.

getUsesAncestorConfig()

public abstract boolean 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 uses_ancestor_config = 2;

Returns
Type	Description
boolean	The usesAncestorConfig.