Interface IndexOrBuilder (3.6.0)

Version 3.6.0

• 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 interface IndexOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFields(int index)

public abstract Index.IndexField getFields(int index)

The fields supported by this index. For composite indexes, this is always 2 or more 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.

repeated .google.firestore.admin.v1.Index.IndexField fields = 3;

Parameter

Name	Description
index	int

Returns

Type	Description
Index.IndexField

getFieldsCount()

public abstract int getFieldsCount()

The fields supported by this index. For composite indexes, this is always 2 or more 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.

repeated .google.firestore.admin.v1.Index.IndexField fields = 3;

Returns

Type	Description
int

getFieldsList()

public abstract List<Index.IndexField> getFieldsList()

The fields supported by this index. For composite indexes, this is always 2 or more 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.

repeated .google.firestore.admin.v1.Index.IndexField fields = 3;

Returns

Type	Description
List<IndexField>

getFieldsOrBuilder(int index)

public abstract Index.IndexFieldOrBuilder getFieldsOrBuilder(int index)

The fields supported by this index. For composite indexes, this is always 2 or more 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.

repeated .google.firestore.admin.v1.Index.IndexField fields = 3;

Parameter

Name	Description
index	int

Returns

Type	Description
Index.IndexFieldOrBuilder

getFieldsOrBuilderList()

public abstract List<? extends Index.IndexFieldOrBuilder> getFieldsOrBuilderList()

The fields supported by this index. For composite indexes, this is always 2 or more 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.

repeated .google.firestore.admin.v1.Index.IndexField fields = 3;

Returns

Type	Description
List<? extends com.google.firestore.admin.v1.Index.IndexFieldOrBuilder>

getName()

public abstract String 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.

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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.

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getQueryScope()

public abstract Index.QueryScope 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.

.google.firestore.admin.v1.Index.QueryScope query_scope = 2;

Returns

Type	Description
Index.QueryScope	The queryScope.

getQueryScopeValue()

public abstract int getQueryScopeValue()

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.

.google.firestore.admin.v1.Index.QueryScope query_scope = 2;

Returns

Type	Description
int	The enum numeric value on the wire for queryScope.

getState()

public abstract Index.State getState()

Output only. The serving state of the index.

.google.firestore.admin.v1.Index.State state = 4;

Returns

Type	Description
Index.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The serving state of the index.

.google.firestore.admin.v1.Index.State state = 4;

Returns

Type	Description
int	The enum numeric value on the wire for state.