Interface Index.IndexFieldOrBuilder (3.30.2)

Version latest

• 3.30.2 (latest)
• 3.30.0
• 3.28.0
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static interface Index.IndexFieldOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getArrayConfig()

public abstract 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 abstract 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.

getFieldPath()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Index.IndexField.ValueModeCase getValueModeCase()

Returns
Type	Description
Index.IndexField.ValueModeCase

getVectorConfig()

public abstract 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.

getVectorConfigOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.