Package org.opensearch.client.opensearch.ml

Class OpenSearchMlClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchMlClient>

org.opensearch.client.opensearch.ml.OpenSearchMlClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class OpenSearchMlClient
extends ApiClient<OpenSearchTransport,OpenSearchMlClient>

Client for the ml namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchMlClient(OpenSearchTransport transport)
OpenSearchMlClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final CreateConnectorResponse	createConnector(Function<CreateConnectorRequest.Builder,ObjectBuilder<CreateConnectorRequest>> fn)	Creates a standalone connector.
CreateConnectorResponse	createConnector(CreateConnectorRequest request)	Creates a standalone connector.
final CreateControllerResponse	createController(Function<CreateControllerRequest.Builder,ObjectBuilder<CreateControllerRequest>> fn)	Creates a controller.
CreateControllerResponse	createController(CreateControllerRequest request)	Creates a controller.
final CreateMemoryResponse	createMemory()	Create a memory.
final CreateMemoryResponse	createMemory(Function<CreateMemoryRequest.Builder,ObjectBuilder<CreateMemoryRequest>> fn)	Create a memory.
CreateMemoryResponse	createMemory(CreateMemoryRequest request)	Create a memory.
final CreateMessageResponse	createMessage(Function<CreateMessageRequest.Builder,ObjectBuilder<CreateMessageRequest>> fn)	Create a message.
CreateMessageResponse	createMessage(CreateMessageRequest request)	Create a message.
final CreateModelMetaResponse	createModelMeta(Function<CreateModelMetaRequest.Builder,ObjectBuilder<CreateModelMetaRequest>> fn)	Deprecated.
CreateModelMetaResponse	createModelMeta(CreateModelMetaRequest request)	Deprecated.
final DeleteAgentResponse	deleteAgent(Function<DeleteAgentRequest.Builder,ObjectBuilder<DeleteAgentRequest>> fn)	Delete an agent.
DeleteAgentResponse	deleteAgent(DeleteAgentRequest request)	Delete an agent.
final DeleteConnectorResponse	deleteConnector(Function<DeleteConnectorRequest.Builder,ObjectBuilder<DeleteConnectorRequest>> fn)	Deletes a standalone connector.
DeleteConnectorResponse	deleteConnector(DeleteConnectorRequest request)	Deletes a standalone connector.
final DeleteControllerResponse	deleteController(Function<DeleteControllerRequest.Builder,ObjectBuilder<DeleteControllerRequest>> fn)	Deletes a controller.
DeleteControllerResponse	deleteController(DeleteControllerRequest request)	Deletes a controller.
final DeleteMemoryResponse	deleteMemory(Function<DeleteMemoryRequest.Builder,ObjectBuilder<DeleteMemoryRequest>> fn)	Delete a memory.
DeleteMemoryResponse	deleteMemory(DeleteMemoryRequest request)	Delete a memory.
final DeleteModelResponse	deleteModel(Function<DeleteModelRequest.Builder,ObjectBuilder<DeleteModelRequest>> fn)	Deletes a model.
DeleteModelResponse	deleteModel(DeleteModelRequest request)	Deletes a model.
final DeleteModelGroupResponse	deleteModelGroup(Function<DeleteModelGroupRequest.Builder,ObjectBuilder<DeleteModelGroupRequest>> fn)	Deletes a model group.
DeleteModelGroupResponse	deleteModelGroup(DeleteModelGroupRequest request)	Deletes a model group.
final DeleteTaskResponse	deleteTask(Function<DeleteTaskRequest.Builder,ObjectBuilder<DeleteTaskRequest>> fn)	Deletes a task.
DeleteTaskResponse	deleteTask(DeleteTaskRequest request)	Deletes a task.
final DeployModelResponse	deployModel(Function<DeployModelRequest.Builder,ObjectBuilder<DeployModelRequest>> fn)	Deploys a model.
DeployModelResponse	deployModel(DeployModelRequest request)	Deploys a model.
final ExecuteAgentResponse	executeAgent(Function<ExecuteAgentRequest.Builder,ObjectBuilder<ExecuteAgentRequest>> fn)	Execute an agent.
ExecuteAgentResponse	executeAgent(ExecuteAgentRequest request)	Execute an agent.
final ExecuteAgentStreamResponse	executeAgentStream(Function<ExecuteAgentStreamRequest.Builder,ObjectBuilder<ExecuteAgentStreamRequest>> fn)	Execute an agent in streaming mode.
ExecuteAgentStreamResponse	executeAgentStream(ExecuteAgentStreamRequest request)	Execute an agent in streaming mode.
final GetAgentResponse	getAgent(Function<GetAgentRequest.Builder,ObjectBuilder<GetAgentRequest>> fn)	Get an agent.
GetAgentResponse	getAgent(GetAgentRequest request)	Get an agent.
final GetAllMemoriesResponse	getAllMemories()	Get all memories.
final GetAllMemoriesResponse	getAllMemories(Function<GetAllMemoriesRequest.Builder,ObjectBuilder<GetAllMemoriesRequest>> fn)	Get all memories.
GetAllMemoriesResponse	getAllMemories(GetAllMemoriesRequest request)	Get all memories.
final GetAllMessagesResponse	getAllMessages(Function<GetAllMessagesRequest.Builder,ObjectBuilder<GetAllMessagesRequest>> fn)	Get all messages in a memory.
GetAllMessagesResponse	getAllMessages(GetAllMessagesRequest request)	Get all messages in a memory.
final GetAllToolsResponse	getAllTools()	Get tools.
final GetAllToolsResponse	getAllTools(Function<GetAllToolsRequest.Builder,ObjectBuilder<GetAllToolsRequest>> fn)	Get tools.
GetAllToolsResponse	getAllTools(GetAllToolsRequest request)	Get tools.
final GetConnectorResponse	getConnector(Function<GetConnectorRequest.Builder,ObjectBuilder<GetConnectorRequest>> fn)	Retrieves a standalone connector.
GetConnectorResponse	getConnector(GetConnectorRequest request)	Retrieves a standalone connector.
final GetControllerResponse	getController(Function<GetControllerRequest.Builder,ObjectBuilder<GetControllerRequest>> fn)	Retrieves a controller.
GetControllerResponse	getController(GetControllerRequest request)	Retrieves a controller.
final GetMemoryResponse	getMemory(Function<GetMemoryRequest.Builder,ObjectBuilder<GetMemoryRequest>> fn)	Get a memory.
GetMemoryResponse	getMemory(GetMemoryRequest request)	Get a memory.
final GetMessageResponse	getMessage(Function<GetMessageRequest.Builder,ObjectBuilder<GetMessageRequest>> fn)	Get a message.
GetMessageResponse	getMessage(GetMessageRequest request)	Get a message.
final GetMessageTracesResponse	getMessageTraces(Function<GetMessageTracesRequest.Builder,ObjectBuilder<GetMessageTracesRequest>> fn)	Get a message traces.
GetMessageTracesResponse	getMessageTraces(GetMessageTracesRequest request)	Get a message traces.
final GetModelResponse	getModel(Function<GetModelRequest.Builder,ObjectBuilder<GetModelRequest>> fn)	Retrieves a model.
GetModelResponse	getModel(GetModelRequest request)	Retrieves a model.
final GetModelGroupResponse	getModelGroup(Function<GetModelGroupRequest.Builder,ObjectBuilder<GetModelGroupRequest>> fn)	Retrieves a model group.
GetModelGroupResponse	getModelGroup(GetModelGroupRequest request)	Retrieves a model group.
final GetProfileResponse	getProfile()	Get a profile.
final GetProfileResponse	getProfile(Function<GetProfileRequest.Builder,ObjectBuilder<GetProfileRequest>> fn)	Get a profile.
GetProfileResponse	getProfile(GetProfileRequest request)	Get a profile.
final GetProfileModelsResponse	getProfileModels()	Get a profile models.
final GetProfileModelsResponse	getProfileModels(Function<GetProfileModelsRequest.Builder,ObjectBuilder<GetProfileModelsRequest>> fn)	Get a profile models.
GetProfileModelsResponse	getProfileModels(GetProfileModelsRequest request)	Get a profile models.
final GetProfileTasksResponse	getProfileTasks()	Get a profile tasks.
final GetProfileTasksResponse	getProfileTasks(Function<GetProfileTasksRequest.Builder,ObjectBuilder<GetProfileTasksRequest>> fn)	Get a profile tasks.
GetProfileTasksResponse	getProfileTasks(GetProfileTasksRequest request)	Get a profile tasks.
final GetStatsResponse	getStats()	Get stats.
final GetStatsResponse	getStats(Function<GetStatsRequest.Builder,ObjectBuilder<GetStatsRequest>> fn)	Get stats.
GetStatsResponse	getStats(GetStatsRequest request)	Get stats.
final GetTaskResponse	getTask(Function<GetTaskRequest.Builder,ObjectBuilder<GetTaskRequest>> fn)	Retrieves a task.
GetTaskResponse	getTask(GetTaskRequest request)	Retrieves a task.
final GetToolResponse	getTool(Function<GetToolRequest.Builder,ObjectBuilder<GetToolRequest>> fn)	Get tools.
GetToolResponse	getTool(GetToolRequest request)	Get tools.
final LoadModelResponse	loadModel(Function<LoadModelRequest.Builder,ObjectBuilder<LoadModelRequest>> fn)	Deprecated.
LoadModelResponse	loadModel(LoadModelRequest request)	Deprecated.
final PredictModelStreamResponse	predictModelStream(Function<PredictModelStreamRequest.Builder,ObjectBuilder<PredictModelStreamRequest>> fn)	Predicts a model in streaming mode.
PredictModelStreamResponse	predictModelStream(PredictModelStreamRequest request)	Predicts a model in streaming mode.
final RegisterAgentsResponse	registerAgents(Function<RegisterAgentsRequest.Builder,ObjectBuilder<RegisterAgentsRequest>> fn)	Register an agent.
RegisterAgentsResponse	registerAgents(RegisterAgentsRequest request)	Register an agent.
final RegisterModelResponse	registerModel(Function<RegisterModelRequest.Builder,ObjectBuilder<RegisterModelRequest>> fn)	Registers a model.
RegisterModelResponse	registerModel(RegisterModelRequest request)	Registers a model.
final RegisterModelGroupResponse	registerModelGroup(Function<RegisterModelGroupRequest.Builder,ObjectBuilder<RegisterModelGroupRequest>> fn)	Registers a model group.
RegisterModelGroupResponse	registerModelGroup(RegisterModelGroupRequest request)	Registers a model group.
final RegisterModelMetaResponse	registerModelMeta(Function<RegisterModelMetaRequest.Builder,ObjectBuilder<RegisterModelMetaRequest>> fn)	Registers model metadata.
RegisterModelMetaResponse	registerModelMeta(RegisterModelMetaRequest request)	Registers model metadata.
final UndeployModelResponse	undeployModel()	Undeploys a model.
final UndeployModelResponse	undeployModel(Function<UndeployModelRequest.Builder,ObjectBuilder<UndeployModelRequest>> fn)	Undeploys a model.
UndeployModelResponse	undeployModel(UndeployModelRequest request)	Undeploys a model.
final UnloadModelResponse	unloadModel()	Deprecated.
final UnloadModelResponse	unloadModel(Function<UnloadModelRequest.Builder,ObjectBuilder<UnloadModelRequest>> fn)	Deprecated.
UnloadModelResponse	unloadModel(UnloadModelRequest request)	Deprecated.
final UpdateConnectorResponse	updateConnector(Function<UpdateConnectorRequest.Builder,ObjectBuilder<UpdateConnectorRequest>> fn)	Updates a standalone connector.
UpdateConnectorResponse	updateConnector(UpdateConnectorRequest request)	Updates a standalone connector.
final UpdateControllerResponse	updateController(Function<UpdateControllerRequest.Builder,ObjectBuilder<UpdateControllerRequest>> fn)	Updates a controller.
UpdateControllerResponse	updateController(UpdateControllerRequest request)	Updates a controller.
final UpdateMemoryResponse	updateMemory(Function<UpdateMemoryRequest.Builder,ObjectBuilder<UpdateMemoryRequest>> fn)	Update a memory.
UpdateMemoryResponse	updateMemory(UpdateMemoryRequest request)	Update a memory.
final UpdateMessageResponse	updateMessage(Function<UpdateMessageRequest.Builder,ObjectBuilder<UpdateMessageRequest>> fn)	Update a message.
UpdateMessageResponse	updateMessage(UpdateMessageRequest request)	Update a message.
final UpdateModelResponse	updateModel(Function<UpdateModelRequest.Builder,ObjectBuilder<UpdateModelRequest>> fn)	Updates a model.
UpdateModelResponse	updateModel(UpdateModelRequest request)	Updates a model.
final UpdateModelGroupResponse	updateModelGroup(Function<UpdateModelGroupRequest.Builder,ObjectBuilder<UpdateModelGroupRequest>> fn)	Updates a model group.
UpdateModelGroupResponse	updateModelGroup(UpdateModelGroupRequest request)	Updates a model group.
final UploadChunkResponse	uploadChunk(Function<UploadChunkRequest.Builder,ObjectBuilder<UploadChunkRequest>> fn)	Uploads model chunk.
UploadChunkResponse	uploadChunk(UploadChunkRequest request)	Uploads model chunk.
final UploadModelResponse	uploadModel(Function<UploadModelRequest.Builder,ObjectBuilder<UploadModelRequest>> fn)	Deprecated.
UploadModelResponse	uploadModel(UploadModelRequest request)	Deprecated.
OpenSearchMlClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchMlClient

public OpenSearchMlClient(OpenSearchTransport transport)

OpenSearchMlClient

public OpenSearchMlClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchMlClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchMlClient>

createConnector

public CreateConnectorResponse createConnector(CreateConnectorRequest request)
                                        throws IOException,
OpenSearchException

Creates a standalone connector.

Throws:

IOException

OpenSearchException

createConnector

public final CreateConnectorResponse createConnector(Function<CreateConnectorRequest.Builder,ObjectBuilder<CreateConnectorRequest>> fn)
                                              throws IOException,
OpenSearchException

Creates a standalone connector.

Parameters:

fn - a function that initializes a builder to create the CreateConnectorRequest

Throws:

IOException

OpenSearchException

createController

public CreateControllerResponse createController(CreateControllerRequest request)
                                          throws IOException,
OpenSearchException

Creates a controller.

Throws:

IOException

OpenSearchException

createController

public final CreateControllerResponse createController(Function<CreateControllerRequest.Builder,ObjectBuilder<CreateControllerRequest>> fn)
                                                throws IOException,
OpenSearchException

Creates a controller.

Parameters:

fn - a function that initializes a builder to create the CreateControllerRequest

Throws:

IOException

OpenSearchException

createMemory

public CreateMemoryResponse createMemory(CreateMemoryRequest request)
                                  throws IOException,
OpenSearchException

Create a memory.

Throws:

IOException

OpenSearchException

createMemory

public final CreateMemoryResponse createMemory(Function<CreateMemoryRequest.Builder,ObjectBuilder<CreateMemoryRequest>> fn)
                                        throws IOException,
OpenSearchException

Create a memory.

Parameters:

fn - a function that initializes a builder to create the CreateMemoryRequest

Throws:

IOException

OpenSearchException

createMemory

public final CreateMemoryResponse createMemory()
                                        throws IOException,
OpenSearchException

Create a memory.

Throws:

IOException

OpenSearchException

createMessage

public CreateMessageResponse createMessage(CreateMessageRequest request)
                                    throws IOException,
OpenSearchException

Create a message.

Throws:

IOException

OpenSearchException

createMessage

public final CreateMessageResponse createMessage(Function<CreateMessageRequest.Builder,ObjectBuilder<CreateMessageRequest>> fn)
                                          throws IOException,
OpenSearchException

Create a message.

Parameters:

fn - a function that initializes a builder to create the CreateMessageRequest

Throws:

IOException

OpenSearchException

createModelMeta

@Deprecated
public CreateModelMetaResponse createModelMeta(CreateModelMetaRequest request)
                                        throws IOException,
OpenSearchException

Deprecated.

Registers model metadata.

Throws:

IOException

OpenSearchException

createModelMeta

@Deprecated
public final CreateModelMetaResponse createModelMeta(Function<CreateModelMetaRequest.Builder,ObjectBuilder<CreateModelMetaRequest>> fn)
                                              throws IOException,
OpenSearchException

Deprecated.

Registers model metadata.

Parameters:

fn - a function that initializes a builder to create the CreateModelMetaRequest

Throws:

IOException

OpenSearchException

deleteAgent

public DeleteAgentResponse deleteAgent(DeleteAgentRequest request)
                                throws IOException,
OpenSearchException

Delete an agent.

Throws:

IOException

OpenSearchException

deleteAgent

public final DeleteAgentResponse deleteAgent(Function<DeleteAgentRequest.Builder,ObjectBuilder<DeleteAgentRequest>> fn)
                                      throws IOException,
OpenSearchException

Delete an agent.

Parameters:

fn - a function that initializes a builder to create the DeleteAgentRequest

Throws:

IOException

OpenSearchException

deleteConnector

public DeleteConnectorResponse deleteConnector(DeleteConnectorRequest request)
                                        throws IOException,
OpenSearchException

Deletes a standalone connector.

Throws:

IOException

OpenSearchException

deleteConnector

public final DeleteConnectorResponse deleteConnector(Function<DeleteConnectorRequest.Builder,ObjectBuilder<DeleteConnectorRequest>> fn)
                                              throws IOException,
OpenSearchException

Deletes a standalone connector.

Parameters:

fn - a function that initializes a builder to create the DeleteConnectorRequest

Throws:

IOException

OpenSearchException

deleteController

public DeleteControllerResponse deleteController(DeleteControllerRequest request)
                                          throws IOException,
OpenSearchException

Deletes a controller.

Throws:

IOException

OpenSearchException

deleteController

public final DeleteControllerResponse deleteController(Function<DeleteControllerRequest.Builder,ObjectBuilder<DeleteControllerRequest>> fn)
                                                throws IOException,
OpenSearchException

Deletes a controller.

Parameters:

fn - a function that initializes a builder to create the DeleteControllerRequest

Throws:

IOException

OpenSearchException

deleteMemory

public DeleteMemoryResponse deleteMemory(DeleteMemoryRequest request)
                                  throws IOException,
OpenSearchException

Delete a memory.

Throws:

IOException

OpenSearchException

deleteMemory

public final DeleteMemoryResponse deleteMemory(Function<DeleteMemoryRequest.Builder,ObjectBuilder<DeleteMemoryRequest>> fn)
                                        throws IOException,
OpenSearchException

Delete a memory.

Parameters:

fn - a function that initializes a builder to create the DeleteMemoryRequest

Throws:

IOException

OpenSearchException

deleteModel

public DeleteModelResponse deleteModel(DeleteModelRequest request)
                                throws IOException,
OpenSearchException

Deletes a model.

Throws:

IOException

OpenSearchException

deleteModel

public final DeleteModelResponse deleteModel(Function<DeleteModelRequest.Builder,ObjectBuilder<DeleteModelRequest>> fn)
                                      throws IOException,
OpenSearchException

Deletes a model.

Parameters:

fn - a function that initializes a builder to create the DeleteModelRequest

Throws:

IOException

OpenSearchException

deleteModelGroup

public DeleteModelGroupResponse deleteModelGroup(DeleteModelGroupRequest request)
                                          throws IOException,
OpenSearchException

Deletes a model group.

Throws:

IOException

OpenSearchException

deleteModelGroup

public final DeleteModelGroupResponse deleteModelGroup(Function<DeleteModelGroupRequest.Builder,ObjectBuilder<DeleteModelGroupRequest>> fn)
                                                throws IOException,
OpenSearchException

Deletes a model group.

Parameters:

fn - a function that initializes a builder to create the DeleteModelGroupRequest

Throws:

IOException

OpenSearchException

deleteTask

public DeleteTaskResponse deleteTask(DeleteTaskRequest request)
                              throws IOException,
OpenSearchException

Deletes a task.

Throws:

IOException

OpenSearchException

deleteTask

public final DeleteTaskResponse deleteTask(Function<DeleteTaskRequest.Builder,ObjectBuilder<DeleteTaskRequest>> fn)
                                    throws IOException,
OpenSearchException

Deletes a task.

Parameters:

fn - a function that initializes a builder to create the DeleteTaskRequest

Throws:

IOException

OpenSearchException

deployModel

public DeployModelResponse deployModel(DeployModelRequest request)
                                throws IOException,
OpenSearchException

Deploys a model.

Throws:

IOException

OpenSearchException

deployModel

