Class ExecuteAgentRequest
- java.lang.Object
-
- org.opensearch.client.opensearch._types.RequestBase
-
- org.opensearch.client.opensearch.ml.ExecuteAgentRequest
-
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,ToCopyableBuilder<ExecuteAgentRequest.Builder,ExecuteAgentRequest>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public final class ExecuteAgentRequest extends RequestBase implements PlainJsonSerializable, ToCopyableBuilder<ExecuteAgentRequest.Builder,ExecuteAgentRequest>
Execute an agent.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classExecuteAgentRequest.BuilderBuilder forExecuteAgentRequest.-
Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<ExecuteAgentRequest>_DESERIALIZERJson deserializer forExecuteAgentRequeststatic Endpoint<ExecuteAgentRequest,ExecuteAgentResponse,ErrorResponse>_ENDPOINTEndpoint "ml.execute_agent".
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringagentId()Required - API name:agent_idstatic ExecuteAgentRequest.Builderbuilder()booleanequals(java.lang.Object o)inthashCode()static ExecuteAgentRequestof(java.util.function.Function<ExecuteAgentRequest.Builder,ObjectBuilder<ExecuteAgentRequest>> fn)java.util.Map<java.lang.String,JsonData>parameters()Required - API name:parametersjava.lang.BooleanparametersVerbose()Whether to provide verbose output.voidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)protected static voidsetupExecuteAgentRequestDeserializer(ObjectDeserializer<ExecuteAgentRequest.Builder> op)ExecuteAgentRequest.BuildertoBuilder()Create a new builderToCopyableBuilderthat is initialised with the current state of this object.-
Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
applyQueryParameters, errorTrace, human
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonString
-
Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
-
-
-
Field Detail
-
_DESERIALIZER
public static final JsonpDeserializer<ExecuteAgentRequest> _DESERIALIZER
Json deserializer forExecuteAgentRequest
-
_ENDPOINT
public static final Endpoint<ExecuteAgentRequest,ExecuteAgentResponse,ErrorResponse> _ENDPOINT
Endpoint "ml.execute_agent".
-
-
Method Detail
-
of
public static ExecuteAgentRequest of(java.util.function.Function<ExecuteAgentRequest.Builder,ObjectBuilder<ExecuteAgentRequest>> fn)
-
agentId
@Nonnull public final java.lang.String agentId()
Required - API name:agent_id
-
parameters
@Nonnull public final java.util.Map<java.lang.String,JsonData> parameters()
Required - API name:parameters
-
parametersVerbose
@Nullable public final java.lang.Boolean parametersVerbose()
Whether to provide verbose output.API name:
parameters.verbose
-
serialize
public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
-
toBuilder
@Nonnull public ExecuteAgentRequest.Builder toBuilder()
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ExecuteAgentRequest.Builder,ExecuteAgentRequest>- Returns:
- a new builder instance.
-
builder
@Nonnull public static ExecuteAgentRequest.Builder builder()
-
setupExecuteAgentRequestDeserializer
protected static void setupExecuteAgentRequestDeserializer(ObjectDeserializer<ExecuteAgentRequest.Builder> op)
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
-