Firestore Admin v1 API - Class Index.Types.SearchIndexOptions (3.19.0)

public sealed class Index.Types.SearchIndexOptions : IMessage<Index.Types.SearchIndexOptions>, IEquatable<Index.Types.SearchIndexOptions>, IDeepCloneable<Index.Types.SearchIndexOptions>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class Index.Types.SearchIndexOptions.

Options for search indexes at the definition level.

Inheritance

object > Index.Types.SearchIndexOptions

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

SearchIndexOptions()

public SearchIndexOptions()

SearchIndexOptions(SearchIndexOptions)

public SearchIndexOptions(Index.Types.SearchIndexOptions other)
Parameter
Name Description
other IndexTypesSearchIndexOptions

Properties

TextLanguage

public string TextLanguage { get; set; }

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.

Property Value
Type Description
string

TextLanguageOverrideFieldPath

public string TextLanguageOverrideFieldPath { get; set; }

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.

Property Value
Type Description
string