public static final class Index.IndexField extends GeneratedMessageV3 implements Index.IndexFieldOrBuilder
A 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
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
ARRAY_CONFIG_FIELD_NUMBER
public static final int ARRAY_CONFIG_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
FIELD_PATH_FIELD_NUMBER
public static final int FIELD_PATH_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
ORDER_FIELD_NUMBER
public static final int ORDER_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
VECTOR_CONFIG_FIELD_NUMBER
public static final int VECTOR_CONFIG_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Index.IndexField getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Index.IndexField.Builder newBuilder()
newBuilder(Index.IndexField prototype)
public static Index.IndexField.Builder newBuilder(Index.IndexField prototype)
public static Index.IndexField parseDelimitedFrom(InputStream input)
public static Index.IndexField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Index.IndexField parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Index.IndexField parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField parseFrom(CodedInputStream input)
public static Index.IndexField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField parseFrom(InputStream input)
public static Index.IndexField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Index.IndexField parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Index.IndexField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Index.IndexField> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getArrayConfig()
public Index.IndexField.ArrayConfig getArrayConfig()
Indicates that this field supports operations on array_value
s.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
getArrayConfigValue()
public int getArrayConfigValue()
Indicates that this field supports operations on array_value
s.
.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()
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;
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.
|
getParserForType()
public Parser<Index.IndexField> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
getValueModeCase()
public Index.IndexField.ValueModeCase getValueModeCase()
getVectorConfig()
public Index.IndexField.VectorConfig getVectorConfig()
Indicates that this field supports nearest neighbors and distance
operations on vector.
.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;
getVectorConfigOrBuilder()
public Index.IndexField.VectorConfigOrBuilder getVectorConfigOrBuilder()
Indicates that this field supports nearest neighbors and distance
operations on vector.
.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;
hasArrayConfig()
public boolean hasArrayConfig()
Indicates that this field supports operations on array_value
s.
.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 neighbors 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.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Index.IndexField.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Index.IndexField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public Index.IndexField.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides