Package com.google.firestore.admin.v1

Class Index.SearchIndexOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.Index.SearchIndexOptions
All Implemented Interfaces:
Index.SearchIndexOptionsOrBuilder, 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.SearchIndexOptions extends com.google.protobuf.GeneratedMessage implements Index.SearchIndexOptionsOrBuilder
 Options for search indexes at the definition level.
Protobuf type google.firestore.admin.v1.Index.SearchIndexOptions
See Also:

  • Field Details

    • TEXT_LANGUAGE_FIELD_NUMBER

      public static final int TEXT_LANGUAGE_FIELD_NUMBER
      See Also:

    • TEXT_LANGUAGE_OVERRIDE_FIELD_PATH_FIELD_NUMBER

      public static final int TEXT_LANGUAGE_OVERRIDE_FIELD_PATH_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

    • getTextLanguage

      public String getTextLanguage()
       Optional. The language to use for text search indexes. Used as the
 default language if not overridden at the document level by specifying
 the `text_language_override_field`. The language is specified as a BCP 47
 language code.
 For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the
 default language is English.
 For indexes with `ANY_API` ApiScope: If unspecified, the default behavior
 is autodetect.
      string text_language = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTextLanguage in interface Index.SearchIndexOptionsOrBuilder
      Returns:
      The textLanguage.

    • getTextLanguageBytes

      public com.google.protobuf.ByteString getTextLanguageBytes()
       Optional. The language to use for text search indexes. Used as the
 default language if not overridden at the document level by specifying
 the `text_language_override_field`. The language is specified as a BCP 47
 language code.
 For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the
 default language is English.
 For indexes with `ANY_API` ApiScope: If unspecified, the default behavior
 is autodetect.
      string text_language = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTextLanguageBytes in interface Index.SearchIndexOptionsOrBuilder
      Returns:
      The bytes for textLanguage.

    • getTextLanguageOverrideFieldPath

      public String getTextLanguageOverrideFieldPath()
       Optional. The field in the document that specifies which language to use
 for that specific document. For indexes with MONGODB_COMPATIBLE_API
 ApiScope: if unspecified, the language is taken from the "language" field
 if it exists or from `text_language` if it does not.
      string text_language_override_field_path = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTextLanguageOverrideFieldPath in interface Index.SearchIndexOptionsOrBuilder
      Returns:
      The textLanguageOverrideFieldPath.

    • getTextLanguageOverrideFieldPathBytes

      public com.google.protobuf.ByteString getTextLanguageOverrideFieldPathBytes()
       Optional. The field in the document that specifies which language to use
 for that specific document. For indexes with MONGODB_COMPATIBLE_API
 ApiScope: if unspecified, the language is taken from the "language" field
 if it exists or from `text_language` if it does not.
      string text_language_override_field_path = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTextLanguageOverrideFieldPathBytes in interface Index.SearchIndexOptionsOrBuilder
      Returns:
      The bytes for textLanguageOverrideFieldPath.

    • 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.SearchIndexOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Index.SearchIndexOptions 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.SearchIndexOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Index.SearchIndexOptions.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Index.SearchIndexOptions getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Index.SearchIndexOptions> 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.SearchIndexOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder