Package org.opensearch.client.opensearch.ml

Class OpenSearchMlAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.ml.OpenSearchMlAsyncClient

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

Client for the ml namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

OpenSearchMlAsyncClient

public OpenSearchMlAsyncClient(OpenSearchTransport transport)

OpenSearchMlAsyncClient

public OpenSearchMlAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchMlAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchMlAsyncClient>

createConnector

public CompletableFuture<CreateConnectorResponse> createConnector(CreateConnectorRequest request)
                                                           throws IOException,
OpenSearchException

Creates a standalone connector.

Throws:

IOException

OpenSearchException

createConnector

public final CompletableFuture<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 CompletableFuture<CreateControllerResponse> createController(CreateControllerRequest request)
                                                             throws IOException,
OpenSearchException

Creates a controller.

Throws:

IOException

OpenSearchException

createController

public final CompletableFuture<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 CompletableFuture<CreateMemoryResponse> createMemory(CreateMemoryRequest request)
                                                     throws IOException,
OpenSearchException

Create a memory.

Throws:

IOException

OpenSearchException

createMemory

public final CompletableFuture<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 CompletableFuture<CreateMemoryResponse> createMemory()
                                                           throws IOException,
OpenSearchException

Create a memory.

Throws:

IOException

OpenSearchException

createMessage

public CompletableFuture<CreateMessageResponse> createMessage(CreateMessageRequest request)
                                                       throws IOException,
OpenSearchException

Create a message.

Throws:

IOException

OpenSearchException

createMessage

public final CompletableFuture<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 CompletableFuture<CreateModelMetaResponse> createModelMeta(CreateModelMetaRequest request)
                                                           throws IOException,
OpenSearchException

Deprecated.

Registers model metadata.

Throws:

IOException

OpenSearchException

createModelMeta

@Deprecated
public final CompletableFuture<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 CompletableFuture<DeleteAgentResponse> deleteAgent(DeleteAgentRequest request)
                                                   throws IOException,
OpenSearchException

Delete an agent.

Throws:

IOException

OpenSearchException

deleteAgent

public final CompletableFuture<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 CompletableFuture<DeleteConnectorResponse> deleteConnector(DeleteConnectorRequest request)
                                                           throws IOException,
OpenSearchException

Deletes a standalone connector.

Throws:

IOException

OpenSearchException

deleteConnector

public final CompletableFuture<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 CompletableFuture<DeleteControllerResponse> deleteController(DeleteControllerRequest request)
                                                             throws IOException,
OpenSearchException

Deletes a controller.

Throws:

IOException

OpenSearchException

deleteController

public final CompletableFuture<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 CompletableFuture<DeleteMemoryResponse> deleteMemory(DeleteMemoryRequest request)
                                                     throws IOException,
OpenSearchException

Delete a memory.

Throws:

IOException

OpenSearchException

deleteMemory

public final CompletableFuture<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 CompletableFuture<DeleteModelResponse> deleteModel(DeleteModelRequest request)
                                                   throws IOException,
OpenSearchException

Deletes a model.

Throws:

IOException

OpenSearchException

deleteModel

public final CompletableFuture<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 CompletableFuture<DeleteModelGroupResponse> deleteModelGroup(DeleteModelGroupRequest request)
                                                             throws IOException,
OpenSearchException

Deletes a model group.

Throws:

IOException

OpenSearchException

deleteModelGroup

public final CompletableFuture<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 CompletableFuture<DeleteTaskResponse> deleteTask(DeleteTaskRequest request)
                                                 throws IOException,
OpenSearchException

Deletes a task.

Throws:

IOException

OpenSearchException

deleteTask

public final CompletableFuture<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 CompletableFuture<DeployModelResponse> deployModel(DeployModelRequest request)
                                                   throws IOException,
OpenSearchException

Deploys a model.

Throws:

IOException

OpenSearchException

deployModel

public final CompletableFuture<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 CompletableFuture<ExecuteAgentResponse> executeAgent(ExecuteAgentRequest request)
                                                     throws IOException,
OpenSearchException

Execute an agent.

Throws:

IOException

OpenSearchException

executeAgent

public final CompletableFuture<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

getAgent

public CompletableFuture<GetAgentResponse> getAgent(GetAgentRequest request)
                                             throws IOException,
OpenSearchException

Get an agent.

Throws:

IOException

OpenSearchException

getAgent

public final CompletableFuture<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 CompletableFuture<GetAllMemoriesResponse> getAllMemories(GetAllMemoriesRequest request)
                                                         throws IOException,
OpenSearchException

Get all memories.

Throws:

IOException

OpenSearchException

getAllMemories

public final CompletableFuture<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 CompletableFuture<GetAllMemoriesResponse> getAllMemories()
                                                               throws IOException,
OpenSearchException

Get all memories.

Throws:

IOException

OpenSearchException

getAllMessages

public CompletableFuture<GetAllMessagesResponse> getAllMessages(GetAllMessagesRequest request)
                                                         throws IOException,
OpenSearchException

Get all messages in a memory.

Throws:

IOException

OpenSearchException

getAllMessages

public final CompletableFuture<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 CompletableFuture<GetAllToolsResponse> getAllTools(GetAllToolsRequest request)
                                                   throws IOException,
OpenSearchException

Get tools.

Throws:

IOException

OpenSearchException

getAllTools

public final CompletableFuture<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 CompletableFuture<GetAllToolsResponse> getAllTools()
                                                         throws IOException,
OpenSearchException

Get tools.

Throws:

IOException

OpenSearchException

getConnector

public CompletableFuture<GetConnectorResponse> getConnector(GetConnectorRequest request)
                                                     throws IOException,
OpenSearchException

Retrieves a standalone connector.

Throws:

IOException

OpenSearchException

getConnector

public final CompletableFuture<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 CompletableFuture<GetControllerResponse> getController(GetControllerRequest request)
                                                       throws IOException,
OpenSearchException

Retrieves a controller.

Throws:

IOException

OpenSearchException

getController

public final CompletableFuture<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 CompletableFuture<GetMemoryResponse> getMemory(GetMemoryRequest request)
                                               throws IOException,
OpenSearchException

Get a memory.

Throws:

IOException

OpenSearchException

getMemory

public final CompletableFuture<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 CompletableFuture<GetMessageResponse> getMessage(GetMessageRequest request)
                                                 throws IOException,
OpenSearchException

Get a message.

Throws:

IOException

OpenSearchException

getMessage

public final CompletableFuture<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 CompletableFuture<GetMessageTracesResponse> getMessageTraces(GetMessageTracesRequest request)
                                                             throws IOException,
OpenSearchException

Get a message traces.

Throws:

IOException

OpenSearchException

getMessageTraces

public final CompletableFuture<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 CompletableFuture<GetModelResponse> getModel(GetModelRequest request)
                                             throws IOException,
OpenSearchException

Retrieves a model.

Throws:

IOException

OpenSearchException

getModel

public final CompletableFuture<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 CompletableFuture<GetModelGroupResponse> getModelGroup(GetModelGroupRequest request)
                                                       throws IOException,
OpenSearchException

Retrieves a model group.

Throws:

IOException

OpenSearchException

getModelGroup

public final CompletableFuture<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 CompletableFuture<GetProfileResponse> getProfile(GetProfileRequest request)
                                                 throws IOException,
OpenSearchException

Get a profile.

Throws:

IOException

OpenSearchException

getProfile

public final CompletableFuture<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 CompletableFuture<GetProfileResponse> getProfile()
                                                       throws IOException,
OpenSearchException

Get a profile.

Throws:

IOException

OpenSearchException

getProfileModels

public CompletableFuture<GetProfileModelsResponse> getProfileModels(GetProfileModelsRequest request)
                                                             throws IOException,
OpenSearchException

Get a profile models.

Throws:

IOException

OpenSearchException

getProfileModels

public final CompletableFuture<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 CompletableFuture<GetProfileModelsResponse> getProfileModels()
                                                                   throws IOException,
OpenSearchException

Get a profile models.

Throws:

IOException

OpenSearchException

getProfileTasks

public CompletableFuture<GetProfileTasksResponse> getProfileTasks(GetProfileTasksRequest request)
                                                           throws IOException,
OpenSearchException

Get a profile tasks.

Throws:

IOException

OpenSearchException

getProfileTasks

public final CompletableFuture<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 CompletableFuture<GetProfileTasksResponse> getProfileTasks()
                                                                 throws IOException,
OpenSearchException

Get a profile tasks.

Throws:

IOException

OpenSearchException

getStats

public CompletableFuture<GetStatsResponse> getStats(GetStatsRequest request)
                                             throws IOException,
OpenSearchException

Get stats.

Throws:

IOException

OpenSearchException

getStats

public final CompletableFuture<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 CompletableFuture<GetStatsResponse> getStats()
                                                   throws IOException,
OpenSearchException

Get stats.

Throws:

IOException

OpenSearchException

getTask

public CompletableFuture<GetTaskResponse> getTask(GetTaskRequest request)
                                           throws IOException,