public final DeployModelResponse deployModel(Function<DeployModelRequest.Builder,ObjectBuilder<DeployModelRequest>> fn)
                                      throws IOException,
OpenSearchException

Deploys a model.

Parameters:

fn - a function that initializes a builder to create the DeployModelRequest

Throws:

IOException

OpenSearchException

executeAgent

public ExecuteAgentResponse executeAgent(ExecuteAgentRequest request)
                                  throws IOException,
OpenSearchException

Execute an agent.

Throws:

IOException

OpenSearchException

executeAgent

public final ExecuteAgentResponse executeAgent(Function<ExecuteAgentRequest.Builder,ObjectBuilder<ExecuteAgentRequest>> fn)
                                        throws IOException,
OpenSearchException

Execute an agent.

Parameters:

fn - a function that initializes a builder to create the ExecuteAgentRequest

Throws:

IOException

OpenSearchException

executeAgentStream

public ExecuteAgentStreamResponse executeAgentStream(ExecuteAgentStreamRequest request)
                                              throws IOException,
OpenSearchException

Execute an agent in streaming mode.

Throws:

IOException

OpenSearchException

executeAgentStream

public final ExecuteAgentStreamResponse executeAgentStream(Function<ExecuteAgentStreamRequest.Builder,ObjectBuilder<ExecuteAgentStreamRequest>> fn)
                                                    throws IOException,
OpenSearchException

Execute an agent in streaming mode.

Parameters:

fn - a function that initializes a builder to create the ExecuteAgentStreamRequest

Throws:

IOException

OpenSearchException

getAgent

public GetAgentResponse getAgent(GetAgentRequest request)
                          throws IOException,
OpenSearchException

Get an agent.

Throws:

IOException

OpenSearchException

getAgent

public final GetAgentResponse getAgent(Function<GetAgentRequest.Builder,ObjectBuilder<GetAgentRequest>> fn)
                                throws IOException,
OpenSearchException

Get an agent.

Parameters:

fn - a function that initializes a builder to create the GetAgentRequest

Throws:

IOException

OpenSearchException

getAllMemories

public GetAllMemoriesResponse getAllMemories(GetAllMemoriesRequest request)
                                      throws IOException,
OpenSearchException

Get all memories.

Throws:

IOException

OpenSearchException

getAllMemories

public final GetAllMemoriesResponse getAllMemories(Function<GetAllMemoriesRequest.Builder,ObjectBuilder<GetAllMemoriesRequest>> fn)
                                            throws IOException,
OpenSearchException

Get all memories.

Parameters:

fn - a function that initializes a builder to create the GetAllMemoriesRequest

Throws:

IOException

OpenSearchException

getAllMemories

public final GetAllMemoriesResponse getAllMemories()
                                            throws IOException,
OpenSearchException

Get all memories.

Throws:

IOException

OpenSearchException

getAllMessages

public GetAllMessagesResponse getAllMessages(GetAllMessagesRequest request)
                                      throws IOException,
OpenSearchException

Get all messages in a memory.

Throws:

IOException

OpenSearchException

getAllMessages

public final GetAllMessagesResponse getAllMessages(Function<GetAllMessagesRequest.Builder,ObjectBuilder<GetAllMessagesRequest>> fn)
                                            throws IOException,
OpenSearchException

Get all messages in a memory.

Parameters:

fn - a function that initializes a builder to create the GetAllMessagesRequest

Throws:

IOException

OpenSearchException

getAllTools

public GetAllToolsResponse getAllTools(GetAllToolsRequest request)
                                throws IOException,
OpenSearchException

Get tools.

Throws:

IOException

OpenSearchException

getAllTools

public final GetAllToolsResponse getAllTools(Function<GetAllToolsRequest.Builder,ObjectBuilder<GetAllToolsRequest>> fn)
                                      throws IOException,
OpenSearchException

Get tools.

Parameters:

fn - a function that initializes a builder to create the GetAllToolsRequest

Throws:

IOException

OpenSearchException

getAllTools

public final GetAllToolsResponse getAllTools()
                                      throws IOException,
OpenSearchException

Get tools.

Throws:

IOException

OpenSearchException

getConnector

public GetConnectorResponse getConnector(GetConnectorRequest request)
                                  throws IOException,
OpenSearchException

Retrieves a standalone connector.

Throws:

IOException

OpenSearchException

getConnector

public final GetConnectorResponse getConnector(Function<GetConnectorRequest.Builder,ObjectBuilder<GetConnectorRequest>> fn)
                                        throws IOException,
OpenSearchException

Retrieves a standalone connector.

Parameters:

fn - a function that initializes a builder to create the GetConnectorRequest

Throws:

IOException

OpenSearchException

getController

public GetControllerResponse getController(GetControllerRequest request)
                                    throws IOException,
OpenSearchException

Retrieves a controller.

Throws:

IOException

OpenSearchException

getController

public final GetControllerResponse getController(Function<GetControllerRequest.Builder,ObjectBuilder<GetControllerRequest>> fn)
                                          throws IOException,
OpenSearchException

Retrieves a controller.

Parameters:

fn - a function that initializes a builder to create the GetControllerRequest

Throws:

IOException

OpenSearchException

getMemory

public GetMemoryResponse getMemory(GetMemoryRequest request)
                            throws IOException,
OpenSearchException

Get a memory.

Throws:

IOException

OpenSearchException

getMemory

public final GetMemoryResponse getMemory(Function<GetMemoryRequest.Builder,ObjectBuilder<GetMemoryRequest>> fn)
                                  throws IOException,
OpenSearchException

Get a memory.

Parameters:

fn - a function that initializes a builder to create the GetMemoryRequest

Throws:

IOException

OpenSearchException

getMessage

public GetMessageResponse getMessage(GetMessageRequest request)
                              throws IOException,
OpenSearchException

Get a message.

Throws:

IOException

OpenSearchException

getMessage

public final GetMessageResponse getMessage(Function<GetMessageRequest.Builder,ObjectBuilder<GetMessageRequest>> fn)
                                    throws IOException,
OpenSearchException

Get a message.

Parameters:

fn - a function that initializes a builder to create the GetMessageRequest

Throws:

IOException

OpenSearchException

getMessageTraces

public GetMessageTracesResponse getMessageTraces(GetMessageTracesRequest request)
                                          throws IOException,
OpenSearchException

Get a message traces.

Throws:

IOException

OpenSearchException

getMessageTraces

public final GetMessageTracesResponse getMessageTraces(Function<GetMessageTracesRequest.Builder,ObjectBuilder<GetMessageTracesRequest>> fn)
                                                throws IOException,
OpenSearchException

Get a message traces.

Parameters:

fn - a function that initializes a builder to create the GetMessageTracesRequest

Throws:

IOException

OpenSearchException

getModel

public GetModelResponse getModel(GetModelRequest request)
                          throws IOException,
OpenSearchException

Retrieves a model.

Throws:

IOException

OpenSearchException

getModel

public final GetModelResponse getModel(Function<GetModelRequest.Builder,ObjectBuilder<GetModelRequest>> fn)
                                throws IOException,
OpenSearchException

Retrieves a model.

Parameters:

fn - a function that initializes a builder to create the GetModelRequest

Throws:

IOException

OpenSearchException

getModelGroup

public GetModelGroupResponse getModelGroup(GetModelGroupRequest request)
                                    throws IOException,
OpenSearchException

Retrieves a model group.

Throws:

IOException

OpenSearchException

getModelGroup

public final GetModelGroupResponse getModelGroup(Function<GetModelGroupRequest.Builder,ObjectBuilder<GetModelGroupRequest>> fn)
                                          throws IOException,
OpenSearchException

Retrieves a model group.

Parameters:

fn - a function that initializes a builder to create the GetModelGroupRequest

Throws:

IOException

OpenSearchException

getProfile

public GetProfileResponse getProfile(GetProfileRequest request)
                              throws IOException,
OpenSearchException

Get a profile.

Throws:

IOException

OpenSearchException

getProfile

public final GetProfileResponse getProfile(Function<GetProfileRequest.Builder,ObjectBuilder<GetProfileRequest>> fn)
                                    throws IOException,
OpenSearchException

Get a profile.

Parameters:

fn - a function that initializes a builder to create the GetProfileRequest

Throws:

IOException

OpenSearchException

getProfile

public final GetProfileResponse getProfile()
                                    throws IOException,
OpenSearchException

Get a profile.

Throws:

IOException

OpenSearchException

getProfileModels

public GetProfileModelsResponse getProfileModels(GetProfileModelsRequest request)
                                          throws IOException,
OpenSearchException

Get a profile models.

Throws:

IOException

OpenSearchException

getProfileModels

public final GetProfileModelsResponse getProfileModels(Function<GetProfileModelsRequest.Builder,ObjectBuilder<GetProfileModelsRequest>> fn)
                                                throws IOException,
OpenSearchException

Get a profile models.

Parameters:

fn - a function that initializes a builder to create the GetProfileModelsRequest

Throws:

IOException

OpenSearchException

getProfileModels

public final GetProfileModelsResponse getProfileModels()
                                                throws IOException,
OpenSearchException

Get a profile models.

Throws:

IOException

OpenSearchException

getProfileTasks

public GetProfileTasksResponse getProfileTasks(GetProfileTasksRequest request)
                                        throws IOException,
OpenSearchException

Get a profile tasks.

Throws:

IOException

OpenSearchException

getProfileTasks

public final GetProfileTasksResponse getProfileTasks(Function<GetProfileTasksRequest.Builder,ObjectBuilder<GetProfileTasksRequest>> fn)
                                              throws IOException,
OpenSearchException

Get a profile tasks.

Parameters:

fn - a function that initializes a builder to create the GetProfileTasksRequest

Throws:

IOException

OpenSearchException

getProfileTasks

public final GetProfileTasksResponse getProfileTasks()
                                              throws IOException,
OpenSearchException

Get a profile tasks.

Throws:

IOException

OpenSearchException

getStats

public GetStatsResponse getStats(GetStatsRequest request)
                          throws IOException,
OpenSearchException

Get stats.

Throws:

IOException

OpenSearchException

getStats

public final GetStatsResponse getStats(Function<GetStatsRequest.Builder,ObjectBuilder<GetStatsRequest>> fn)
                                throws IOException,
OpenSearchException

Get stats.

Parameters:

fn - a function that initializes a builder to create the GetStatsRequest

Throws:

IOException

OpenSearchException

getStats

public final GetStatsResponse getStats()
                                throws IOException,
