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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
API_SCOPE_FIELD_NUMBER
public static final int API_SCOPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DENSITY_FIELD_NUMBER
public static final int DENSITY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MULTIKEY_FIELD_NUMBER
public static final int MULTIKEY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUERY_SCOPE_FIELD_NUMBER
public static final int QUERY_SCOPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SHARD_COUNT_FIELD_NUMBER
public static final int SHARD_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Index getDefaultInstance()
| Returns |
| Type |
Description |
Index |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Index.Builder newBuilder()
newBuilder(Index prototype)
public static Index.Builder newBuilder(Index prototype)
| Parameter |
| Name |
Description |
prototype |
Index
|
public static Index parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Index |
|
public static Index parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Index |
|
parseFrom(byte[] data)
public static Index parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Index |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Index parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Index |
|
parseFrom(ByteString data)
public static Index parseFrom(ByteString data)
| Returns |
| Type |
Description |
Index |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Index parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Index |
|
public static Index parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Index |
|
public static Index parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Index |
|
public static Index parseFrom(InputStream input)
| Returns |
| Type |
Description |
Index |
|
public static Index parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Index |
|
parseFrom(ByteBuffer data)
public static Index parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Index |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Index parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Index |
|
parser()
public static Parser<Index> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getApiScope()
public Index.ApiScope getApiScope()
The API scope supported by this index.
.google.firestore.admin.v1.Index.ApiScope api_scope = 5;
getApiScopeValue()
public int getApiScopeValue()
The API scope supported by this index.
.google.firestore.admin.v1.Index.ApiScope api_scope = 5;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for apiScope.
|
getDefaultInstanceForType()
public Index getDefaultInstanceForType()
| Returns |
| Type |
Description |
Index |
|
getDensity()
public Index.Density getDensity()
Immutable. The density configuration of the index.
.google.firestore.admin.v1.Index.Density density = 6 [(.google.api.field_behavior) = IMMUTABLE];
getDensityValue()
public int getDensityValue()
Immutable. The density configuration of the index.
.google.firestore.admin.v1.Index.Density density = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for density.
|
getFields(int index)
public Index.IndexField getFields(int index)
The fields supported by this index.
For composite indexes, this requires a minimum of 2 and a maximum of 100
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
|
getFieldsCount()
public int getFieldsCount()
The fields supported by this index.
For composite indexes, this requires a minimum of 2 and a maximum of 100
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 List<Index.IndexField> getFieldsList()
The fields supported by this index.
For composite indexes, this requires a minimum of 2 and a maximum of 100
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 requires a minimum of 2 and a maximum of 100
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
|
getFieldsOrBuilderList()
public List<? extends Index.IndexFieldOrBuilder> getFieldsOrBuilderList()
The fields supported by this index.
For composite indexes, this requires a minimum of 2 and a maximum of 100
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> |
|
getMultikey()
public boolean getMultikey()
Optional. Whether the index is multikey. By default, the index is not
multikey. For non-multikey indexes, none of the paths in the index
definition reach or traverse an array, except via an explicit array index.
For multikey indexes, at most one of the paths in the index definition
reach or traverse an array, except via an explicit array index. Violations
will result in errors.
Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope.
bool multikey = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The multikey.
|
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 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.
|
getParserForType()
public Parser<Index> getParserForType()
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;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for queryScope.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getShardCount()
public int getShardCount()
Optional. The number of shards for the index.
int32 shard_count = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The shardCount.
|
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;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Index.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Index.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Index.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
