Package org.opensearch.ml.common.connector

Interface Connector

All Superinterfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, org.opensearch.core.common.io.stream.Writeable

All Known Implementing Classes:

AbstractConnector, AwsConnector, HttpConnector

public interface Connector
extends org.opensearch.core.xcontent.ToXContentObject, org.opensearch.core.common.io.stream.Writeable

Connector defines how to connect to a remote service.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
Connector	cloneConnector()
static Connector	createConnector(org.opensearch.core.xcontent.XContentBuilder builder, String connectorProtocol)
static Connector	createConnector(org.opensearch.core.xcontent.XContentParser parser)
<T> T	createPredictPayload(Map<String,String> parameters)
void	decrypt(Function<String,String> function)
void	encrypt(Function<String,String> function)
Optional<ConnectorAction>	findPredictAction()
static Connector	fromStream(org.opensearch.core.common.io.stream.StreamInput in)
AccessMode	getAccess()
List<ConnectorAction>	getActions()
List<String>	getBackendRoles()
ConnectorClientConfig	getConnectorClientConfig()
Map<String,String>	getDecryptedHeaders()
String	getName()
org.opensearch.commons.authuser.User	getOwner()
Map<String,String>	getParameters()
String	getPredictEndpoint(Map<String,String> parameters)
String	getPredictHttpMethod()
String	getProtocol()
<T> void	parseResponse(T orElse, List<ModelTensor> modelTensors, boolean b)
void	removeCredential()
void	setAccess(AccessMode access)
void	setBackendRoles(List<String> backendRoles)
void	setOwner(org.opensearch.commons.authuser.User user)
void	update(MLCreateConnectorInput updateContent, Function<String,String> function)
default void	validateConnectorURL(List<String> urlRegexes)
default void	validatePayload(String payload)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from interface org.opensearch.core.xcontent.ToXContent

toXContent

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Method Details

getName

String getName()

getProtocol

String getProtocol()

getOwner

org.opensearch.commons.authuser.User getOwner()

setOwner

void setOwner(org.opensearch.commons.authuser.User user)

getAccess

AccessMode getAccess()

setAccess

void setAccess(AccessMode access)

getBackendRoles

List<String> getBackendRoles()

setBackendRoles

void setBackendRoles(List<String> backendRoles)

getParameters

Map<String,String> getParameters()

getActions

List<ConnectorAction> getActions()

getConnectorClientConfig

ConnectorClientConfig getConnectorClientConfig()

getPredictEndpoint

String getPredictEndpoint(Map<String,String> parameters)

getPredictHttpMethod

String getPredictHttpMethod()

createPredictPayload

<T> T createPredictPayload(Map<String,String> parameters)

decrypt

void decrypt(Function<String,String> function)

encrypt

void encrypt(Function<String,String> function)

cloneConnector

Connector cloneConnector()

findPredictAction

Optional<ConnectorAction> findPredictAction()

removeCredential

void removeCredential()

writeTo

void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
      throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

update

void update(MLCreateConnectorInput updateContent,
 Function<String,String> function)

parseResponse

<T> void parseResponse(T orElse,
 List<ModelTensor> modelTensors,
 boolean b)
                throws IOException

Throws:

IOException

validatePayload

default void validatePayload(String payload)

fromStream

static Connector fromStream(org.opensearch.core.common.io.stream.StreamInput in)
                     throws IOException

Throws:

IOException

createConnector

static Connector createConnector(org.opensearch.core.xcontent.XContentBuilder builder,
 String connectorProtocol)
                          throws IOException

Throws:

IOException

createConnector

static Connector createConnector(org.opensearch.core.xcontent.XContentParser parser)
                          throws IOException

Throws:

IOException

validateConnectorURL

default void validateConnectorURL(List<String> urlRegexes)

getDecryptedHeaders

Map<String,String> getDecryptedHeaders()