Class GetRequestParameters

Request options for Get

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

Inheritance

object

RequestParameters<GetRequestParameters>

GetRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<GetRequestParameters>.CustomResponseBuilder

RequestParameters<GetRequestParameters>.QueryString

RequestParameters<GetRequestParameters>.RequestConfiguration

RequestParameters<GetRequestParameters>.ContainsQueryString(string)

RequestParameters<GetRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<GetRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<GetRequestParameters>.SetQueryString(string, object)

RequestParameters<GetRequestParameters>.Q<TOut>(string)

RequestParameters<GetRequestParameters>.Q(string, object)

RequestParameters<GetRequestParameters>.SetAcceptHeader(string)

RequestParameters<GetRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net

Assembly: OpenSearch.Net.dll

Syntax

public class GetRequestParameters : RequestParameters<GetRequestParameters>, IRequestParameters

Properties

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<GetRequestParameters>.DefaultHttpMethod

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

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?

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?

Routing

Target the specified primary shard.

Declaration

public string[] Routing { get; set; }

Property Value

Type	Description
string[]

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?

SourceExcludes

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

Declaration

public string[] SourceExcludes { get; set; }

Property Value

Type	Description
string[]

SourceIncludes

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

Declaration

public string[] SourceIncludes { get; set; }

Property Value

Type	Description
string[]

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[]

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<GetRequestParameters>.SupportsBody

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?

VersionType

Specific version type: internal, external, external_gte.

Declaration

public VersionType? VersionType { get; set; }

Property Value

Type	Description
VersionType?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)