Class PlainRequestBase<TParameters>

Inheritance

object

RequestBase<TParameters>

PlainRequestBase<TParameters>

AddIndexBlockRequest

AliasExistsRequest

AnalyzeRequest

ArbitraryHttpRequestBase<TParams>

BulkAliasRequest

BulkRequest

CancelTasksRequest

CatAliasesRequest

CatAllPitSegmentsRequest

CatAllocationRequest

CatClusterManagerRequest

CatCountRequest

CatFielddataRequest

CatHealthRequest

CatHelpRequest

CatIndicesRequest

CatMasterRequest

CatNodeAttributesRequest

CatNodesRequest

CatPendingTasksRequest

CatPitSegmentsRequest

CatPluginsRequest

CatRecoveryRequest

CatRepositoriesRequest

CatSegmentReplicationRequest

CatSegmentsRequest

CatShardsRequest

CatSnapshotsRequest

CatTasksRequest

CatTemplatesRequest

CatThreadPoolRequest

CleanupRepositoryRequest

ClearCacheRequest

ClearScrollRequest

CloneIndexRequest

CloneSnapshotRequest

CloseIndexRequest

ClusterAllocationExplainRequest

ClusterGetSettingsRequest

ClusterHealthRequest

ClusterPendingTasksRequest

ClusterPutSettingsRequest

ClusterRerouteRequest

ClusterStateRequest

ClusterStatsRequest

ComponentTemplateExistsRequest

ComposableIndexTemplateExistsRequest

CountRequest

CreateIndexRequest

CreatePitRequest

CreateRepositoryRequest

CreateRequest<TDocument>

DeleteAliasRequest

DeleteAllPitsRequest

DeleteByQueryRequest

DeleteByQueryRethrottleRequest

DeleteComponentTemplateRequest

DeleteComposableIndexTemplateRequest

DeleteDanglingIndexRequest

DeleteIndexRequest

DeleteIndexTemplateRequest

DeletePipelineRequest

DeletePitRequest

DeleteRepositoryRequest

DeleteRequest

DeleteScriptRequest

DeleteSnapshotRequest

DeleteVotingConfigExclusionsRequest

DocumentExistsRequest

ExecutePainlessScriptRequest

ExplainRequest

FieldCapabilitiesRequest

FlushRequest

ForceMergeRequest

GetAliasRequest

GetAllPitsRequest

GetComponentTemplateRequest

GetComposableIndexTemplateRequest

GetFieldMappingRequest

GetIndexRequest

GetIndexSettingsRequest

GetIndexTemplateRequest

GetMappingRequest

GetPipelineRequest

GetRepositoryRequest

GetRequest

GetScriptRequest

GetSnapshotRequest

GetTaskRequest

GrokProcessorPatternsRequest

ImportDanglingIndexRequest

IndexExistsRequest

IndexRequest<TDocument>

IndexTemplateExistsRequest

IndicesStatsRequest

ListDanglingIndicesRequest

ListTasksRequest

MultiGetRequest

MultiSearchRequest

MultiSearchTemplateRequest

MultiTermVectorsRequest

NodesHotThreadsRequest

NodesInfoRequest

NodesStatsRequest

NodesUsageRequest

OpenIndexRequest

PingRequest

PostVotingConfigExclusionsRequest

PutAliasRequest

PutComponentTemplateRequest

PutComposableIndexTemplateRequest

PutIndexTemplateRequest

PutMappingRequest

PutPipelineRequest

PutScriptRequest

RefreshRequest

ReindexOnServerRequest

ReindexRethrottleRequest

ReloadSecureSettingsRequest

RemoteInfoRequest

RenderSearchTemplateRequest

ResolveIndexRequest

RestoreRequest

RolloverIndexRequest

RootNodeInfoRequest

ScrollRequest

SearchRequest

SearchShardsRequest

SearchTemplateRequest

ShrinkIndexRequest

SimulatePipelineRequest

SnapshotRequest

SnapshotStatusRequest

SourceExistsRequest

SourceRequest

SplitIndexRequest

TermVectorsRequest<TDocument>

TypeExistsRequest

UpdateByQueryRequest

UpdateByQueryRethrottleRequest

UpdateIndexSettingsRequest

UpdateRequest<TDocument, TPartialDocument>

ValidateQueryRequest

VerifyRepositoryRequest

Implements

IRequest<TParameters>

IRequest

Inherited Members

RequestBase<TParameters>.HttpMethod

RequestBase<TParameters>.RequestState

RequestBase<TParameters>.ContentType

RequestBase<TParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<TParameters>.RequestDefaults(TParameters)

RequestBase<TParameters>.Q<TOut>(string)

RequestBase<TParameters>.Q(string, object)

RequestBase<TParameters>.SetAcceptHeader(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public abstract class PlainRequestBase<TParameters> : RequestBase<TParameters>, IRequest<TParameters>, IRequest where TParameters : class, IRequestParameters, new()

Type Parameters

Name	Description
TParameters

Constructors

PlainRequestBase()

Declaration

protected PlainRequestBase()

PlainRequestBase(Func<RouteValues, RouteValues>)

Declaration

protected PlainRequestBase(Func<RouteValues, RouteValues> pathSelector)

Parameters

Type	Name	Description
Func<RouteValues, RouteValues>	pathSelector

Properties

ErrorTrace

Include the stack trace of returned errors.

Declaration

public bool? ErrorTrace { get; set; }

Property Value

Type	Description
bool?

FilterPath

A comma-separated list of filters used to reduce the response.

Use of response filtering can result in a response from OpenSearch that cannot be correctly deserialized to the respective response type for the request. In such situations, use the low level client to issue the request and handle response deserialization

Declaration

public string[] FilterPath { get; set; }

Property Value

Type	Description
string[]

Human

Return human readable values for statistics.

Declaration

public bool? Human { get; set; }

Property Value

Type	Description
bool?

Pretty

Pretty format the returned JSON response.

Declaration

public bool? Pretty { get; set; }

Property Value

Type	Description
bool?

RequestConfiguration

Specify settings for this request alone, handy if you need a custom timeout or want to bypass sniffing, retries

Declaration

public IRequestConfiguration RequestConfiguration { get; set; }

Property Value

Type	Description
IRequestConfiguration

SourceQueryString

The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

Declaration

public string SourceQueryString { get; set; }

Property Value

Type	Description
string

Implements

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)