Class RequestBase

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
Direct Known Subclasses:
AddBlockRequest, AddFeaturesToSetByQueryRequest, AddFeaturesToSetRequest, AddPolicyRequest, AllocationExplainRequest, AnalyzeRequest, AuthinfoRequest, AuthtokenRequest, BulkRequest, CacheStatsRequest, CancelRequest, CatRequestBase, ChangePasswordRequest, ChangePolicyRequest, CleanupRepositoryRequest, ClearCacheRequest, ClearCacheRequest, ClearScrollRequest, CloneIndexRequest, CloneSnapshotRequest, CloseIndexRequest, ClusterStatsRequest, ConfigUpgradeCheckRequest, ConfigUpgradePerformRequest, CountRequest, CreateActionGroupRequest, CreateAllowlistRequest, CreateConnectorRequest, CreateControllerRequest, CreateDataStreamRequest, CreateDefaultStoreRequest, CreateFeatureRequest, CreateFeaturesetRequest, CreateIndexRequest, CreateMemoryRequest, CreateMessageRequest, CreateModelFromSetRequest, CreateModelMetaRequest, CreateModelRequest, CreatePitRequest, CreateRepositoryRequest, CreateRequest, CreateRoleMappingRequest, CreateRoleRequest, CreateSnapshotRequest, CreateStoreRequest, CreateTenantRequest, CreateUpdateTenancyConfigRequest, CreateUserLegacyRequest, CreateUserRequest, DataStreamsStatsRequest, DeleteActionGroupRequest, DeleteAgentRequest, DeleteAliasRequest, DeleteAllPitsRequest, DeleteByQueryRequest, DeleteByQueryRethrottleRequest, DeleteComponentTemplateRequest, DeleteConnectorRequest, DeleteControllerRequest, DeleteDanglingIndexRequest, DeleteDataStreamRequest, DeleteDecommissionAwarenessRequest, DeleteDefaultStoreRequest, DeleteDistinguishedNameRequest, DeleteExperimentsRequest, DeleteFeatureRequest, DeleteFeaturesetRequest, DeleteIndexRequest, DeleteIndexTemplateRequest, DeleteIp2geoDatasourceRequest, DeleteJudgmentsRequest, DeleteMemoryRequest, DeleteModelGroupRequest, DeleteModelRequest, DeleteModelRequest, DeleteModelRequest, DeletePipelineRequest, DeletePitRequest, DeletePolicyRequest, DeleteQuerySetsRequest, DeleteRepositoryRequest, DeleteRequest, DeleteRoleMappingRequest, DeleteRoleRequest, DeleteScheduledExperimentsRequest, DeleteScriptRequest, DeleteSearchConfigurationsRequest, DeleteSearchPipelineRequest, DeleteSnapshotRequest, DeleteStoreRequest, DeleteTaskRequest, DeleteTemplateRequest, DeleteTenantRequest, DeleteUserLegacyRequest, DeleteUserRequest, DeleteVotingConfigExclusionsRequest, DeleteWeightedRoutingRequest, DeployModelRequest, ExecuteAgentRequest, ExecuteAgentStreamRequest, ExistsAliasRequest, ExistsComponentTemplateRequest, ExistsIndexTemplateRequest, ExistsPolicyRequest, ExistsRequest, ExistsRequest, ExistsSourceRequest, ExistsTemplateRequest, ExplainPolicyRequest, ExplainRequest, FieldCapsRequest, FlushCacheRequest, FlushRequest, ForcemergeRequest, GenerateOboTokenRequest, GenerateUserTokenLegacyRequest, GenerateUserTokenRequest, GeojsonUploadPostRequest, GeojsonUploadPutRequest, GetAccountDetailsRequest, GetActionGroupRequest, GetActionGroupsRequest, GetAgentRequest, GetAliasRequest, GetAllCertificatesRequest, GetAllMemoriesRequest, GetAllMessagesRequest, GetAllowlistRequest, GetAllPitsRequest, GetAllToolsRequest, GetAuditConfigurationRequest, GetCertificatesRequest, GetClusterSettingsRequest, GetComponentTemplateRequest, GetConfigurationRequest, GetConnectorRequest, GetControllerRequest, GetDashboardsInfoRequest, GetDataStreamRequest, GetDecommissionAwarenessRequest, GetDistinguishedNameRequest, GetDistinguishedNamesRequest, GetExperimentsRequest, GetFeatureRequest, GetFeaturesetRequest, GetFieldMappingRequest, GetIndexRequest, GetIndexTemplateRequest, GetIndicesSettingsRequest, GetIp2geoDatasourceRequest, GetJudgmentsRequest, GetMappingRequest, GetMemoryRequest, GetMessageRequest, GetMessageTracesRequest, GetModelGroupRequest, GetModelRequest, GetModelRequest, GetModelRequest, GetNodeCertificatesRequest, GetNodeStatsRequest, GetPermissionsInfoRequest, GetPipelineRequest, GetPoliciesRequest, GetPolicyRequest, GetProfileModelsRequest, GetProfileRequest, GetProfileTasksRequest, GetQuerySetsRequest, GetRepositoryRequest, GetRequest, GetRoleMappingRequest, GetRoleMappingsRequest, GetRoleRequest, GetRolesRequest, GetScheduledExperimentsRequest, GetScriptContextRequest, GetScriptLanguagesRequest, GetScriptRequest, GetSearchConfigurationsRequest, GetSearchPipelineRequest, GetSnapshotRequest, GetSslinfoRequest, GetStateRequest, GetStatsRequest, GetStatsRequest, GetStoreRequest, GetTaskRequest, GetTasksRequest, GetTemplateRequest, GetTenancyConfigRequest, GetTenantRequest, GetTenantsRequest, GetToolRequest, GetUploadStatsRequest, GetUserLegacyRequest, GetUserRequest, GetUsersLegacyRequest, GetUsersRequest, GetWeightedRoutingRequest, HealthRequest, HealthRequest, HotThreadsRequest, ImportDanglingIndexRequest, IndexRequest, IndicesStatsRequest, InfoRequest, InitializeRequest, KnnStatsRequest, ListDanglingIndicesRequest, ListRequest, ListStoresRequest, LoadModelRequest, LtrStatsRequest, MgetRequest, MigrateRequest, MsearchRequest, MsearchTemplateRequest, MtermvectorsRequest, NodesInfoRequest, NodesStatsRequest, NodesUsageRequest, OpenRequest, PatchActionGroupRequest, PatchActionGroupsRequest, PatchAllowlistRequest, PatchAuditConfigurationRequest, PatchConfigurationRequest, PatchDistinguishedNameRequest, PatchDistinguishedNamesRequest, PatchRoleMappingRequest, PatchRoleMappingsRequest, PatchRoleRequest, PatchRolesRequest, PatchTenantRequest, PatchTenantsRequest, PatchUserRequest, PatchUsersRequest, PauseRequest, PendingTasksRequest, PingRequest, PostDashboardsInfoRequest, PostQuerySetsRequest, PostScheduledExperimentsRequest, PostVotingConfigExclusionsRequest, PredictModelStreamRequest, ProcessorGrokRequest, PutAliasRequest, PutClusterSettingsRequest, PutComponentTemplateRequest, PutDecommissionAwarenessRequest, PutExperimentsRequest, PutIndexTemplateRequest, PutIndicesSettingsRequest, PutIp2geoDatasourceRequest, PutIp2geoDatasourceSettingsRequest, PutJudgmentsRequest, PutMappingRequest, PutPipelineRequest, PutPoliciesRequest, PutPolicyRequest, PutQuerySetsRequest, PutScriptRequest, PutSearchConfigurationsRequest, PutSearchPipelineRequest, PutTemplateRequest, PutWeightedRoutingRequest, RankEvalRequest, RecoveryRequest, RefreshRequest, RefreshSearchAnalyzersRequest, RegisterAgentsRequest, RegisterModelGroupRequest, RegisterModelMetaRequest, RegisterModelRequest, ReindexRequest, ReindexRethrottleRequest, ReloadHttpCertificatesRequest, ReloadSecureSettingsRequest, ReloadTransportCertificatesRequest, RemoteInfoRequest, RemovePolicyRequest, RenderSearchTemplateRequest, RerouteRequest, ResolveIndexRequest, RestoreSnapshotRequest, ResumeRequest, RetryIndexRequest, RolloverRequest, ScriptsPainlessExecuteRequest, ScrollRequest, SearchFeaturesetsRequest, SearchFeaturesRequest, SearchModelsRequest, SearchModelsRequest, SearchRequest, SearchShardsRequest, SearchTemplateRequest, SegmentsRequest, ShardStoresRequest, ShrinkRequest, SimulateIndexTemplateRequest, SimulateRequest, SimulateTemplateRequest, SnapshotStatusRequest, SplitRequest, StateRequest, TenantInfoRequest, TermvectorsRequest, TrainModelRequest, UndeployModelRequest, UnloadModelRequest, UpdateAliasesRequest, UpdateAuditConfigurationRequest, UpdateByQueryRequest, UpdateByQueryRethrottleRequest, UpdateConfigurationRequest, UpdateConnectorRequest, UpdateControllerRequest, UpdateDistinguishedNameRequest, UpdateFeatureRequest, UpdateFeaturesetRequest, UpdateMemoryRequest, UpdateMessageRequest, UpdateModelGroupRequest, UpdateModelRequest, UpdateRequest, UploadChunkRequest, UploadModelRequest, ValidateQueryRequest, ValidateRequest, VerifyRepositoryRequest, WarmupRequest, WhoAmIProtectedRequest, WhoAmIRequest

public abstract class RequestBase extends Object
  • Constructor Details

  • 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)