Class GetRequestParameters
Request options for Get
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class GetRequestParameters : RequestParameters<GetRequestParameters>, IRequestParameters
Properties
| Edit this page View SourceDefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type | Description |
---|---|
HttpMethod |
Overrides
| 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
Specific routing value
Declaration
public string Routing { get; set; }
Property Value
Type | Description |
---|---|
string |
SourceEnabled
True or false to return the _source field or not, or a list of fields to return
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 string[] SourceExcludes { get; set; }
Property Value
Type | Description |
---|---|
string[] |
SourceIncludes
A list of fields to extract and return from the _source field
Declaration
public string[] SourceIncludes { get; set; }
Property Value
Type | Description |
---|---|
string[] |
StoredFields
A comma-separated list of stored fields to return in the response
Declaration
public string[] StoredFields { get; set; }
Property Value
Type | Description |
---|---|
string[] |
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
| Edit this page View SourceVersion
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? |