Package com.google.firestore.admin.v1

Class Index.SearchIndexOptions.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Index.SearchIndexOptions.Builder>
com.google.firestore.admin.v1.Index.SearchIndexOptions.Builder
All Implemented Interfaces:
Index.SearchIndexOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Index.SearchIndexOptions
public static final class Index.SearchIndexOptions.Builder extends com.google.protobuf.GeneratedMessage.Builder<Index.SearchIndexOptions.Builder> implements Index.SearchIndexOptionsOrBuilder
 Options for search indexes at the definition level.
Protobuf type google.firestore.admin.v1.Index.SearchIndexOptions

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

    • clear

      public Index.SearchIndexOptions.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.SearchIndexOptions.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.SearchIndexOptions.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Index.SearchIndexOptions.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.SearchIndexOptions.Builder>

    • mergeFrom

      public Index.SearchIndexOptions.Builder mergeFrom(Index.SearchIndexOptions 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.SearchIndexOptions.Builder>

    • mergeFrom

      public Index.SearchIndexOptions.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.SearchIndexOptions.Builder>
      Throws:
      IOException

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

    • setTextLanguage

      public Index.SearchIndexOptions.Builder setTextLanguage(String value)
       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];
      Parameters:
      value - The textLanguage to set.
      Returns:
      This builder for chaining.

    • clearTextLanguage

      public Index.SearchIndexOptions.Builder clearTextLanguage()
       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];
      Returns:
      This builder for chaining.

    • setTextLanguageBytes

      public Index.SearchIndexOptions.Builder setTextLanguageBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for textLanguage to set.
      Returns:
      This builder for chaining.

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

    • setTextLanguageOverrideFieldPath

      public Index.SearchIndexOptions.Builder setTextLanguageOverrideFieldPath(String value)
       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];
      Parameters:
      value - The textLanguageOverrideFieldPath to set.
      Returns:
      This builder for chaining.

    • clearTextLanguageOverrideFieldPath

      public Index.SearchIndexOptions.Builder clearTextLanguageOverrideFieldPath()
       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];
      Returns:
      This builder for chaining.

    • setTextLanguageOverrideFieldPathBytes

      public Index.SearchIndexOptions.Builder setTextLanguageOverrideFieldPathBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for textLanguageOverrideFieldPath to set.
      Returns:
      This builder for chaining.