Class MultiTermVectorsDescriptor
Descriptor for MultiTermVectors
Inheritance
MultiTermVectorsDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class MultiTermVectorsDescriptor : RequestDescriptorBase<MultiTermVectorsDescriptor, MultiTermVectorsRequestParameters, IMultiTermVectorsRequest>, IDescriptor, IMultiTermVectorsRequest, IRequest<MultiTermVectorsRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
MultiTermVectorsDescriptor()
Declaration
public MultiTermVectorsDescriptor()
|
Edit this page
View Source
MultiTermVectorsDescriptor(IndexName)
Declaration
public MultiTermVectorsDescriptor(IndexName index)
Parameters
Type |
Name |
Description |
IndexName |
index |
Optional, accepts null
|
Methods
|
Edit this page
View Source
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
Returns
Type Parameters
|
Edit this page
View Source
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
Returns
Type Parameters
|
Edit this page
View Source
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
Returns
Type Parameters
|
Edit this page
View Source
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
Returns
Type Parameters
|
Edit this page
View Source
FieldStatistics(bool?)
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public MultiTermVectorsDescriptor FieldStatistics(bool? fieldstatistics = true)
Parameters
Type |
Name |
Description |
bool? |
fieldstatistics |
|
Returns
|
Edit this page
View Source
Fields(Fields)
A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public MultiTermVectorsDescriptor Fields(Fields fields)
Parameters
Type |
Name |
Description |
Fields |
fields |
|
Returns
|
Edit this page
View Source
Fields<T>(params Expression<Func<T, object>>[])
A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public MultiTermVectorsDescriptor Fields<T>(params Expression<Func<T, object>>[] fields) where T : class
Parameters
Returns
Type Parameters
|
Edit this page
View Source
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
|
Edit this page
View Source
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
Returns
|
Edit this page
View Source
Index(IndexName)
The index in which the document resides.
Declaration
public MultiTermVectorsDescriptor Index(IndexName index)
Parameters
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public MultiTermVectorsDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
Offsets(bool?)
Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public MultiTermVectorsDescriptor Offsets(bool? offsets = true)
Parameters
Type |
Name |
Description |
bool? |
offsets |
|
Returns
|
Edit this page
View Source
Payloads(bool?)
Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public MultiTermVectorsDescriptor Payloads(bool? payloads = true)
Parameters
Type |
Name |
Description |
bool? |
payloads |
|
Returns
|
Edit this page
View Source
Positions(bool?)
Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public MultiTermVectorsDescriptor Positions(bool? positions = true)
Parameters
Type |
Name |
Description |
bool? |
positions |
|
Returns
|
Edit this page
View Source
Preference(string)
Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public MultiTermVectorsDescriptor Preference(string preference)
Parameters
Type |
Name |
Description |
string |
preference |
|
Returns
|
Edit this page
View Source
Realtime(bool?)
Specifies if requests are real-time as opposed to near-real-time (default: true).
Declaration
public MultiTermVectorsDescriptor Realtime(bool? realtime = true)
Parameters
Type |
Name |
Description |
bool? |
realtime |
|
Returns
|
Edit this page
View Source
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 OSC 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
|
Edit this page
View Source
TermStatistics(bool?)
Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public MultiTermVectorsDescriptor TermStatistics(bool? termstatistics = true)
Parameters
Type |
Name |
Description |
bool? |
termstatistics |
|
Returns
|
Edit this page
View Source
Version(long?)
Explicit version number for concurrency control
Declaration
public MultiTermVectorsDescriptor Version(long? version)
Parameters
Type |
Name |
Description |
long? |
version |
|
Returns
|
Edit this page
View Source
VersionType(VersionType?)
Declaration
public MultiTermVectorsDescriptor VersionType(VersionType? versiontype)
Parameters
Returns
Implements
Extension Methods