public static final class Index.IndexField.Builder extends GeneratedMessageV3.Builder<Index.IndexField.Builder> implements Index.IndexFieldOrBuilderA field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
Protobuf type google.firestore.admin.v1.Index.IndexField
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Index.IndexField.BuilderImplements
Index.IndexFieldOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Index.IndexField.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
build()
public Index.IndexField build()| Returns | |
|---|---|
| Type | Description |
Index.IndexField |
|
buildPartial()
public Index.IndexField buildPartial()| Returns | |
|---|---|
| Type | Description |
Index.IndexField |
|
clear()
public Index.IndexField.Builder clear()| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
clearArrayConfig()
public Index.IndexField.Builder clearArrayConfig() Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Index.IndexField.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
clearFieldPath()
public Index.IndexField.Builder clearFieldPath()Can be name. For single field indexes, this must match the name of the field or may be omitted.
string field_path = 1;
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Index.IndexField.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
clearOrder()
public Index.IndexField.Builder clearOrder()Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
.google.firestore.admin.v1.Index.IndexField.Order order = 2;
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
This builder for chaining. |
clearValueMode()
public Index.IndexField.Builder clearValueMode()| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
clearVectorConfig()
public Index.IndexField.Builder clearVectorConfig()Indicates that this field supports nearest neighbor and distance operations on vector.
.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
clone()
public Index.IndexField.Builder clone()| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
getArrayConfig()
public Index.IndexField.ArrayConfig getArrayConfig() Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.ArrayConfig |
The arrayConfig. |
getArrayConfigValue()
public int getArrayConfigValue() Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for arrayConfig. |
getDefaultInstanceForType()
public Index.IndexField getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Index.IndexField |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFieldPath()
public String getFieldPath()Can be name. For single field indexes, this must match the name of the field or may be omitted.
string field_path = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The fieldPath. |
getFieldPathBytes()
public ByteString getFieldPathBytes()Can be name. For single field indexes, this must match the name of the field or may be omitted.
string field_path = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for fieldPath. |
getOrder()
public Index.IndexField.Order getOrder()Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
.google.firestore.admin.v1.Index.IndexField.Order order = 2;
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Order |
The order. |
getOrderValue()
public int getOrderValue()Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
.google.firestore.admin.v1.Index.IndexField.Order order = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for order. |
getValueModeCase()
public Index.IndexField.ValueModeCase getValueModeCase()| Returns | |
|---|---|
| Type | Description |
Index.IndexField.ValueModeCase |
|
getVectorConfig()
public Index.IndexField.VectorConfig getVectorConfig()Indicates that this field supports nearest neighbor and distance operations on vector.
.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.VectorConfig |
The vectorConfig. |
getVectorConfigBuilder()
public Index.IndexField.VectorConfig.Builder getVectorConfigBuilder()Indicates that this field supports nearest neighbor and distance operations on vector.
.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.VectorConfig.Builder |
|
getVectorConfigOrBuilder()
public Index.IndexField.VectorConfigOrBuilder getVectorConfigOrBuilder()Indicates that this field supports nearest neighbor and distance operations on vector.
.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.VectorConfigOrBuilder |
|
hasArrayConfig()
public boolean hasArrayConfig() Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the arrayConfig field is set. |
hasOrder()
public boolean hasOrder()Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
.google.firestore.admin.v1.Index.IndexField.Order order = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the order field is set. |
hasVectorConfig()
public boolean hasVectorConfig()Indicates that this field supports nearest neighbor and distance operations on vector.
.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the vectorConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Index.IndexField other)
public Index.IndexField.Builder mergeFrom(Index.IndexField other)| Parameter | |
|---|---|
| Name | Description |
other |
Index.IndexField |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Index.IndexField.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Index.IndexField.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Index.IndexField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
mergeVectorConfig(Index.IndexField.VectorConfig value)
public Index.IndexField.Builder mergeVectorConfig(Index.IndexField.VectorConfig value)Indicates that this field supports nearest neighbor and distance operations on vector.
.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Index.IndexField.VectorConfig |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
setArrayConfig(Index.IndexField.ArrayConfig value)
public Index.IndexField.Builder setArrayConfig(Index.IndexField.ArrayConfig value) Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
Index.IndexField.ArrayConfigThe arrayConfig to set. |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
This builder for chaining. |
setArrayConfigValue(int value)
public Index.IndexField.Builder setArrayConfigValue(int value) Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for arrayConfig to set. |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Index.IndexField.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
setFieldPath(String value)
public Index.IndexField.Builder setFieldPath(String value)Can be name. For single field indexes, this must match the name of the field or may be omitted.
string field_path = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe fieldPath to set. |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
This builder for chaining. |
setFieldPathBytes(ByteString value)
public Index.IndexField.Builder setFieldPathBytes(ByteString value)Can be name. For single field indexes, this must match the name of the field or may be omitted.
string field_path = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for fieldPath to set. |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
This builder for chaining. |
setOrder(Index.IndexField.Order value)
public Index.IndexField.Builder setOrder(Index.IndexField.Order value)Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
.google.firestore.admin.v1.Index.IndexField.Order order = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Index.IndexField.OrderThe order to set. |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
This builder for chaining. |
setOrderValue(int value)
public Index.IndexField.Builder setOrderValue(int value)Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
.google.firestore.admin.v1.Index.IndexField.Order order = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for order to set. |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Index.IndexField.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Index.IndexField.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
setVectorConfig(Index.IndexField.VectorConfig value)
public Index.IndexField.Builder setVectorConfig(Index.IndexField.VectorConfig value)Indicates that this field supports nearest neighbor and distance operations on vector.
.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Index.IndexField.VectorConfig |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|
setVectorConfig(Index.IndexField.VectorConfig.Builder builderForValue)
public Index.IndexField.Builder setVectorConfig(Index.IndexField.VectorConfig.Builder builderForValue)Indicates that this field supports nearest neighbor and distance operations on vector.
.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Index.IndexField.VectorConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Index.IndexField.Builder |
|