com.google.firestore.admin.v1

Interface Field.IndexConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Field.IndexConfig, Field.IndexConfig.Builder

Enclosing class:

Field

public static interface Field.IndexConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAncestorField() Output only.
com.google.protobuf.ByteString	getAncestorFieldBytes() Output only.
Index	getIndexes(int index) The indexes supported for this field.
int	getIndexesCount() The indexes supported for this field.
List<Index>	getIndexesList() The indexes supported for this field.
IndexOrBuilder	getIndexesOrBuilder(int index) The indexes supported for this field.
List<? extends IndexOrBuilder>	getIndexesOrBuilderList() The indexes supported for this field.
boolean	getReverting() Output only When true, the `Field`'s index configuration is in the process of being reverted.
boolean	getUsesAncestorConfig() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getIndexesList

List<Index> getIndexesList()

 The indexes supported for this field.
 

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

getIndexes

Index getIndexes(int index)

 The indexes supported for this field.
 

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

getIndexesCount

int getIndexesCount()

 The indexes supported for this field.
 

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

getIndexesOrBuilderList

List<? extends IndexOrBuilder> getIndexesOrBuilderList()

 The indexes supported for this field.
 

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

getIndexesOrBuilder

IndexOrBuilder getIndexesOrBuilder(int index)

 The indexes supported for this field.
 

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

getUsesAncestorConfig

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:

The usesAncestorConfig.

getAncestorField

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:

The ancestorField.

getAncestorFieldBytes

com.google.protobuf.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:

The bytes for ancestorField.

getReverting

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:

The reverting.