OpenSearchException

Retrieves a task.

Throws:

IOException

OpenSearchException

getTask

public final CompletableFuture<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 CompletableFuture<GetToolResponse> getTool(GetToolRequest request)
                                           throws IOException,
OpenSearchException

Get tools.

Throws:

IOException

OpenSearchException

getTool

public final CompletableFuture<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 CompletableFuture<LoadModelResponse> loadModel(LoadModelRequest request)
                                               throws IOException,
OpenSearchException

Deprecated.

Deploys a model.

Throws:

IOException

OpenSearchException

loadModel

@Deprecated
public final CompletableFuture<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

registerAgents

public CompletableFuture<RegisterAgentsResponse> registerAgents(RegisterAgentsRequest request)
                                                         throws IOException,
OpenSearchException

Register an agent.

Throws:

IOException

OpenSearchException

registerAgents

public final CompletableFuture<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 CompletableFuture<RegisterModelResponse> registerModel(RegisterModelRequest request)
                                                       throws IOException,
OpenSearchException

Registers a model.

Throws:

IOException

OpenSearchException

registerModel

public final CompletableFuture<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 CompletableFuture<RegisterModelGroupResponse> registerModelGroup(RegisterModelGroupRequest request)
                                                                 throws IOException,
OpenSearchException

Registers a model group.

Throws:

IOException

OpenSearchException

registerModelGroup

public final CompletableFuture<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 CompletableFuture<RegisterModelMetaResponse> registerModelMeta(RegisterModelMetaRequest request)
                                                               throws IOException,
OpenSearchException

Registers model metadata.

Throws:

IOException

OpenSearchException

registerModelMeta

public final CompletableFuture<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 CompletableFuture<UndeployModelResponse> undeployModel(UndeployModelRequest request)
                                                       throws IOException,
OpenSearchException

Undeploys a model.

Throws:

IOException

OpenSearchException

undeployModel

public final CompletableFuture<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 CompletableFuture<UndeployModelResponse> undeployModel()
                                                             throws IOException,
OpenSearchException

Undeploys a model.

Throws:

IOException

OpenSearchException

unloadModel

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

Deprecated.

Unloads a model.

Throws:

IOException

OpenSearchException

unloadModel

@Deprecated
public final CompletableFuture<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 CompletableFuture<UnloadModelResponse> unloadModel()
                                                         throws IOException,
OpenSearchException

Deprecated.

Unloads a model.

Throws:

IOException

OpenSearchException

updateConnector

public CompletableFuture<UpdateConnectorResponse> updateConnector(UpdateConnectorRequest request)
                                                           throws IOException,
OpenSearchException

Updates a standalone connector.

Throws:

IOException

OpenSearchException

updateConnector

public final CompletableFuture<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 CompletableFuture<UpdateControllerResponse> updateController(UpdateControllerRequest request)
                                                             throws IOException,
OpenSearchException

Updates a controller.

Throws:

IOException

OpenSearchException

updateController

public final CompletableFuture<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 CompletableFuture<UpdateMemoryResponse> updateMemory(UpdateMemoryRequest request)
                                                     throws IOException,
OpenSearchException

Update a memory.

Throws:

IOException

OpenSearchException

updateMemory

public final CompletableFuture<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 CompletableFuture<UpdateMessageResponse> updateMessage(UpdateMessageRequest request)
                                                       throws IOException,
OpenSearchException

Update a message.

Throws:

IOException

OpenSearchException

updateMessage

public final CompletableFuture<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 CompletableFuture<UpdateModelResponse> updateModel(UpdateModelRequest request)
                                                   throws IOException,
OpenSearchException

Updates a model.

Throws:

IOException

OpenSearchException

updateModel

public final CompletableFuture<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 CompletableFuture<UpdateModelGroupResponse> updateModelGroup(UpdateModelGroupRequest request)
                                                             throws IOException,
OpenSearchException

Updates a model group.

Throws:

IOException

OpenSearchException

updateModelGroup

public final CompletableFuture<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 CompletableFuture<UploadChunkResponse> uploadChunk(UploadChunkRequest request)
                                                   throws IOException,
OpenSearchException

Uploads model chunk.

Throws:

IOException

OpenSearchException

uploadChunk

public final CompletableFuture<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 CompletableFuture<UploadModelResponse> uploadModel(UploadModelRequest request)
                                                   throws IOException,
OpenSearchException

Deprecated.

Registers a model.

Throws:

IOException

OpenSearchException

uploadModel

@Deprecated
public final CompletableFuture<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