Package org.opensearch.client.opensearch.search_pipeline

Class AgenticContextResponseProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.search_pipeline.AgenticContextResponseProcessor.Builder

All Implemented Interfaces:

CopyableBuilder<AgenticContextResponseProcessor.Builder,AgenticContextResponseProcessor>, MutableBuilder<AgenticContextResponseProcessor.Builder,AgenticContextResponseProcessor>, ObjectBuilder<AgenticContextResponseProcessor>

Enclosing class:

AgenticContextResponseProcessor

public static class AgenticContextResponseProcessor.Builder
extends ObjectBuilderBase
implements CopyableBuilder<AgenticContextResponseProcessor.Builder,AgenticContextResponseProcessor>

Builder for AgenticContextResponseProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AgenticContextResponseProcessor.Builder	agentStepsSummary(Boolean value)	Whether to include the agent's execution step summary in the response.
AgenticContextResponseProcessor	build()	Builds a AgenticContextResponseProcessor.
AgenticContextResponseProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AgenticContextResponseProcessor.Builder	description(String value)	API name: description
final AgenticContextResponseProcessor.Builder	dslQuery(Boolean value)	Whether to include the generated DSL query in the response.
final AgenticContextResponseProcessor.Builder	ignoreFailure(Boolean value)	API name: ignore_failure
final AgenticContextResponseProcessor.Builder	tag(String value)	API name: tag

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public AgenticContextResponseProcessor.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<AgenticContextResponseProcessor.Builder,AgenticContextResponseProcessor>

Returns:

a new builder instance.

agentStepsSummary

@Nonnull
public final AgenticContextResponseProcessor.Builder agentStepsSummary(@Nullable
 Boolean value)

Whether to include the agent's execution step summary in the response. Available for conversational agents only.

API name: agent_steps_summary

description

@Nonnull
public final AgenticContextResponseProcessor.Builder description(@Nullable
 String value)

API name: description

dslQuery

@Nonnull
public final AgenticContextResponseProcessor.Builder dslQuery(@Nullable
 Boolean value)

Whether to include the generated DSL query in the response. Available for both conversational and flow agents.

API name: dsl_query

ignoreFailure

@Nonnull
public final AgenticContextResponseProcessor.Builder ignoreFailure(@Nullable
 Boolean value)

API name: ignore_failure

tag

@Nonnull
public final AgenticContextResponseProcessor.Builder tag(@Nullable
 String value)

API name: tag

build

@Nonnull
public AgenticContextResponseProcessor build()

Builds a AgenticContextResponseProcessor.

Specified by:

build in interface ObjectBuilder<AgenticContextResponseProcessor>

Throws:

NullPointerException - if some of the required fields are null.