Package com.google.firestore.admin.v1

Interface Index.SearchIndexOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Index.SearchIndexOptions, Index.SearchIndexOptions.Builder
Enclosing class:
Index
public static interface Index.SearchIndexOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getTextLanguage()
    Optional.
    com.google.protobuf.ByteString
    getTextLanguageBytes()
    Optional.
    String
    getTextLanguageOverrideFieldPath()
    Optional.
    com.google.protobuf.ByteString
    getTextLanguageOverrideFieldPathBytes()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getTextLanguage

      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];
      Returns:
      The textLanguage.

    • getTextLanguageBytes

      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];
      Returns:
      The bytes for textLanguage.

    • getTextLanguageOverrideFieldPath

      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];
      Returns:
      The textLanguageOverrideFieldPath.

    • getTextLanguageOverrideFieldPathBytes

      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];
      Returns:
      The bytes for textLanguageOverrideFieldPath.