OpenSearchException

Get stats.

Throws:

IOException

OpenSearchException

getTask

public GetTaskResponse getTask(GetTaskRequest request)
                        throws IOException,
OpenSearchException

Retrieves a task.

Throws:

IOException

OpenSearchException

getTask

public final GetTaskResponse getTask(Function<GetTaskRequest.Builder,ObjectBuilder<GetTaskRequest>> fn)
                              throws IOException,
OpenSearchException

Retrieves a task.

Parameters:

fn - a function that initializes a builder to create the GetTaskRequest

Throws:

IOException

OpenSearchException

getTool

public GetToolResponse getTool(GetToolRequest request)
                        throws IOException,
OpenSearchException

Get tools.

Throws:

IOException

OpenSearchException

getTool

public final GetToolResponse getTool(Function<GetToolRequest.Builder,ObjectBuilder<GetToolRequest>> fn)
                              throws IOException,
OpenSearchException

Get tools.

Parameters:

fn - a function that initializes a builder to create the GetToolRequest

Throws:

IOException

OpenSearchException

loadModel

@Deprecated
public LoadModelResponse loadModel(LoadModelRequest request)
                            throws IOException,
OpenSearchException

Deprecated.

Deploys a model.

Throws:

IOException

OpenSearchException

loadModel

@Deprecated
public final LoadModelResponse loadModel(Function<LoadModelRequest.Builder,ObjectBuilder<LoadModelRequest>> fn)
                                  throws IOException,
OpenSearchException

Deprecated.

Deploys a model.

Parameters:

fn - a function that initializes a builder to create the LoadModelRequest

Throws:

IOException

OpenSearchException

predictModelStream

public PredictModelStreamResponse predictModelStream(PredictModelStreamRequest request)
                                              throws IOException,
OpenSearchException

Predicts a model in streaming mode.

Throws:

IOException

OpenSearchException

predictModelStream

public final PredictModelStreamResponse predictModelStream(Function<PredictModelStreamRequest.Builder,ObjectBuilder<PredictModelStreamRequest>> fn)
                                                    throws IOException,
OpenSearchException

Predicts a model in streaming mode.

Parameters:

fn - a function that initializes a builder to create the PredictModelStreamRequest

Throws:

IOException

OpenSearchException

registerAgents

public RegisterAgentsResponse registerAgents(RegisterAgentsRequest request)
                                      throws IOException,
OpenSearchException

Register an agent.

Throws:

IOException

OpenSearchException

registerAgents

public final RegisterAgentsResponse registerAgents(Function<RegisterAgentsRequest.Builder,ObjectBuilder<RegisterAgentsRequest>> fn)
                                            throws IOException,
OpenSearchException

Register an agent.

Parameters:

fn - a function that initializes a builder to create the RegisterAgentsRequest

Throws:

IOException

OpenSearchException

registerModel

public RegisterModelResponse registerModel(RegisterModelRequest request)
                                    throws IOException,
OpenSearchException

Registers a model.

Throws:

IOException

OpenSearchException

registerModel

public final RegisterModelResponse registerModel(Function<RegisterModelRequest.Builder,ObjectBuilder<RegisterModelRequest>> fn)
                                          throws IOException,
OpenSearchException

Registers a model.

Parameters:

fn - a function that initializes a builder to create the RegisterModelRequest

Throws:

IOException

OpenSearchException

registerModelGroup

public RegisterModelGroupResponse registerModelGroup(RegisterModelGroupRequest request)
                                              throws IOException,
OpenSearchException

Registers a model group.

Throws:

IOException

OpenSearchException

registerModelGroup

public final RegisterModelGroupResponse registerModelGroup(Function<RegisterModelGroupRequest.Builder,ObjectBuilder<RegisterModelGroupRequest>> fn)
                                                    throws IOException,
OpenSearchException

Registers a model group.

Parameters:

fn - a function that initializes a builder to create the RegisterModelGroupRequest

Throws:

IOException

OpenSearchException

registerModelMeta

public RegisterModelMetaResponse registerModelMeta(RegisterModelMetaRequest request)
                                            throws IOException,
OpenSearchException

Registers model metadata.

Throws:

IOException

OpenSearchException

registerModelMeta

public final RegisterModelMetaResponse registerModelMeta(Function<RegisterModelMetaRequest.Builder,ObjectBuilder<RegisterModelMetaRequest>> fn)
                                                  throws IOException,
OpenSearchException

Registers model metadata.

Parameters:

fn - a function that initializes a builder to create the RegisterModelMetaRequest

Throws:

IOException

OpenSearchException

undeployModel

public UndeployModelResponse undeployModel(UndeployModelRequest request)
                                    throws IOException,
OpenSearchException

Undeploys a model.

Throws:

IOException

OpenSearchException

undeployModel

public final UndeployModelResponse undeployModel(Function<UndeployModelRequest.Builder,ObjectBuilder<UndeployModelRequest>> fn)
                                          throws IOException,
OpenSearchException

Undeploys a model.

Parameters:

fn - a function that initializes a builder to create the UndeployModelRequest

Throws:

IOException

OpenSearchException

undeployModel

public final UndeployModelResponse undeployModel()
                                          throws IOException,
OpenSearchException

Undeploys a model.

Throws:

IOException

OpenSearchException

unloadModel

