Package org.opensearch.client.opensearch._types

Class RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<BuilderT>

Direct Known Subclasses:

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

Enclosing class:

RequestBase

public abstract static class RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
extends ObjectBuilderBase

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()
protected	AbstractBuilder(RequestBase o)
protected	AbstractBuilder(RequestBase.AbstractBuilder<BuilderT> o)

Method Summary

Modifier and Type	Method	Description
BuilderT	errorTrace(Boolean value)	Whether to include the stack trace of returned errors.
BuilderT	human(Boolean value)	Whether to return human readable values for statistics.
protected abstract BuilderT	self()

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBuilder

protected AbstractBuilder()

AbstractBuilder

protected AbstractBuilder(RequestBase o)

AbstractBuilder

protected AbstractBuilder(RequestBase.AbstractBuilder<BuilderT> o)

Method Details

self

@Nonnull
protected abstract BuilderT self()

errorTrace

@Nonnull
public BuilderT errorTrace(@Nullable
 Boolean value)

Whether to include the stack trace of returned errors.

API name: error_trace

human

@Nonnull
public BuilderT human(@Nullable
 Boolean value)

Whether to return human readable values for statistics.

API name: human