Class Index (3.5.0)

Stay organized with collections Save and categorize content based on your preferences.
public final class Index extends GeneratedMessageV3 implements IndexOrBuilder

Cloud Firestore indexes enable simple and complex queries against documents in a database.

Protobuf type google.firestore.admin.v1.Index

Implements

IndexOrBuilder

Static Fields

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_SCOPE_FIELD_NUMBER

public static final int QUERY_SCOPE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Index getDefaultInstance()
Returns
TypeDescription
Index

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Index.Builder newBuilder()
Returns
TypeDescription
Index.Builder

newBuilder(Index prototype)

public static Index.Builder newBuilder(Index prototype)
Parameter
NameDescription
prototypeIndex
Returns
TypeDescription
Index.Builder

parseDelimitedFrom(InputStream input)

public static Index parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Index
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Index parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Index parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Index
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Index parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Index parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Index
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Index parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Index parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Index
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Index parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Index parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Index
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Index parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Index parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Index
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Index parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Index> parser()
Returns
TypeDescription
Parser<Index>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Index getDefaultInstanceForType()
Returns
TypeDescription
Index

getFields(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
Index.IndexField

getFieldsCount()

public 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
TypeDescription
int

getFieldsList()

public 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
TypeDescription
List<IndexField>

getFieldsOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
Index.IndexFieldOrBuilder

getFieldsOrBuilderList()

public 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
TypeDescription
List<? extends com.google.firestore.admin.v1.Index.IndexFieldOrBuilder>

getName()

public 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
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Index> getParserForType()
Returns
TypeDescription
Parser<Index>
Overrides

getQueryScope()

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

The queryScope.

getQueryScopeValue()

public 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
TypeDescription
int

The enum numeric value on the wire for queryScope.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public Index.State getState()

Output only. The serving state of the index.

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

Returns
TypeDescription
Index.State

The state.

getStateValue()

public int getStateValue()

Output only. The serving state of the index.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Index.Builder newBuilderForType()
Returns
TypeDescription
Index.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Index.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Index.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Index.Builder toBuilder()
Returns
TypeDescription
Index.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException