Package org.opensearch.ml.common.connector

Class AbstractConnector

java.lang.Object

org.opensearch.ml.common.connector.AbstractConnector

All Implemented Interfaces:

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

Direct Known Subclasses:

HttpConnector

public abstract class AbstractConnector
extends Object
implements Connector

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

Modifier and Type	Field	Description
protected AccessMode	access
static final String	ACCESS_FIELD
static final String	ACCESS_KEY_FIELD
protected List<ConnectorAction>	actions
static final String	ACTIONS_FIELD
static final String	BACKEND_ROLES_FIELD
protected List<String>	backendRoles
static final String	CLIENT_CONFIG_FIELD
protected ConnectorClientConfig	connectorClientConfig
static final String	CREATED_TIME_FIELD
protected Instant	createdTime
protected Map<String,String>	credential
static final String	CREDENTIAL_FIELD
protected Map<String,String>	decryptedCredential
protected Map<String,String>	decryptedHeaders
protected String	description
static final String	DESCRIPTION_FIELD
static final String	LAST_UPDATED_TIME_FIELD
protected Instant	lastUpdateTime
protected String	name
static final String	NAME_FIELD
protected org.opensearch.commons.authuser.User	owner
static final String	OWNER_FIELD
protected Map<String,String>	parameters
static final String	PARAMETERS_FIELD
protected String	protocol
static final String	PROTOCOL_FIELD
static final String	SECRET_KEY_FIELD
static final String	SESSION_TOKEN_FIELD
protected String	version
static final String	VERSION_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AbstractConnector()

Method Summary

Modifier and Type	Method	Description
protected Map<String,String>	createPredictDecryptedHeaders(Map<String,String> headers)
Optional<ConnectorAction>	findPredictAction()
AccessMode	getAccess()
List<ConnectorAction>	getActions()
List<String>	getBackendRoles()
ConnectorClientConfig	getConnectorClientConfig()
Instant	getCreatedTime()
Map<String,String>	getCredential()
Map<String,String>	getDecryptedCredential()
Map<String,String>	getDecryptedHeaders()
String	getDescription()
Instant	getLastUpdateTime()
String	getName()
org.opensearch.commons.authuser.User	getOwner()
Map<String,String>	getParameters()
String	getPredictEndpoint(Map<String,String> parameters)
String	getProtocol()
String	getVersion()
<T> void	parseResponse(T response, List<ModelTensor> modelTensors, boolean modelTensorJson)
void	removeCredential()
void	setAccess(AccessMode access)
void	setBackendRoles(List<String> backendRoles)
void	setConnectorClientConfig(ConnectorClientConfig connectorClientConfig)
void	setDecryptedCredential(Map<String,String> decryptedCredential)
void	setOwner(org.opensearch.commons.authuser.User owner)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.ml.common.connector.Connector

cloneConnector, createPredictPayload, decrypt, encrypt, getPredictHttpMethod, update, validateConnectorURL, validatePayload, writeTo

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

toXContent

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

isFragment

Field Details

ACCESS_KEY_FIELD

public static final String ACCESS_KEY_FIELD

See Also:

• Constant Field Values

SECRET_KEY_FIELD

public static final String SECRET_KEY_FIELD

See Also:

• Constant Field Values

SESSION_TOKEN_FIELD

public static final String SESSION_TOKEN_FIELD

See Also:

• Constant Field Values

NAME_FIELD

public static final String NAME_FIELD

See Also:

• Constant Field Values

VERSION_FIELD

public static final String VERSION_FIELD

See Also:

• Constant Field Values

DESCRIPTION_FIELD

public static final String DESCRIPTION_FIELD

See Also:

• Constant Field Values

PROTOCOL_FIELD

public static final String PROTOCOL_FIELD

See Also:

• Constant Field Values

ACTIONS_FIELD

public static final String ACTIONS_FIELD

See Also:

• Constant Field Values

CREDENTIAL_FIELD

public static final String CREDENTIAL_FIELD

See Also:

• Constant Field Values

PARAMETERS_FIELD

public static final String PARAMETERS_FIELD

See Also:

• Constant Field Values

CREATED_TIME_FIELD

public static final String CREATED_TIME_FIELD

See Also:

• Constant Field Values

LAST_UPDATED_TIME_FIELD

public static final String LAST_UPDATED_TIME_FIELD

See Also:

• Constant Field Values

BACKEND_ROLES_FIELD

public static final String BACKEND_ROLES_FIELD

See Also:

• Constant Field Values

OWNER_FIELD

public static final String OWNER_FIELD

See Also:

• Constant Field Values

ACCESS_FIELD

public static final String ACCESS_FIELD

See Also:

• Constant Field Values

CLIENT_CONFIG_FIELD

public static final String CLIENT_CONFIG_FIELD

See Also:

• Constant Field Values

name

protected String name

description

protected String description

version

protected String version

protocol

protected String protocol

parameters

protected Map<String,String> parameters

credential

protected Map<String,String> credential

decryptedHeaders

protected Map<String,String> decryptedHeaders

decryptedCredential

protected Map<String,String> decryptedCredential

actions

protected List<ConnectorAction> actions

backendRoles

protected List<String> backendRoles

owner

protected org.opensearch.commons.authuser.User owner

access

protected AccessMode access

createdTime

protected Instant createdTime

lastUpdateTime

protected Instant lastUpdateTime

connectorClientConfig

protected ConnectorClientConfig connectorClientConfig

Constructor Details

AbstractConnector

public AbstractConnector()

Method Details

createPredictDecryptedHeaders

protected Map<String,String> createPredictDecryptedHeaders(Map<String,String> headers)

parseResponse

public <T> void parseResponse(T response,
 List<ModelTensor> modelTensors,
 boolean modelTensorJson)
                       throws IOException

Specified by:

parseResponse in interface Connector

Throws:

IOException

findPredictAction

public Optional<ConnectorAction> findPredictAction()

Specified by:

findPredictAction in interface Connector

removeCredential

public void removeCredential()

Specified by:

removeCredential in interface Connector

getPredictEndpoint

public String getPredictEndpoint(Map<String,String> parameters)

Specified by:

getPredictEndpoint in interface Connector

getName

public String getName()

Specified by:

getName in interface Connector

getDescription

public String getDescription()

getVersion

public String getVersion()

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface Connector

getParameters

public Map<String,String> getParameters()

Specified by:

getParameters in interface Connector

getCredential

public Map<String,String> getCredential()

getDecryptedHeaders

public Map<String,String> getDecryptedHeaders()

Specified by:

getDecryptedHeaders in interface Connector

getDecryptedCredential

public Map<String,String> getDecryptedCredential()

getActions

public List<ConnectorAction> getActions()

Specified by:

getActions in interface Connector

getBackendRoles

public List<String> getBackendRoles()

Specified by:

getBackendRoles in interface Connector

getOwner

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

Specified by:

getOwner in interface Connector

getAccess

public AccessMode getAccess()

Specified by:

getAccess in interface Connector

getCreatedTime

public Instant getCreatedTime()

getLastUpdateTime

public Instant getLastUpdateTime()

getConnectorClientConfig

public ConnectorClientConfig getConnectorClientConfig()

Specified by:

getConnectorClientConfig in interface Connector

setDecryptedCredential

public void setDecryptedCredential(Map<String,String> decryptedCredential)

setBackendRoles

public void setBackendRoles(List<String> backendRoles)

Specified by:

setBackendRoles in interface Connector

setOwner

public void setOwner(org.opensearch.commons.authuser.User owner)

Specified by:

setOwner in interface Connector

setAccess

public void setAccess(AccessMode access)

Specified by:

setAccess in interface Connector

setConnectorClientConfig

public void setConnectorClientConfig(ConnectorClientConfig connectorClientConfig)