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

OpenSearchMlClient

public OpenSearchMlClient(OpenSearchTransport transport)

OpenSearchMlClient

public OpenSearchMlClient(OpenSearchTransport transport,
                          @Nullable
                          TransportOptions transportOptions)

Method Detail

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 java.io.IOException,
                                               OpenSearchException

Creates a standalone connector.

Throws:

java.io.IOException

OpenSearchException

createConnector

public final 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 DeleteAgentResponse deleteAgent(DeleteAgentRequest request)
                                throws java.io.IOException,
                                       OpenSearchException

Delete an agent.

Throws:

java.io.IOException

OpenSearchException

deleteAgent

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

Deletes a standalone connector.

Throws:

java.io.IOException

OpenSearchException

deleteConnector

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

Deletes a model.

Throws:

java.io.IOException

OpenSearchException

deleteModel

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

Deletes a model group.

Throws:

java.io.IOException

OpenSearchException

deleteModelGroup

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

Deletes a task.

Throws:

java.io.IOException

OpenSearchException

deleteTask

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

Deploys a model.

Throws:

java.io.IOException

OpenSearchException

deployModel

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

Retrieves a model group.

Throws:

java.io.IOException

OpenSearchException

getModelGroup

public final 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 GetTaskResponse getTask(GetTaskRequest request)
                        throws java.io.IOException,
                               OpenSearchException

Retrieves a task.

Throws:

java.io.IOException

OpenSearchException

getTask

public final 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 RegisterAgentsResponse registerAgents(RegisterAgentsRequest request)
                                      throws java.io.IOException,
                                             OpenSearchException

Register an agent.

Throws:

java.io.IOException

OpenSearchException

registerAgents

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

Registers a model.

Throws:

java.io.IOException

OpenSearchException

registerModel

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

Registers a model group.

Throws:

java.io.IOException

OpenSearchException

registerModelGroup

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

Undeploys a model.

Throws:

java.io.IOException

OpenSearchException

undeployModel

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