@Deprecated
public UnloadModelResponse unloadModel(UnloadModelRequest request)
                                throws IOException,
OpenSearchException

Deprecated.

Unloads a model.

Throws:

IOException

OpenSearchException

unloadModel

@Deprecated
public final UnloadModelResponse unloadModel(Function<UnloadModelRequest.Builder,ObjectBuilder<UnloadModelRequest>> fn)
                                      throws IOException,
OpenSearchException

Deprecated.

Unloads a model.

Parameters:

fn - a function that initializes a builder to create the UnloadModelRequest

Throws:

IOException

OpenSearchException

unloadModel

@Deprecated
public final UnloadModelResponse unloadModel()
                                      throws IOException,
OpenSearchException

Deprecated.

Unloads a model.

Throws:

IOException

OpenSearchException

updateConnector

public UpdateConnectorResponse updateConnector(UpdateConnectorRequest request)
                                        throws IOException,
OpenSearchException

Updates a standalone connector.

Throws:

IOException

OpenSearchException

updateConnector

public final UpdateConnectorResponse updateConnector(Function<UpdateConnectorRequest.Builder,ObjectBuilder<UpdateConnectorRequest>> fn)
                                              throws IOException,
OpenSearchException

Updates a standalone connector.

Parameters:

fn - a function that initializes a builder to create the UpdateConnectorRequest

Throws:

IOException

OpenSearchException

updateController

public UpdateControllerResponse updateController(UpdateControllerRequest request)
                                          throws IOException,
OpenSearchException

Updates a controller.

Throws:

IOException

OpenSearchException

updateController

public final UpdateControllerResponse updateController(Function<UpdateControllerRequest.Builder,ObjectBuilder<UpdateControllerRequest>> fn)
                                                throws IOException,
OpenSearchException

Updates a controller.

Parameters:

fn - a function that initializes a builder to create the UpdateControllerRequest

Throws:

IOException

OpenSearchException

updateMemory

public UpdateMemoryResponse updateMemory(UpdateMemoryRequest request)
                                  throws IOException,
OpenSearchException

Update a memory.

Throws:

IOException

OpenSearchException

updateMemory

public final UpdateMemoryResponse updateMemory(Function<UpdateMemoryRequest.Builder,ObjectBuilder<UpdateMemoryRequest>> fn)
                                        throws IOException,
OpenSearchException

Update a memory.

Parameters:

fn - a function that initializes a builder to create the UpdateMemoryRequest

Throws:

IOException

OpenSearchException

updateMessage

public UpdateMessageResponse updateMessage(UpdateMessageRequest request)
                                    throws IOException,
OpenSearchException

Update a message.

Throws:

IOException

OpenSearchException

updateMessage

public final UpdateMessageResponse updateMessage(Function<UpdateMessageRequest.Builder,ObjectBuilder<UpdateMessageRequest>> fn)
                                          throws IOException,
OpenSearchException

Update a message.

Parameters:

fn - a function that initializes a builder to create the UpdateMessageRequest

Throws:

IOException

OpenSearchException

updateModel

public UpdateModelResponse updateModel(UpdateModelRequest request)
                                throws IOException,
OpenSearchException

Updates a model.

Throws:

IOException

OpenSearchException

updateModel

public final UpdateModelResponse updateModel(Function<UpdateModelRequest.Builder,ObjectBuilder<UpdateModelRequest>> fn)
                                      throws IOException,
OpenSearchException

Updates a model.

Parameters:

fn - a function that initializes a builder to create the UpdateModelRequest

Throws:

IOException

OpenSearchException

updateModelGroup

public UpdateModelGroupResponse updateModelGroup(UpdateModelGroupRequest request)
                                          throws IOException,
OpenSearchException

Updates a model group.

Throws:

IOException

OpenSearchException

updateModelGroup

public final UpdateModelGroupResponse updateModelGroup(Function<UpdateModelGroupRequest.Builder,ObjectBuilder<UpdateModelGroupRequest>> fn)
                                                throws IOException,
OpenSearchException

Updates a model group.

Parameters:

fn - a function that initializes a builder to create the UpdateModelGroupRequest

Throws:

IOException

OpenSearchException

uploadChunk

public UploadChunkResponse uploadChunk(UploadChunkRequest request)
                                throws IOException,
OpenSearchException

Uploads model chunk.

Throws:

IOException

OpenSearchException

uploadChunk

public final UploadChunkResponse uploadChunk(Function<UploadChunkRequest.Builder,ObjectBuilder<UploadChunkRequest>> fn)
                                      throws IOException,
OpenSearchException

Uploads model chunk.

Parameters:

fn - a function that initializes a builder to create the UploadChunkRequest

Throws:

IOException

OpenSearchException

uploadModel

@Deprecated
public UploadModelResponse uploadModel(UploadModelRequest request)
                                throws IOException,
OpenSearchException

Deprecated.

Registers a model.

Throws:

IOException

OpenSearchException

uploadModel

@Deprecated
public final UploadModelResponse uploadModel(Function<UploadModelRequest.Builder,ObjectBuilder<UploadModelRequest>> fn)
                                      throws IOException,
OpenSearchException

Deprecated.

Registers a model.

Parameters:

fn - a function that initializes a builder to create the UploadModelRequest

Throws:

IOException

OpenSearchException