Package com.google.firestore.admin.v1

Class Index.IndexField.Builder

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

  • 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.Builder<Index.IndexField.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Index.IndexField.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Index.IndexField.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Index.IndexField.Builder>

    • mergeFrom

      public Index.IndexField.Builder mergeFrom(Index.IndexField other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Index.IndexField.Builder>

    • mergeFrom

      public Index.IndexField.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Index.IndexField.Builder>
      Throws:
      IOException

    • getValueModeCase

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

    • clearValueMode

      public Index.IndexField.Builder clearValueMode()

    • 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.

    • setFieldPath

      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;
      Parameters:
      value - The fieldPath to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setFieldPathBytes

      public Index.IndexField.Builder setFieldPathBytes(com.google.protobuf.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;
      Parameters:
      value - The bytes for fieldPath to set.
      Returns:
      This builder for chaining.

    • 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.

    • setOrderValue

      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;
      Parameters:
      value - The enum numeric value on the wire for order to set.
      Returns:
      This builder for chaining.

    • 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.

    • setOrder

      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;
      Parameters:
      value - The order to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • 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.

    • setArrayConfigValue

      public Index.IndexField.Builder setArrayConfigValue(int value)
       Indicates that this field supports operations on `array_value`s.
      .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
      Parameters:
      value - The enum numeric value on the wire for arrayConfig to set.
      Returns:
      This builder for chaining.

    • 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.

    • setArrayConfig

      public Index.IndexField.Builder setArrayConfig(Index.IndexField.ArrayConfig value)
       Indicates that this field supports operations on `array_value`s.
      .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
      Parameters:
      value - The arrayConfig to set.
      Returns:
      This builder for chaining.

    • clearArrayConfig

      public Index.IndexField.Builder clearArrayConfig()
       Indicates that this field supports operations on `array_value`s.
      .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
      Returns:
      This builder for chaining.

    • 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.

    • setVectorConfig

      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;

    • setVectorConfig

      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;

    • mergeVectorConfig

      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;

    • 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;

    • 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;

    • 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