Class MultiTermVectorsRequestParameters

Request options for MultiTermVectors

https://opensearch.org/docs/latest

Inheritance

object

RequestParameters<MultiTermVectorsRequestParameters>

MultiTermVectorsRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<MultiTermVectorsRequestParameters>.CustomResponseBuilder

RequestParameters<MultiTermVectorsRequestParameters>.QueryString

RequestParameters<MultiTermVectorsRequestParameters>.RequestConfiguration

RequestParameters<MultiTermVectorsRequestParameters>.ContainsQueryString(string)

RequestParameters<MultiTermVectorsRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<MultiTermVectorsRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<MultiTermVectorsRequestParameters>.SetQueryString(string, object)

RequestParameters<MultiTermVectorsRequestParameters>.Q<TOut>(string)

RequestParameters<MultiTermVectorsRequestParameters>.Q(string, object)

RequestParameters<MultiTermVectorsRequestParameters>.SetAcceptHeader(string)

RequestParameters<MultiTermVectorsRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net

Assembly: OpenSearch.Net.dll

Syntax

public class MultiTermVectorsRequestParameters : RequestParameters<MultiTermVectorsRequestParameters>, IRequestParameters

Properties

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<MultiTermVectorsRequestParameters>.DefaultHttpMethod

FieldStatistics

If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.

Declaration

public bool? FieldStatistics { get; set; }

Property Value

Type	Description
bool?

Fields

A comma-separated list or a wildcard expression specifying the fields to include in the statistics. Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters.

Declaration

public string[] Fields { get; set; }

Property Value

Type	Description
string[]

Offsets

If true, the response includes term offsets.

Declaration

public bool? Offsets { get; set; }

Property Value

Type	Description
bool?

Payloads

If true, the response includes term payloads.

Declaration

public bool? Payloads { get; set; }

Property Value

Type	Description
bool?

Positions

If true, the response includes term positions.

Declaration

public bool? Positions { get; set; }

Property Value

Type	Description
bool?

Preference

Specifies the node or shard on which the operation should be performed. See preference query parameter for a list of available options. By default the requests are routed randomly to available shard copies (primary or replica), with no guarantee of consistency across repeated queries.

Declaration

public string Preference { get; set; }

Property Value

Type	Description
string

Realtime

If true, the request is real-time as opposed to near-real-time.

Declaration

public bool? Realtime { get; set; }

Property Value

Type	Description
bool?

Routing

A custom value used to route operations to a specific shard.

Declaration

public string[] Routing { get; set; }

Property Value

Type	Description
string[]

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<MultiTermVectorsRequestParameters>.SupportsBody

TermStatistics

If true, the response includes term frequency and document frequency.

Declaration

public bool? TermStatistics { get; set; }

Property Value

Type	Description
bool?

Version

If true, returns the document version as part of a hit.

Declaration

public long? Version { get; set; }

Property Value

Type	Description
long?

VersionType

The specific version type.

Declaration

public VersionType? VersionType { get; set; }

Property Value

Type	Description
VersionType?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)