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
java.util.concurrent.CompletableFuture<CreateConnectorResponse>	createConnector(java.util.function.Function<CreateConnectorRequest.Builder,ObjectBuilder<CreateConnectorRequest>> fn)	Creates a standalone connector.
java.util.concurrent.CompletableFuture<CreateConnectorResponse>	createConnector(CreateConnectorRequest request)	Creates a standalone connector.
java.util.concurrent.CompletableFuture<DeleteAgentResponse>	deleteAgent(java.util.function.Function<DeleteAgentRequest.Builder,ObjectBuilder<DeleteAgentRequest>> fn)	Delete an agent.
java.util.concurrent.CompletableFuture<DeleteAgentResponse>	deleteAgent(DeleteAgentRequest request)	Delete an agent.
java.util.concurrent.CompletableFuture<DeleteConnectorResponse>	deleteConnector(java.util.function.Function<DeleteConnectorRequest.Builder,ObjectBuilder<DeleteConnectorRequest>> fn)	Deletes a standalone connector.
java.util.concurrent.CompletableFuture<DeleteConnectorResponse>	deleteConnector(DeleteConnectorRequest request)	Deletes a standalone connector.
java.util.concurrent.CompletableFuture<DeleteModelResponse>	deleteModel(java.util.function.Function<DeleteModelRequest.Builder,ObjectBuilder<DeleteModelRequest>> fn)	Deletes a model.
java.util.concurrent.CompletableFuture<DeleteModelResponse>	deleteModel(DeleteModelRequest request)	Deletes a model.
java.util.concurrent.CompletableFuture<DeleteModelGroupResponse>	deleteModelGroup(java.util.function.Function<DeleteModelGroupRequest.Builder,ObjectBuilder<DeleteModelGroupRequest>> fn)	Deletes a model group.
java.util.concurrent.CompletableFuture<DeleteModelGroupResponse>	deleteModelGroup(DeleteModelGroupRequest request)	Deletes a model group.
java.util.concurrent.CompletableFuture<DeleteTaskResponse>	deleteTask(java.util.function.Function<DeleteTaskRequest.Builder,ObjectBuilder<DeleteTaskRequest>> fn)	Deletes a task.
java.util.concurrent.CompletableFuture<DeleteTaskResponse>	deleteTask(DeleteTaskRequest request)	Deletes a task.
java.util.concurrent.CompletableFuture<DeployModelResponse>	deployModel(java.util.function.Function<DeployModelRequest.Builder,ObjectBuilder<DeployModelRequest>> fn)	Deploys a model.
java.util.concurrent.CompletableFuture<DeployModelResponse>	deployModel(DeployModelRequest request)	Deploys a model.
java.util.concurrent.CompletableFuture<GetModelGroupResponse>	getModelGroup(java.util.function.Function<GetModelGroupRequest.Builder,ObjectBuilder<GetModelGroupRequest>> fn)	Retrieves a model group.
java.util.concurrent.CompletableFuture<GetModelGroupResponse>	getModelGroup(GetModelGroupRequest request)	Retrieves a model group.
java.util.concurrent.CompletableFuture<GetTaskResponse>	getTask(java.util.function.Function<GetTaskRequest.Builder,ObjectBuilder<GetTaskRequest>> fn)	Retrieves a task.
java.util.concurrent.CompletableFuture<GetTaskResponse>	getTask(GetTaskRequest request)	Retrieves a task.
java.util.concurrent.CompletableFuture<RegisterAgentsResponse>	registerAgents(java.util.function.Function<RegisterAgentsRequest.Builder,ObjectBuilder<RegisterAgentsRequest>> fn)	Register an agent.
java.util.concurrent.CompletableFuture<RegisterAgentsResponse>	registerAgents(RegisterAgentsRequest request)	Register an agent.
java.util.concurrent.CompletableFuture<RegisterModelResponse>	registerModel(java.util.function.Function<RegisterModelRequest.Builder,ObjectBuilder<RegisterModelRequest>> fn)	Registers a model.
java.util.concurrent.CompletableFuture<RegisterModelResponse>	registerModel(RegisterModelRequest request)	Registers a model.
java.util.concurrent.CompletableFuture<RegisterModelGroupResponse>	registerModelGroup(java.util.function.Function<RegisterModelGroupRequest.Builder,ObjectBuilder<RegisterModelGroupRequest>> fn)	Registers a model group.
java.util.concurrent.CompletableFuture<RegisterModelGroupResponse>	registerModelGroup(RegisterModelGroupRequest request)	Registers a model group.
java.util.concurrent.CompletableFuture<UndeployModelResponse>	undeployModel(java.util.function.Function<UndeployModelRequest.Builder,ObjectBuilder<UndeployModelRequest>> fn)	Undeploys a model.
java.util.concurrent.CompletableFuture<UndeployModelResponse>	undeployModel(UndeployModelRequest request)	Undeploys a model.
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 Detail

