Class MultiTermVectorsDescriptor

A Multi termvectors API request

Inheritance

object

RequestBase<MultiTermVectorsRequestParameters>

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>

MultiTermVectorsDescriptor

Implements

IDescriptor

IMultiTermVectorsRequest

IRequest<MultiTermVectorsRequestParameters>

IRequest

Inherited Members

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>.Self

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>.Assign<TValue>(TValue, Action<IMultiTermVectorsRequest, TValue>)

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>.Qs(string, object)

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>.ErrorTrace(bool?)

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>.FilterPath(params string[])

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>.FilterPath(IEnumerable<string>)

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>.Human(bool?)

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>.Pretty(bool?)

RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>.SourceQueryString(string)

RequestBase<MultiTermVectorsRequestParameters>.HttpMethod

RequestBase<MultiTermVectorsRequestParameters>.RequestState

RequestBase<MultiTermVectorsRequestParameters>.ContentType

RequestBase<MultiTermVectorsRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<MultiTermVectorsRequestParameters>.RequestDefaults(MultiTermVectorsRequestParameters)

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

RequestBase<MultiTermVectorsRequestParameters>.Q(string, object)

RequestBase<MultiTermVectorsRequestParameters>.SetAcceptHeader(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class MultiTermVectorsDescriptor : RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>, IDescriptor, IMultiTermVectorsRequest, IRequest<MultiTermVectorsRequestParameters>, IRequest

Constructors

MultiTermVectorsDescriptor()

/_mtermvectors

Declaration

public MultiTermVectorsDescriptor()

MultiTermVectorsDescriptor(IndexName)

/{index}/_mtermvectors

Declaration

public MultiTermVectorsDescriptor(IndexName index)

Parameters

Type	Name	Description
IndexName	index	Optional, accepts null

Methods

Documents<T>(IEnumerable<Id>, Func<MultiTermVectorOperationDescriptor<T>, Id, IMultiTermVectorOperation>)

The documents for which to generate term vectors

Declaration

public MultiTermVectorsDescriptor Documents<T>(IEnumerable<Id> ids, Func<MultiTermVectorOperationDescriptor<T>, Id, IMultiTermVectorOperation> getSelector = null) where T : class

Parameters

Type	Name	Description
IEnumerable<Id>	ids
Func<MultiTermVectorOperationDescriptor<T>, Id, IMultiTermVectorOperation>	getSelector

Returns

Type	Description
MultiTermVectorsDescriptor

Type Parameters

Name	Description
T

Documents<T>(IEnumerable<long>, Func<MultiTermVectorOperationDescriptor<T>, long, IMultiTermVectorOperation>)

The documents for which to generate term vectors

Declaration

public MultiTermVectorsDescriptor Documents<T>(IEnumerable<long> ids, Func<MultiTermVectorOperationDescriptor<T>, long, IMultiTermVectorOperation> selector = null) where T : class

Parameters

Type	Name	Description
IEnumerable<long>	ids
Func<MultiTermVectorOperationDescriptor<T>, long, IMultiTermVectorOperation>	selector

Returns

Type	Description
MultiTermVectorsDescriptor

Type Parameters

Name	Description
T

Documents<T>(IEnumerable<string>, Func<MultiTermVectorOperationDescriptor<T>, string, IMultiTermVectorOperation>)

The documents for which to generate term vectors

Declaration

public MultiTermVectorsDescriptor Documents<T>(IEnumerable<string> ids, Func<MultiTermVectorOperationDescriptor<T>, string, IMultiTermVectorOperation> getSelector = null) where T : class

Parameters

Type	Name	Description
IEnumerable<string>	ids
Func<MultiTermVectorOperationDescriptor<T>, string, IMultiTermVectorOperation>	getSelector

Returns

Type	Description
MultiTermVectorsDescriptor

Type Parameters

Name	Description
T

Documents<T>(Func<MultiTermVectorOperationDescriptor<T>, IMultiTermVectorOperation>)

A document for which to generate term vectors

Declaration

public MultiTermVectorsDescriptor Documents<T>(Func<MultiTermVectorOperationDescriptor<T>, IMultiTermVectorOperation> selector) where T : class

Parameters

Type	Name	Description
Func<MultiTermVectorOperationDescriptor<T>, IMultiTermVectorOperation>	selector

Returns

Type	Description
MultiTermVectorsDescriptor

Type Parameters

Name	Description
T

FieldStatistics(bool?)

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

Declaration

public MultiTermVectorsDescriptor FieldStatistics(bool? fieldstatistics = true)

Parameters

Type	Name	Description
bool?	fieldstatistics

Returns

Type	Description
MultiTermVectorsDescriptor

Fields(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 MultiTermVectorsDescriptor Fields(Fields fields)

Parameters

Type	Name	Description
Fields	fields

Returns

Type	Description
MultiTermVectorsDescriptor

Fields<T>(params Expression<Func<T, object>>[])

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 <c>completion_fields</c> or <c>fielddata_fields</c> parameters.

Declaration

public MultiTermVectorsDescriptor Fields<T>(params Expression<Func<T, object>>[] fields) where T : class

Parameters

Type	Name	Description
Expression<Func<T, object>>[]	fields

Returns

Type	Description
MultiTermVectorsDescriptor

Type Parameters

Name	Description
T

Ids(params Id[])

The ids of documents within the same index and type for which to generate term vectors. Must be used in conjunction with Index and Type

Declaration

public MultiTermVectorsDescriptor Ids(params Id[] ids)

Parameters

Type	Name	Description
Id[]	ids

Returns

Type	Description
MultiTermVectorsDescriptor

Ids(IEnumerable<Id>)

The ids of documents within the same index and type for which to generate term vectors. Must be used in conjunction with Index and Type

Declaration

public MultiTermVectorsDescriptor Ids(IEnumerable<Id> ids)

Parameters

Type	Name	Description
IEnumerable<Id>	ids

Returns

Type	Description
MultiTermVectorsDescriptor

Index(IndexName)

The name of the index that contains the document.

Declaration

public MultiTermVectorsDescriptor Index(IndexName index)

Parameters

Type	Name	Description
IndexName	index

Returns

Type	Description
MultiTermVectorsDescriptor

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration

public MultiTermVectorsDescriptor Index<TOther>() where TOther : class

Returns

Type	Description
MultiTermVectorsDescriptor

Type Parameters

Name	Description
TOther

Offsets(bool?)

If true, the response includes term offsets.

Declaration

public MultiTermVectorsDescriptor Offsets(bool? offsets = true)

Parameters

Type	Name	Description
bool?	offsets

Returns

Type	Description
MultiTermVectorsDescriptor

Payloads(bool?)

If true, the response includes term payloads.

Declaration

public MultiTermVectorsDescriptor Payloads(bool? payloads = true)

Parameters

Type	Name	Description
bool?	payloads

Returns

Type	Description
MultiTermVectorsDescriptor

Positions(bool?)

If true, the response includes term positions.

Declaration

public MultiTermVectorsDescriptor Positions(bool? positions = true)

Parameters

Type	Name	Description
bool?	positions

Returns

Type	Description
MultiTermVectorsDescriptor

Preference(string)

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 MultiTermVectorsDescriptor Preference(string preference)

Parameters

Type	Name	Description
string	preference

Returns

Type	Description
MultiTermVectorsDescriptor

Realtime(bool?)

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

Declaration

public MultiTermVectorsDescriptor Realtime(bool? realtime = true)

Parameters

Type	Name	Description
bool?	realtime

Returns

Type	Description
MultiTermVectorsDescriptor

Routing(Routing)

A document is routed to a particular shard in an index using the following formula

shard_num = hash(_routing) % num_primary_shards

OpenSearch will use the document id if not provided.

For requests that are constructed from/for a document OpenSearch.Client will automatically infer the routing key if that document has a JoinField or a routing mapping on for its type exists on ConnectionSettings

Declaration

public MultiTermVectorsDescriptor Routing(Routing routing)

Parameters

Type	Name	Description
Routing	routing

Returns

Type	Description
MultiTermVectorsDescriptor

TermStatistics(bool?)

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

Declaration

public MultiTermVectorsDescriptor TermStatistics(bool? termstatistics = true)

Parameters

Type	Name	Description
bool?	termstatistics

Returns

Type	Description
MultiTermVectorsDescriptor

Version(long?)

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

Declaration

public MultiTermVectorsDescriptor Version(long? version)

Parameters

Type	Name	Description
long?	version

Returns

Type	Description
MultiTermVectorsDescriptor

VersionType(VersionType?)

The specific version type.

Declaration

public MultiTermVectorsDescriptor VersionType(VersionType? versiontype)

Parameters

Type	Name	Description
VersionType?	versiontype

Returns

Type	Description
MultiTermVectorsDescriptor

Implements

IDescriptor

IMultiTermVectorsRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)