Class SourceRequest
Request for Source
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class SourceRequest : PlainRequestBase<SourceRequestParameters>, ISourceRequest, IRequest<SourceRequestParameters>, IRequest
Constructors
| Edit this page View SourceSourceRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected SourceRequest()
SourceRequest(IndexName, Id)
/{index}/_source/{id}
Declaration
public SourceRequest(IndexName index, Id id)
Parameters
Type | Name | Description |
---|---|---|
IndexName | index | this parameter is required |
Id | id | this parameter is required |
Properties
| Edit this page View SourcePreference
Specify the node or shard the operation should be performed on (default: random)
Declaration
public string Preference { get; set; }
Property Value
Type | Description |
---|---|
string |
Realtime
Specify whether to perform the operation in realtime or search mode
Declaration
public bool? Realtime { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Refresh
Refresh the shard containing the document before performing the operation
Declaration
public bool? Refresh { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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 Routing Routing { get; set; }
Property Value
Type | Description |
---|---|
Routing |
Self
Declaration
protected ISourceRequest Self { get; }
Property Value
Type | Description |
---|---|
ISourceRequest |
SourceEnabled
Whether the _source should be included in the response.
Declaration
public bool? SourceEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SourceExcludes
A list of fields to exclude from the returned _source field
Declaration
public Fields SourceExcludes { get; set; }
Property Value
Type | Description |
---|---|
Fields |
SourceIncludes
A list of fields to extract and return from the _source field
Declaration
public Fields SourceIncludes { get; set; }
Property Value
Type | Description |
---|---|
Fields |
Version
Explicit version number for concurrency control
Declaration
public long? Version { get; set; }
Property Value
Type | Description |
---|---|
long? |
VersionType
Specific version type
Declaration
public VersionType? VersionType { get; set; }
Property Value
Type | Description |
---|---|
VersionType? |