OpenSearchMlAsyncClient

public OpenSearchMlAsyncClient(OpenSearchTransport transport)

OpenSearchMlAsyncClient

public OpenSearchMlAsyncClient(OpenSearchTransport transport,
                               @Nullable
                               TransportOptions transportOptions)

Method Detail

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 java.util.concurrent.CompletableFuture<CreateConnectorResponse> createConnector(CreateConnectorRequest request)
                                                                                throws java.io.IOException,
                                                                                       OpenSearchException

Creates a standalone connector.

Throws:

java.io.IOException

OpenSearchException

createConnector

public final java.util.concurrent.CompletableFuture<CreateConnectorResponse> createConnector(java.util.function.Function<CreateConnectorRequest.Builder,ObjectBuilder<CreateConnectorRequest>> fn)
                                                                                      throws java.io.IOException,
                                                                                             OpenSearchException

Creates a standalone connector.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteAgent

public java.util.concurrent.CompletableFuture<DeleteAgentResponse> deleteAgent(DeleteAgentRequest request)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Delete an agent.

Throws:

java.io.IOException

OpenSearchException

deleteAgent

public final java.util.concurrent.CompletableFuture<DeleteAgentResponse> deleteAgent(java.util.function.Function<DeleteAgentRequest.Builder,ObjectBuilder<DeleteAgentRequest>> fn)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Delete an agent.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteConnector

public java.util.concurrent.CompletableFuture<DeleteConnectorResponse> deleteConnector(DeleteConnectorRequest request)
                                                                                throws java.io.IOException,
                                                                                       OpenSearchException

Deletes a standalone connector.

Throws:

java.io.IOException

OpenSearchException

deleteConnector

public final java.util.concurrent.CompletableFuture<DeleteConnectorResponse> deleteConnector(java.util.function.Function<DeleteConnectorRequest.Builder,ObjectBuilder<DeleteConnectorRequest>> fn)
                                                                                      throws java.io.IOException,
                                                                                             OpenSearchException

Deletes a standalone connector.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteModel

public java.util.concurrent.CompletableFuture<DeleteModelResponse> deleteModel(DeleteModelRequest request)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Deletes a model.

Throws:

java.io.IOException

OpenSearchException

deleteModel

public final java.util.concurrent.CompletableFuture<DeleteModelResponse> deleteModel(java.util.function.Function<DeleteModelRequest.Builder,ObjectBuilder<DeleteModelRequest>> fn)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Deletes a model.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteModelGroup

public java.util.concurrent.CompletableFuture<DeleteModelGroupResponse> deleteModelGroup(DeleteModelGroupRequest request)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Deletes a model group.

Throws:

java.io.IOException

OpenSearchException

deleteModelGroup

public final java.util.concurrent.CompletableFuture<DeleteModelGroupResponse> deleteModelGroup(java.util.function.Function<DeleteModelGroupRequest.Builder,ObjectBuilder<DeleteModelGroupRequest>> fn)
                                                                                        throws java.io.IOException,
                                                                                               OpenSearchException

Deletes a model group.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteTask

public java.util.concurrent.CompletableFuture<DeleteTaskResponse> deleteTask(DeleteTaskRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Deletes a task.

Throws:

java.io.IOException

OpenSearchException

deleteTask

public final java.util.concurrent.CompletableFuture<DeleteTaskResponse> deleteTask(java.util.function.Function<DeleteTaskRequest.Builder,ObjectBuilder<DeleteTaskRequest>> fn)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Deletes a task.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deployModel

public java.util.concurrent.CompletableFuture<DeployModelResponse> deployModel(DeployModelRequest request)
                                                                        throws java.io.IOException,
                                                                               OpenSearchException

Deploys a model.

Throws:

java.io.IOException

OpenSearchException

deployModel

public final java.util.concurrent.CompletableFuture<DeployModelResponse> deployModel(java.util.function.Function<DeployModelRequest.Builder,ObjectBuilder<DeployModelRequest>> fn)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Deploys a model.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

getModelGroup

public java.util.concurrent.CompletableFuture<GetModelGroupResponse> getModelGroup(GetModelGroupRequest request)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Retrieves a model group.

Throws:

java.io.IOException

OpenSearchException

getModelGroup

public final java.util.concurrent.CompletableFuture<GetModelGroupResponse> getModelGroup(java.util.function.Function<GetModelGroupRequest.Builder,ObjectBuilder<GetModelGroupRequest>> fn)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Retrieves a model group.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

getTask

public java.util.concurrent.CompletableFuture<GetTaskResponse> getTask(GetTaskRequest request)
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Retrieves a task.

Throws:

java.io.IOException

OpenSearchException

getTask

public final java.util.concurrent.CompletableFuture<GetTaskResponse> getTask(java.util.function.Function<GetTaskRequest.Builder,ObjectBuilder<GetTaskRequest>> fn)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Retrieves a task.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

registerAgents

public java.util.concurrent.CompletableFuture<RegisterAgentsResponse> registerAgents(RegisterAgentsRequest request)
                                                                              throws java.io.IOException,
                                                                                     OpenSearchException

Register an agent.

Throws:

java.io.IOException

OpenSearchException

registerAgents

public final java.util.concurrent.CompletableFuture<RegisterAgentsResponse> registerAgents(java.util.function.Function<RegisterAgentsRequest.Builder,ObjectBuilder<RegisterAgentsRequest>> fn)
                                                                                    throws java.io.IOException,
                                                                                           OpenSearchException

Register an agent.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

registerModel

public java.util.concurrent.CompletableFuture<RegisterModelResponse> registerModel(RegisterModelRequest request)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Registers a model.

Throws:

java.io.IOException

OpenSearchException

registerModel

public final java.util.concurrent.CompletableFuture<RegisterModelResponse> registerModel(java.util.function.Function<RegisterModelRequest.Builder,ObjectBuilder<RegisterModelRequest>> fn)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Registers a model.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

registerModelGroup

public java.util.concurrent.CompletableFuture<RegisterModelGroupResponse> registerModelGroup(RegisterModelGroupRequest request)
                                                                                      throws java.io.IOException,
                                                                                             OpenSearchException

Registers a model group.

Throws:

java.io.IOException

OpenSearchException

registerModelGroup

public final java.util.concurrent.CompletableFuture<RegisterModelGroupResponse> registerModelGroup(java.util.function.Function<RegisterModelGroupRequest.Builder,ObjectBuilder<RegisterModelGroupRequest>> fn)
                                                                                            throws java.io.IOException,
                                                                                                   OpenSearchException

Registers a model group.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

undeployModel

public java.util.concurrent.CompletableFuture<UndeployModelResponse> undeployModel(UndeployModelRequest request)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Undeploys a model.

Throws:

java.io.IOException

OpenSearchException

undeployModel

public final java.util.concurrent.CompletableFuture<UndeployModelResponse> undeployModel(java.util.function.Function<UndeployModelRequest.Builder,ObjectBuilder<UndeployModelRequest>> fn)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Undeploys a model.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException