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
Static Fields
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
QUERY_SCOPE_FIELD_NUMBER
public static final int QUERY_SCOPE_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Index getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Index.Builder newBuilder()
Returns
newBuilder(Index prototype)
public static Index.Builder newBuilder(Index prototype)
Parameter
| Name | Description |
prototype | Index
|
Returns
public static Index parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Index parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Index parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Index parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Index parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Index parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Index parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Index parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Index parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Index parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Index parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Index parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Index> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Index getDefaultInstanceForType()
Returns
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;
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;
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;
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;
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;
| Type | Description |
List<? extends com.google.firestore.admin.v1.Index.IndexFieldOrBuilder> | |
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;
| Type | Description |
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;
getParserForType()
public Parser<Index> getParserForType()
Returns
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;
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;
| Type | Description |
int | The enum numeric value on the wire for queryScope.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getState()
public Index.State getState()
Output only. The serving state of the index.
.google.firestore.admin.v1.Index.State state = 4;
getStateValue()
public int getStateValue()
Output only. The serving state of the index.
.google.firestore.admin.v1.Index.State state = 4;
| Type | Description |
int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Index.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Index.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Index.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
