Class MultiGetRequest

Request for MultiGet

https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/

Inheritance
object
RequestBase<MultiGetRequestParameters>
PlainRequestBase<MultiGetRequestParameters>
MultiGetRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class MultiGetRequest : PlainRequestBase<MultiGetRequestParameters>, IMultiGetRequest, IRequest<MultiGetRequestParameters>, IRequest

Constructors

| Edit this page View Source

MultiGetRequest()

/_mget

Declaration
public MultiGetRequest()
| Edit this page View Source

MultiGetRequest(IndexName)

/{index}/_mget

Declaration
public MultiGetRequest(IndexName index)
Parameters
Type Name Description
IndexName index

Optional, accepts null

Properties

| Edit this page View Source

Documents

Declaration
public IEnumerable<IMultiGetOperation> Documents { get; set; }
Property Value
Type Description
IEnumerable<IMultiGetOperation>
| Edit this page View Source

Preference

Specifies the node or shard the operation should be performed on. Random by default.

Declaration
public string Preference { get; set; }
Property Value
Type Description
string
| Edit this page View Source

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?
| Edit this page View Source

Refresh

If true, the request refreshes relevant shards before retrieving documents.

Declaration
public Refresh? Refresh { get; set; }
Property Value
Type Description
Refresh?
| Edit this page View Source

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 Routing Routing { get; set; }
Property Value
Type Description
Routing
| Edit this page View Source

Self

Declaration
protected IMultiGetRequest Self { get; }
Property Value
Type Description
IMultiGetRequest
| Edit this page View Source

SourceEnabled

Whether the _source should be included in the response.

Declaration
public bool? SourceEnabled { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

SourceExcludes

A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter.

Declaration
public Fields SourceExcludes { get; set; }
Property Value
Type Description
Fields
| Edit this page View Source

SourceIncludes

A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

Declaration
public Fields SourceIncludes { get; set; }
Property Value
Type Description
Fields
| Edit this page View Source

StoredFields

Declaration
public Fields StoredFields { get; set; }
Property Value
Type Description
Fields

Methods

| Edit this page View Source

RequestDefaults(MultiGetRequestParameters)

Allows a request implementation to set certain request parameter defaults, use sparingly!

Declaration
protected override sealed void RequestDefaults(MultiGetRequestParameters parameters)
Parameters
Type Name Description
MultiGetRequestParameters parameters
Overrides

Implements

Extension Methods