Package org.opensearch.client.opensearch._types

Class RequestBase

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

Direct Known Subclasses:

AddBlockRequest, AllocationExplainRequest, AnalyzeRequest, BulkRequest, CancelRequest, CatRequestBase, CleanupRepositoryRequest, ClearCacheRequest, ClearScrollRequest, CloneIndexRequest, CloneSnapshotRequest, CloseIndexRequest, ClusterStatsRequest, CountRequest, CreateConnectorRequest, CreateControllerRequest, CreateDataStreamRequest, CreateIndexRequest, CreateMemoryRequest, CreateMessageRequest, CreateModelMetaRequest, CreatePitRequest, CreateRepositoryRequest, CreateRequest, CreateSnapshotRequest, DataStreamsStatsRequest, DeleteAgentRequest, DeleteAliasRequest, DeleteAllPitsRequest, DeleteByQueryRequest, DeleteByQueryRethrottleRequest, DeleteComponentTemplateRequest, DeleteConnectorRequest, DeleteControllerRequest, DeleteDanglingIndexRequest, DeleteDataStreamRequest, DeleteIndexRequest, DeleteIndexTemplateRequest, DeleteMemoryRequest, DeleteModelGroupRequest, DeleteModelRequest, DeletePipelineRequest, DeletePitRequest, DeleteRepositoryRequest, DeleteRequest, DeleteScriptRequest, DeleteSearchPipelineRequest, DeleteSnapshotRequest, DeleteTaskRequest, DeleteTemplateRequest, DeleteVotingConfigExclusionsRequest, DeployModelRequest, ExecuteAgentRequest, ExistsAliasRequest, ExistsComponentTemplateRequest, ExistsIndexTemplateRequest, ExistsRequest, ExistsRequest, ExistsSourceRequest, ExistsTemplateRequest, ExplainRequest, FieldCapsRequest, FlushRequest, ForcemergeRequest, GetAgentRequest, GetAliasRequest, GetAllMemoriesRequest, GetAllMessagesRequest, GetAllPitsRequest, GetAllToolsRequest, GetClusterSettingsRequest, GetComponentTemplateRequest, GetConnectorRequest, GetControllerRequest, GetDataStreamRequest, GetFieldMappingRequest, GetIndexRequest, GetIndexTemplateRequest, GetIndicesSettingsRequest, GetMappingRequest, GetMemoryRequest, GetMessageRequest, GetMessageTracesRequest, GetModelGroupRequest, GetModelRequest, GetPipelineRequest, GetProfileModelsRequest, GetProfileRequest, GetProfileTasksRequest, GetRepositoryRequest, GetRequest, GetScriptContextRequest, GetScriptLanguagesRequest, GetScriptRequest, GetSearchPipelineRequest, GetSnapshotRequest, GetStatsRequest, GetTaskRequest, GetTasksRequest, GetTemplateRequest, GetToolRequest, HealthRequest, HotThreadsRequest, ImportDanglingIndexRequest, IndexRequest, IndicesStatsRequest, InfoRequest, ListDanglingIndicesRequest, ListRequest, LoadModelRequest, MgetRequest, MsearchRequest, MsearchTemplateRequest, MtermvectorsRequest, NodesInfoRequest, NodesStatsRequest, NodesUsageRequest, OpenRequest, PendingTasksRequest, PingRequest, PostVotingConfigExclusionsRequest, ProcessorGrokRequest, PutAliasRequest, PutClusterSettingsRequest, PutComponentTemplateRequest, PutIndexTemplateRequest, PutIndicesSettingsRequest, PutMappingRequest, PutPipelineRequest, PutScriptRequest, PutSearchPipelineRequest, PutTemplateRequest, RankEvalRequest, RecoveryRequest, RefreshRequest, RegisterAgentsRequest, RegisterModelGroupRequest, RegisterModelMetaRequest, RegisterModelRequest, ReindexRequest, ReindexRethrottleRequest, ReloadSecureSettingsRequest, RemoteInfoRequest, RenderSearchTemplateRequest, RerouteRequest, ResolveIndexRequest, RestoreSnapshotRequest, RolloverRequest, ScriptsPainlessExecuteRequest, ScrollRequest, SearchRequest, SearchShardsRequest, SearchTemplateRequest, SegmentsRequest, ShardStoresRequest, ShrinkRequest, SimulateIndexTemplateRequest, SimulateRequest, SimulateTemplateRequest, SnapshotStatusRequest, SplitRequest, StateRequest, TermvectorsRequest, UndeployModelRequest, UnloadModelRequest, UpdateAliasesRequest, UpdateByQueryRequest, UpdateByQueryRethrottleRequest, UpdateConnectorRequest, UpdateControllerRequest, UpdateMemoryRequest, UpdateMessageRequest, UpdateModelGroupRequest, UpdateModelRequest, UpdateRequest, UploadChunkRequest, UploadModelRequest, ValidateQueryRequest, VerifyRepositoryRequest

public abstract class RequestBase
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestBase()
protected	RequestBase(RequestBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
Boolean	errorTrace()	Whether to include the stack trace of returned errors.
Boolean	human()	Whether to return human readable values for statistics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RequestBase

protected RequestBase()

RequestBase

protected RequestBase(RequestBase.AbstractBuilder<?> builder)

Method Details

errorTrace

@Nullable
public Boolean errorTrace()

Whether to include the stack trace of returned errors.

API name: error_trace

human

@Nullable
public Boolean human()

Whether to return human readable values for statistics.

API name: human

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)