Class GoogleFirestoreAdminV1SearchIndexOptions

Options for search indexes at the definition level.

Inheritance

object

GoogleFirestoreAdminV1SearchIndexOptions

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Firestore.v1.Data

Assembly: Google.Apis.Firestore.v1.dll

Syntax

public class GoogleFirestoreAdminV1SearchIndexOptions : IDirectResponseSchema

Properties

CustomPartitionFieldPaths

Optional. Custom partition fields to use for the search index. If unspecified, all indexed fields will be in the same default partition. If a search index is created specifying custom partition fields, all search queries using that index will be required to filter on the partition. For indexes with MONGODB_COMPATIBLE_API ApiScope: This must refer to a top level field name.

Declaration

[JsonProperty("customPartitionFieldPaths")]
public virtual IList<string> CustomPartitionFieldPaths { get; set; }

Property Value

Type	Description
IList<string>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

TextLanguage

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.

Declaration

[JsonProperty("textLanguage")]
public virtual string TextLanguage { get; set; }

Property Value

Type	Description
string

TextLanguageOverrideFieldPath

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.

Declaration

[JsonProperty("textLanguageOverrideFieldPath")]
public virtual string TextLanguageOverrideFieldPath { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema