Package org.opensearch.ml.common.transport.connector

Class MLCreateConnectorInput

java.lang.Object

org.opensearch.ml.common.transport.connector.MLCreateConnectorInput

All Implemented Interfaces:

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

public class MLCreateConnectorInput
extends Object
implements org.opensearch.core.xcontent.ToXContentObject, org.opensearch.core.common.io.stream.Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MLCreateConnectorInput.MLCreateConnectorInputBuilder

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	ACCESS_MODE_FIELD
static final String	ADD_ALL_BACKEND_ROLES_FIELD
static final String	BACKEND_ROLES_FIELD
static final String	CONNECTOR_ACTIONS_FIELD
static final String	CONNECTOR_CREDENTIAL_FIELD
static final String	CONNECTOR_DESCRIPTION_FIELD
static final String	CONNECTOR_NAME_FIELD
static final String	CONNECTOR_PARAMETERS_FIELD
static final String	CONNECTOR_PROTOCOL_FIELD
static final String	CONNECTOR_VERSION_FIELD
static final String	DRY_RUN_CONNECTOR_NAME
static final String	DRY_RUN_FIELD
static final String	OWNER_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLCreateConnectorInput(String name, String description, String version, String protocol, Map<String,String> parameters, Map<String,String> credential, List<ConnectorAction> actions, List<String> backendRoles, Boolean addAllBackendRoles, AccessMode access, boolean dryRun, boolean updateConnector, ConnectorClientConfig connectorClientConfig)
MLCreateConnectorInput(org.opensearch.core.common.io.stream.StreamInput input)

Method Summary

Modifier and Type	Method	Description
static MLCreateConnectorInput.MLCreateConnectorInputBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
AccessMode	getAccess()
List<ConnectorAction>	getActions()
Boolean	getAddAllBackendRoles()
List<String>	getBackendRoles()
ConnectorClientConfig	getConnectorClientConfig()
Map<String,String>	getCredential()
String	getDescription()
String	getName()
Map<String,String>	getParameters()
String	getProtocol()
String	getVersion()
int	hashCode()
boolean	isDryRun()
boolean	isUpdateConnector()
static MLCreateConnectorInput	parse(org.opensearch.core.xcontent.XContentParser parser)
static MLCreateConnectorInput	parse(org.opensearch.core.xcontent.XContentParser parser, boolean updateConnector)
void	setAccess(AccessMode access)
void	setActions(List<ConnectorAction> actions)
void	setAddAllBackendRoles(Boolean addAllBackendRoles)
void	setBackendRoles(List<String> backendRoles)
void	setConnectorClientConfig(ConnectorClientConfig connectorClientConfig)
void	setCredential(Map<String,String> credential)
void	setDescription(String description)
void	setDryRun(boolean dryRun)
void	setName(String name)
void	setParameters(Map<String,String> parameters)
void	setProtocol(String protocol)
void	setUpdateConnector(boolean updateConnector)
void	setVersion(String version)
MLCreateConnectorInput.MLCreateConnectorInputBuilder	toBuilder()
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput output)

Methods inherited from class java.lang.Object

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

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

isFragment

Field Details

CONNECTOR_NAME_FIELD

public static final String CONNECTOR_NAME_FIELD

See Also:

• Constant Field Values

CONNECTOR_DESCRIPTION_FIELD

public static final String CONNECTOR_DESCRIPTION_FIELD

See Also:

• Constant Field Values

CONNECTOR_VERSION_FIELD

public static final String CONNECTOR_VERSION_FIELD

See Also:

• Constant Field Values

CONNECTOR_PROTOCOL_FIELD

public static final String CONNECTOR_PROTOCOL_FIELD

See Also:

• Constant Field Values

CONNECTOR_PARAMETERS_FIELD

public static final String CONNECTOR_PARAMETERS_FIELD

See Also:

• Constant Field Values

CONNECTOR_CREDENTIAL_FIELD

public static final String CONNECTOR_CREDENTIAL_FIELD

See Also:

• Constant Field Values

CONNECTOR_ACTIONS_FIELD

public static final String CONNECTOR_ACTIONS_FIELD

See Also:

• Constant Field Values

BACKEND_ROLES_FIELD

public static final String BACKEND_ROLES_FIELD

See Also:

• Constant Field Values

ADD_ALL_BACKEND_ROLES_FIELD

public static final String ADD_ALL_BACKEND_ROLES_FIELD

See Also:

• Constant Field Values

OWNER_FIELD

public static final String OWNER_FIELD

See Also:

• Constant Field Values

ACCESS_MODE_FIELD

public static final String ACCESS_MODE_FIELD

See Also:

• Constant Field Values

DRY_RUN_FIELD

public static final String DRY_RUN_FIELD

See Also:

• Constant Field Values

DRY_RUN_CONNECTOR_NAME

public static final String DRY_RUN_CONNECTOR_NAME

See Also:

• Constant Field Values

Constructor Details

MLCreateConnectorInput

public MLCreateConnectorInput(String name,
 String description,
 String version,
 String protocol,
 Map<String,String> parameters,
 Map<String,String> credential,
 List<ConnectorAction> actions,
 List<String> backendRoles,
 Boolean addAllBackendRoles,
 AccessMode access,
 boolean dryRun,
 boolean updateConnector,
 ConnectorClientConfig connectorClientConfig)

MLCreateConnectorInput

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

Throws:

IOException

Method Details

parse

public static MLCreateConnectorInput parse(org.opensearch.core.xcontent.XContentParser parser)
                                    throws IOException

Throws:

IOException

parse

public static MLCreateConnectorInput parse(org.opensearch.core.xcontent.XContentParser parser,
 boolean updateConnector)
                                    throws IOException

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

writeTo

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

Specified by:

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

Throws:

IOException

builder

public static MLCreateConnectorInput.MLCreateConnectorInputBuilder builder()

toBuilder

public MLCreateConnectorInput.MLCreateConnectorInputBuilder toBuilder()

getName

public String getName()

getDescription

public String getDescription()

getVersion

public String getVersion()

getProtocol

public String getProtocol()

getParameters

public Map<String,String> getParameters()

getCredential

public Map<String,String> getCredential()

getActions

public List<ConnectorAction> getActions()

getBackendRoles

public List<String> getBackendRoles()

getAddAllBackendRoles

public Boolean getAddAllBackendRoles()

getAccess

public AccessMode getAccess()

isDryRun

public boolean isDryRun()

isUpdateConnector

public boolean isUpdateConnector()

getConnectorClientConfig

public ConnectorClientConfig getConnectorClientConfig()

setName

public void setName(String name)

setDescription

public void setDescription(String description)

setVersion

public void setVersion(String version)

setProtocol

public void setProtocol(String protocol)

setParameters

public void setParameters(Map<String,String> parameters)

setCredential

public void setCredential(Map<String,String> credential)

setActions

public void setActions(List<ConnectorAction> actions)

setBackendRoles

public void setBackendRoles(List<String> backendRoles)

setAddAllBackendRoles

public void setAddAllBackendRoles(Boolean addAllBackendRoles)

setAccess

public void setAccess(AccessMode access)

setDryRun

public void setDryRun(boolean dryRun)

setUpdateConnector

public void setUpdateConnector(boolean updateConnector)

setConnectorClientConfig

public void setConnectorClientConfig(ConnectorClientConfig connectorClientConfig)

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

toString

public String toString()

Overrides:

toString in class Object