public interface IndexOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getApiScope()
public abstract Index.ApiScope getApiScope()The API scope supported by this index.
.google.firestore.admin.v1.Index.ApiScope api_scope = 5;
| Returns | |
|---|---|
| Type | Description |
Index.ApiScope |
The apiScope. |
getApiScopeValue()
public abstract 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. |
getDensity()
public abstract Index.Density getDensity()Immutable. The density configuration of the index.
.google.firestore.admin.v1.Index.Density density = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
Index.Density |
The density. |
getDensityValue()
public abstract 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 abstract 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 |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField |
|
getFieldsCount()
public abstract 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 abstract 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;
| 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 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 |
| Returns | |
|---|---|
| Type | Description |
Index.IndexFieldOrBuilder |
|
getFieldsOrBuilderList()
public abstract 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 abstract 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()
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. |
getShardCount()
public abstract 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 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. |