Class GetRequestParameters

Request options for Get

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

Inheritance
object
RequestParameters<GetRequestParameters>
GetRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class GetRequestParameters : RequestParameters<GetRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| 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, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.

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

Routing

Target the specified primary shard.

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

SourceEnabled

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

SourceExcludes

A comma-separated list of source fields to exclude in the response.

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

SourceIncludes

A comma-separated list of source fields to include in the response.

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

StoredFields

List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false.

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

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

Version

Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.

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

VersionType

Specific version type: internal, external, external_gte.

Declaration
public VersionType? VersionType { get; set; }
Property Value
Type Description
VersionType?

Implements

Extension Methods