public static final class Index.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder> implements IndexOrBuilder
Cloud Firestore indexes enable simple and complex queries against documents in a database.Protobuf type
google.firestore.admin.v1.Index| Modifier and Type | Method and Description |
|---|---|
Index.Builder |
addAllFields(Iterable<? extends Index.IndexField> values)
The fields supported by this index.
|
Index.Builder |
addFields(Index.IndexField.Builder builderForValue)
The fields supported by this index.
|
Index.Builder |
addFields(Index.IndexField value)
The fields supported by this index.
|
Index.Builder |
addFields(int index,
Index.IndexField.Builder builderForValue)
The fields supported by this index.
|
Index.Builder |
addFields(int index,
Index.IndexField value)
The fields supported by this index.
|
Index.IndexField.Builder |
addFieldsBuilder()
The fields supported by this index.
|
Index.IndexField.Builder |
addFieldsBuilder(int index)
The fields supported by this index.
|
Index.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Index |
build() |
Index |
buildPartial() |
Index.Builder |
clear() |
Index.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Index.Builder |
clearFields()
The fields supported by this index.
|
Index.Builder |
clearName()
Output only.
|
Index.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Index.Builder |
clearQueryScope()
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.
|
Index.Builder |
clearState()
Output only.
|
Index.Builder |
clone() |
Index |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Index.IndexField |
getFields(int index)
The fields supported by this index.
|
Index.IndexField.Builder |
getFieldsBuilder(int index)
The fields supported by this index.
|
List<Index.IndexField.Builder> |
getFieldsBuilderList()
The fields supported by this index.
|
int |
getFieldsCount()
The fields supported by this index.
|
List<Index.IndexField> |
getFieldsList()
The fields supported by this index.
|
Index.IndexFieldOrBuilder |
getFieldsOrBuilder(int index)
The fields supported by this index.
|
List<? extends Index.IndexFieldOrBuilder> |
getFieldsOrBuilderList()
The fields supported by this index.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
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.
|
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.
|
Index.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Index.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Index.Builder |
mergeFrom(Index other) |
Index.Builder |
mergeFrom(com.google.protobuf.Message other) |
Index.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Index.Builder |
removeFields(int index)
The fields supported by this index.
|
Index.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Index.Builder |
setFields(int index,
Index.IndexField.Builder builderForValue)
The fields supported by this index.
|
Index.Builder |
setFields(int index,
Index.IndexField value)
The fields supported by this index.
|
Index.Builder |
setName(String value)
Output only.
|
Index.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Output only.
|
Index.Builder |
setQueryScope(Index.QueryScope value)
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.
|
Index.Builder |
setQueryScopeValue(int value)
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.
|
Index.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Index.Builder |
setState(Index.State value)
Output only.
|
Index.Builder |
setStateValue(int value)
Output only.
|
Index.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public Index.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public Index getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Index build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Index buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Index.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public Index.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public Index.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public Index.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public Index.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public Index.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public Index.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Index.Builder>public Index.Builder mergeFrom(Index other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public Index.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Index.Builder>IOExceptionpublic 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;getName in interface IndexOrBuilderpublic com.google.protobuf.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;getNameBytes in interface IndexOrBuilderpublic Index.Builder setName(String value)
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;value - The name to set.public Index.Builder clearName()
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;public Index.Builder setNameBytes(com.google.protobuf.ByteString value)
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;value - The bytes for name to set.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;getQueryScopeValue in interface IndexOrBuilderpublic Index.Builder setQueryScopeValue(int value)
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;value - The enum numeric value on the wire for queryScope to set.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;getQueryScope in interface IndexOrBuilderpublic Index.Builder setQueryScope(Index.QueryScope value)
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;value - The queryScope to set.public Index.Builder clearQueryScope()
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;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;getFieldsList in interface IndexOrBuilderpublic 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;getFieldsCount in interface IndexOrBuilderpublic 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;getFields in interface IndexOrBuilderpublic Index.Builder setFields(int index, Index.IndexField value)
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;public Index.Builder setFields(int index, Index.IndexField.Builder builderForValue)
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;public Index.Builder addFields(Index.IndexField value)
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;public Index.Builder addFields(int index, Index.IndexField value)
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;public Index.Builder addFields(Index.IndexField.Builder builderForValue)
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;public Index.Builder addFields(int index, Index.IndexField.Builder builderForValue)
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;public Index.Builder addAllFields(Iterable<? extends Index.IndexField> values)
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;public Index.Builder clearFields()
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;public Index.Builder removeFields(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;public Index.IndexField.Builder getFieldsBuilder(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;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;getFieldsOrBuilder in interface IndexOrBuilderpublic 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;getFieldsOrBuilderList in interface IndexOrBuilderpublic Index.IndexField.Builder addFieldsBuilder()
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;public Index.IndexField.Builder addFieldsBuilder(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;public List<Index.IndexField.Builder> getFieldsBuilderList()
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;public int getStateValue()
Output only. The serving state of the index.
.google.firestore.admin.v1.Index.State state = 4;getStateValue in interface IndexOrBuilderpublic Index.Builder setStateValue(int value)
Output only. The serving state of the index.
.google.firestore.admin.v1.Index.State state = 4;value - The enum numeric value on the wire for state to set.public Index.State getState()
Output only. The serving state of the index.
.google.firestore.admin.v1.Index.State state = 4;getState in interface IndexOrBuilderpublic Index.Builder setState(Index.State value)
Output only. The serving state of the index.
.google.firestore.admin.v1.Index.State state = 4;value - The state to set.public Index.Builder clearState()
Output only. The serving state of the index.
.google.firestore.admin.v1.Index.State state = 4;public final Index.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>public final Index.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>Copyright © 2020 Google LLC. All rights reserved.