Package org.opensearch.ml.common.connector

Class HttpConnector

java.lang.Object

org.opensearch.ml.common.connector.AbstractConnector

org.opensearch.ml.common.connector.HttpConnector

All Implemented Interfaces:

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

Direct Known Subclasses:

AwsConnector

public class HttpConnector
extends AbstractConnector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpConnector.HttpConnectorBuilder

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
static final String	CREDENTIAL_FIELD
static final String	PARAMETERS_FIELD
static final String	REGION_FIELD
static final String	RESPONSE_FILTER_FIELD
static final String	SERVICE_NAME_FIELD

Fields inherited from class org.opensearch.ml.common.connector.AbstractConnector

access, ACCESS_FIELD, ACCESS_KEY_FIELD, actions, ACTIONS_FIELD, BACKEND_ROLES_FIELD, backendRoles, CLIENT_CONFIG_FIELD, connectorClientConfig, CREATED_TIME_FIELD, createdTime, credential, decryptedCredential, decryptedHeaders, description, DESCRIPTION_FIELD, LAST_UPDATED_TIME_FIELD, lastUpdateTime, name, NAME_FIELD, owner, OWNER_FIELD, parameters, protocol, PROTOCOL_FIELD, SECRET_KEY_FIELD, SESSION_TOKEN_FIELD, version, VERSION_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
HttpConnector()
HttpConnector(String name, String description, String version, String protocol, Map<String,String> parameters, Map<String,String> credential, List<ConnectorAction> actions, List<String> backendRoles, AccessMode accessMode, org.opensearch.commons.authuser.User owner, ConnectorClientConfig connectorClientConfig)
HttpConnector(String protocol, org.opensearch.core.common.io.stream.StreamInput input)
HttpConnector(String protocol, org.opensearch.core.xcontent.XContentParser parser)
HttpConnector(org.opensearch.core.common.io.stream.StreamInput input)

Method Summary

Modifier and Type	Method	Description
static HttpConnector.HttpConnectorBuilder	builder()
protected boolean	canEqual(Object other)
Connector	cloneConnector()
<T> T	createPredictPayload(Map<String,String> parameters)
void	decrypt(Function<String,String> function)
void	encrypt(Function<String,String> function)
boolean	equals(Object o)
protected String	fillNullParameters(Map<String,String> parameters, String payload)
String	getPredictHttpMethod()
int	hashCode()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	update(MLCreateConnectorInput updateContent, Function<String,String> function)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.ml.common.connector.AbstractConnector

createPredictDecryptedHeaders, findPredictAction, getAccess, getActions, getBackendRoles, getConnectorClientConfig, getCreatedTime, getCredential, getDecryptedCredential, getDecryptedHeaders, getDescription, getLastUpdateTime, getName, getOwner, getParameters, getPredictEndpoint, getProtocol, getVersion, parseResponse, removeCredential, setAccess, setBackendRoles, setConnectorClientConfig, setDecryptedCredential, setOwner

Methods inherited from class java.lang.Object

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

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

validateConnectorURL, validatePayload

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

isFragment

Field Details

CREDENTIAL_FIELD

public static final String CREDENTIAL_FIELD

See Also:

• Constant Field Values

RESPONSE_FILTER_FIELD

public static final String RESPONSE_FILTER_FIELD

See Also:

• Constant Field Values

PARAMETERS_FIELD

public static final String PARAMETERS_FIELD

See Also:

• Constant Field Values

SERVICE_NAME_FIELD

public static final String SERVICE_NAME_FIELD

See Also:

• Constant Field Values

REGION_FIELD

public static final String REGION_FIELD

See Also:

• Constant Field Values

Constructor Details

HttpConnector

public HttpConnector(String name,
 String description,
 String version,
 String protocol,
 Map<String,String> parameters,
 Map<String,String> credential,
 List<ConnectorAction> actions,
 List<String> backendRoles,
 AccessMode accessMode,
 org.opensearch.commons.authuser.User owner,
 ConnectorClientConfig connectorClientConfig)

HttpConnector

public HttpConnector(String protocol,
 org.opensearch.core.xcontent.XContentParser parser)
              throws IOException

Throws:

IOException

HttpConnector

public HttpConnector(String protocol,
 org.opensearch.core.common.io.stream.StreamInput input)
              throws IOException

Throws:

IOException

HttpConnector

public HttpConnector(org.opensearch.core.common.io.stream.StreamInput input)
              throws IOException

Throws:

IOException

HttpConnector

public HttpConnector()

Method Details

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Throws:

IOException

writeTo

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

Throws:

IOException

update

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

createPredictPayload

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

fillNullParameters

protected String fillNullParameters(Map<String,String> parameters,
 String payload)

decrypt

public void decrypt(Function<String,String> function)

cloneConnector

public Connector cloneConnector()

encrypt

public void encrypt(Function<String,String> function)

getPredictHttpMethod

public String getPredictHttpMethod()

builder

public static HttpConnector.HttpConnectorBuilder builder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object