Package org.opensearch.client.util

Interface ToCopyableBuilder<B extends CopyableBuilder<B,T>,T extends ToCopyableBuilder<B,T>>

All Known Implementing Classes:

Action, AlgorithmOperations, ByteBuffer, CharGroupTokenizer, ClientConfig, CollapseResponseProcessor, ColumnMeta, CreateConnectorRequest, CreateConnectorResponse, CreateControllerRequest, CreateControllerResponse, CreateMemoryRequest, CreateMemoryResponse, CreateMessageRequest, CreateMessageResponse, CreateModelMetaRequest, CreateModelMetaResponse, Credential, DeleteAgentRequest, DeleteAgentResponse, DeleteConnectorRequest, DeleteConnectorResponse, DeleteControllerRequest, DeleteControllerResponse, DeleteMemoryRequest, DeleteMemoryResponse, DeleteModelGroupRequest, DeleteModelGroupResponse, DeleteModelRequest, DeleteModelResponse, DeleteSearchPipelineRequest, DeleteSearchPipelineResponse, DeleteTaskRequest, DeleteTaskResponse, DeployModelRequest, DeployModelResponse, EdgeNGramTokenizer, ErrorCause, ExecuteAgentRequest, ExecuteAgentResponse, FilterQueryRequestProcessor, GetAgentRequest, GetAgentResponse, GetAllMemoriesRequest, GetAllMemoriesResponse, GetAllMessagesRequest, GetAllMessagesResponse, GetAllToolsRequest, GetAllToolsResponse, GetConnectorRequest, GetConnectorResponse, GetControllerRequest, GetControllerResponse, GetMemoryRequest, GetMemoryResponse, GetMessageRequest, GetMessageResponse, GetMessageTracesRequest, GetMessageTracesResponse, GetModelGroupRequest, GetModelGroupResponse, GetModelRequest, GetModelResponse, GetProfileModelsRequest, GetProfileModelsResponse, GetProfileRequest, GetProfileResponse, GetProfileTasksRequest, GetProfileTasksResponse, GetSearchPipelineRequest, GetStatsRequest, GetStatsResponse, GetTaskRequest, GetTaskResponse, GetToolRequest, GetToolResponse, Guardrails, GuardrailsInputOutput, Headers, HybridQuery, IcuCollationKeywordProperty, IcuTokenizer, InferenceResults, KeywordTokenizer, KnnVectorMethod, KnnVectorProperty, KuromojiTokenizer, LetterTokenizer, LLM, LoadModelRequest, LoadModelResponse, LowercaseTokenizer, Memory, Message, MLOpenSearchReranker, ModelConfig, ModelProfile, ModelStats, NeuralQueryEnricherRequestProcessor, NGramTokenizer, Node, NodeStatsDetails, NoriTokenizer, NormalizationPhaseResultsProcessor, Output, OversampleRequestProcessor, Owner, PathHierarchyTokenizer, PatternTokenizer, PersonalizeSearchRankingResponseProcessor, PhaseTook, PredictionResult, PredictRequestStats, PutSearchPipelineRequest, PutSearchPipelineResponse, RateLimiter, RegisterAgentsRequest, RegisterAgentsResponse, RegisterModelGroupRequest, RegisterModelGroupResponse, RegisterModelMetaRequest, RegisterModelMetaResponse, RegisterModelRequest, RegisterModelResponse, RenameFieldResponseProcessor, RerankContext, RerankResponseProcessor, RetrievalAugmentedGenerationResponseProcessor, Rows, ScoreCombination, ScoreNormalization, SearchPipelineStructure, SearchScriptRequestProcessor, ShardFailure, ShardStatistics, SimplePatternSplitTokenizer, SimplePatternTokenizer, SmartcnTokenizer, SortResponseProcessor, SplitResponseProcessor, StandardTokenizer, Task, Tool, ToolItems, TruncateHitsResponseProcessor, UaxEmailUrlTokenizer, UndeployModelNode, UndeployModelRequest, UnloadModelNode, UnloadModelRequest, UpdateConnectorRequest, UpdateConnectorResponse, UpdateControllerRequest, UpdateControllerResponse, UpdateMemoryRequest, UpdateMemoryResponse, UpdateMessageRequest, UpdateMessageResponse, UpdateModelGroupRequest, UpdateModelGroupResponse, UpdateModelRequest, UpdateModelResponse, UploadChunkRequest, UploadChunkResponse, UploadModelRequest, UploadModelResponse, Values, WhitespaceTokenizer, WildcardProperty

public interface ToCopyableBuilder<B extends CopyableBuilder<B,T>,T extends ToCopyableBuilder<B,T>>

Method Summary

Modifier and Type	Method	Description
default T	copy(java.util.function.Consumer<? super B> modifier)	A convenience method for calling toBuilder(), updating the returned builder and then calling ObjectBuilder.build().
B	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Method Detail

toBuilder

@Nonnull
B toBuilder()

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Returns:

a new builder instance.

copy

@Nonnull
default T copy(@Nonnull
               java.util.function.Consumer<? super B> modifier)

A convenience method for calling toBuilder(), updating the returned builder and then calling ObjectBuilder.build().

Parameters:

modifier - A function that mutates this immutable object using the provided builder.

Returns:

A new copy of this object with the requested modifications.