Package com.google.firestore.admin.v1

Class Index.IndexField

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.Index.IndexField
All Implemented Interfaces:
Index.IndexFieldOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Index
public static final class Index.IndexField extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • FIELD_PATH_FIELD_NUMBER

      public static final int FIELD_PATH_FIELD_NUMBER
      See Also:

    • ORDER_FIELD_NUMBER

      public static final int ORDER_FIELD_NUMBER
      See Also:

    • ARRAY_CONFIG_FIELD_NUMBER

      public static final int ARRAY_CONFIG_FIELD_NUMBER
      See Also:

    • VECTOR_CONFIG_FIELD_NUMBER

      public static final int VECTOR_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getValueModeCase

      public Index.IndexField.ValueModeCase getValueModeCase()
      Specified by:
      getValueModeCase in interface Index.IndexFieldOrBuilder

    • 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;
      Specified by:
      getFieldPath in interface Index.IndexFieldOrBuilder
      Returns:
      The fieldPath.

    • getFieldPathBytes

      public com.google.protobuf.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;
      Specified by:
      getFieldPathBytes in interface Index.IndexFieldOrBuilder
      Returns:
      The bytes for fieldPath.

    • 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;
      Specified by:
      hasOrder in interface Index.IndexFieldOrBuilder
      Returns:
      Whether the order field is set.

    • 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;
      Specified by:
      getOrderValue in interface Index.IndexFieldOrBuilder
      Returns:
      The enum numeric value on the wire for order.

    • 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;
      Specified by:
      getOrder in interface Index.IndexFieldOrBuilder
      Returns:
      The order.

    • hasArrayConfig

      public boolean hasArrayConfig()
       Indicates that this field supports operations on `array_value`s.
      .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
      Specified by:
      hasArrayConfig in interface Index.IndexFieldOrBuilder
      Returns:
      Whether the arrayConfig field is set.

    • getArrayConfigValue

      public int getArrayConfigValue()
       Indicates that this field supports operations on `array_value`s.
      .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
      Specified by:
      getArrayConfigValue in interface Index.IndexFieldOrBuilder
      Returns:
      The enum numeric value on the wire for arrayConfig.

    • 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;
      Specified by:
      getArrayConfig in interface Index.IndexFieldOrBuilder
      Returns:
      The arrayConfig.

    • 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;
      Specified by:
      hasVectorConfig in interface Index.IndexFieldOrBuilder
      Returns:
      Whether the vectorConfig field is set.

    • 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;
      Specified by:
      getVectorConfig in interface Index.IndexFieldOrBuilder
      Returns:
      The vectorConfig.

    • 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;
      Specified by:
      getVectorConfigOrBuilder in interface Index.IndexFieldOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Index.IndexField parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Index.IndexField parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Index.IndexField parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Index.IndexField parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Index.IndexField parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Index.IndexField parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Index.IndexField parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Index.IndexField parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Index.IndexField parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Index.IndexField parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Index.IndexField parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Index.IndexField parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Index.IndexField.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Index.IndexField.Builder newBuilder()

    • newBuilder

      public static Index.IndexField.Builder newBuilder(Index.IndexField prototype)

    • toBuilder

      public Index.IndexField.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Index.IndexField.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Index.IndexField getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Index.IndexField> parser()

    • getParserForType

      public com.google.protobuf.Parser<Index.IndexField> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Index.IndexField getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder