Package org.opensearch.ml.common.transport.register

Class MLRegisterModelInput

java.lang.Object

org.opensearch.ml.common.transport.register.MLRegisterModelInput

All Implemented Interfaces:

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

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

ML input data: algirithm name, parameters and input data set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MLRegisterModelInput.MLRegisterModelInputBuilder

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_FIELD
static final String	CONNECTOR_ID_FIELD
static final String	DEPLOY_MODEL_FIELD
static final String	DEPLOY_SETTING_FIELD
static final String	DESCRIPTION_FIELD
static final String	DOES_VERSION_CREATE_MODEL_GROUP
static final String	FUNCTION_NAME_FIELD
static final String	GUARDRAILS_FIELD
static final String	IS_ENABLED_FIELD
static final org.opensearch.Version	MINIMAL_SUPPORTED_VERSION_FOR_AGENT_FRAMEWORK
static final org.opensearch.Version	MINIMAL_SUPPORTED_VERSION_FOR_DOES_VERSION_CREATE_MODEL_GROUP
static final org.opensearch.Version	MINIMAL_SUPPORTED_VERSION_FOR_GUARDRAILS_AND_AUTO_DEPLOY
static final String	MODEL_CONFIG_FIELD
static final String	MODEL_CONTENT_HASH_VALUE_FIELD
static final String	MODEL_FORMAT_FIELD
static final String	MODEL_GROUP_ID_FIELD
static final String	MODEL_NODE_IDS_FIELD
static final String	NAME_FIELD
static final String	RATE_LIMITER_FIELD
static final String	URL_FIELD
static final String	VERSION_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLRegisterModelInput(org.opensearch.core.common.io.stream.StreamInput in)
MLRegisterModelInput(FunctionName functionName, String modelName, String modelGroupId, String version, String description, Boolean isEnabled, MLRateLimiter rateLimiter, String url, String hashValue, MLModelFormat modelFormat, MLModelConfig modelConfig, MLDeploySetting deploySetting, boolean deployModel, String[] modelNodeIds, Connector connector, String connectorId, List<String> backendRoles, Boolean addAllBackendRoles, AccessMode accessMode, Boolean doesVersionCreateModelGroup, Boolean isHidden, Guardrails guardrails)

Method Summary

Modifier and Type	Method	Description
static MLRegisterModelInput.MLRegisterModelInputBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
AccessMode	getAccessMode()
Boolean	getAddAllBackendRoles()
List<String>	getBackendRoles()
Connector	getConnector()
String	getConnectorId()
MLDeploySetting	getDeploySetting()
String	getDescription()
Boolean	getDoesVersionCreateModelGroup()
FunctionName	getFunctionName()
Guardrails	getGuardrails()
String	getHashValue()
Boolean	getIsEnabled()
Boolean	getIsHidden()
MLModelConfig	getModelConfig()
MLModelFormat	getModelFormat()
String	getModelGroupId()
String	getModelName()
String[]	getModelNodeIds()
MLRateLimiter	getRateLimiter()
String	getUrl()
String	getVersion()
int	hashCode()
boolean	isDeployModel()
static MLRegisterModelInput	parse(org.opensearch.core.xcontent.XContentParser parser, boolean deployModel)
static MLRegisterModelInput	parse(org.opensearch.core.xcontent.XContentParser parser, String modelName, String version, boolean deployModel)
void	setAccessMode(AccessMode accessMode)
void	setAddAllBackendRoles(Boolean addAllBackendRoles)
void	setBackendRoles(List<String> backendRoles)
void	setConnector(Connector connector)
void	setConnectorId(String connectorId)
void	setDeployModel(boolean deployModel)
void	setDeploySetting(MLDeploySetting deploySetting)
void	setDescription(String description)
void	setDoesVersionCreateModelGroup(Boolean doesVersionCreateModelGroup)
void	setFunctionName(FunctionName functionName)
void	setGuardrails(Guardrails guardrails)
void	setHashValue(String hashValue)
void	setIsEnabled(Boolean isEnabled)
void	setIsHidden(Boolean isHidden)
void	setModelConfig(MLModelConfig modelConfig)
void	setModelFormat(MLModelFormat modelFormat)
void	setModelGroupId(String modelGroupId)
void	setModelName(String modelName)
void	setModelNodeIds(String[] modelNodeIds)
void	setRateLimiter(MLRateLimiter rateLimiter)
void	setUrl(String url)
void	setVersion(String version)
MLRegisterModelInput.MLRegisterModelInputBuilder	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 out)

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

FUNCTION_NAME_FIELD

public static final String FUNCTION_NAME_FIELD

See Also:

• Constant Field Values

NAME_FIELD

public static final String NAME_FIELD

See Also:

• Constant Field Values

MODEL_GROUP_ID_FIELD

public static final String MODEL_GROUP_ID_FIELD

See Also:

• Constant Field Values

DESCRIPTION_FIELD

public static final String DESCRIPTION_FIELD

See Also:

• Constant Field Values

VERSION_FIELD

public static final String VERSION_FIELD

See Also:

• Constant Field Values

IS_ENABLED_FIELD

public static final String IS_ENABLED_FIELD

See Also:

• Constant Field Values

RATE_LIMITER_FIELD

public static final String RATE_LIMITER_FIELD

See Also:

• Constant Field Values

URL_FIELD

public static final String URL_FIELD

See Also:

• Constant Field Values

MODEL_FORMAT_FIELD

public static final String MODEL_FORMAT_FIELD

See Also:

• Constant Field Values

MODEL_CONFIG_FIELD

public static final String MODEL_CONFIG_FIELD

See Also:

• Constant Field Values

DEPLOY_SETTING_FIELD

public static final String DEPLOY_SETTING_FIELD

See Also:

• Constant Field Values

DEPLOY_MODEL_FIELD

public static final String DEPLOY_MODEL_FIELD

See Also:

• Constant Field Values

MODEL_NODE_IDS_FIELD

public static final String MODEL_NODE_IDS_FIELD

See Also:

• Constant Field Values

CONNECTOR_FIELD

public static final String CONNECTOR_FIELD

See Also:

• Constant Field Values

CONNECTOR_ID_FIELD

public static final String CONNECTOR_ID_FIELD

See Also:

• Constant Field Values

MODEL_CONTENT_HASH_VALUE_FIELD

public static final String MODEL_CONTENT_HASH_VALUE_FIELD

See Also:

• Constant Field Values

ACCESS_MODE_FIELD

public static final String ACCESS_MODE_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

DOES_VERSION_CREATE_MODEL_GROUP

public static final String DOES_VERSION_CREATE_MODEL_GROUP

See Also:

• Constant Field Values

GUARDRAILS_FIELD

public static final String GUARDRAILS_FIELD

See Also:

• Constant Field Values

MINIMAL_SUPPORTED_VERSION_FOR_DOES_VERSION_CREATE_MODEL_GROUP

public static final org.opensearch.Version MINIMAL_SUPPORTED_VERSION_FOR_DOES_VERSION_CREATE_MODEL_GROUP

MINIMAL_SUPPORTED_VERSION_FOR_AGENT_FRAMEWORK

public static final org.opensearch.Version MINIMAL_SUPPORTED_VERSION_FOR_AGENT_FRAMEWORK

MINIMAL_SUPPORTED_VERSION_FOR_GUARDRAILS_AND_AUTO_DEPLOY

public static final org.opensearch.Version MINIMAL_SUPPORTED_VERSION_FOR_GUARDRAILS_AND_AUTO_DEPLOY

Constructor Details

MLRegisterModelInput

public MLRegisterModelInput(FunctionName functionName,
 String modelName,
 String modelGroupId,
 String version,
 String description,
 Boolean isEnabled,
 MLRateLimiter rateLimiter,
 String url,
 String hashValue,
 MLModelFormat modelFormat,
 MLModelConfig modelConfig,
 MLDeploySetting deploySetting,
 boolean deployModel,
 String[] modelNodeIds,
 Connector connector,
 String connectorId,
 List<String> backendRoles,
 Boolean addAllBackendRoles,
 AccessMode accessMode,
 Boolean doesVersionCreateModelGroup,
 Boolean isHidden,
 Guardrails guardrails)

MLRegisterModelInput

public MLRegisterModelInput(org.opensearch.core.common.io.stream.StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

writeTo

public 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

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

parse

public static MLRegisterModelInput parse(org.opensearch.core.xcontent.XContentParser parser,
 String modelName,
 String version,
 boolean deployModel)
                                  throws IOException

Throws:

IOException

parse

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

Throws:

IOException

builder

public static MLRegisterModelInput.MLRegisterModelInputBuilder builder()

toBuilder

public MLRegisterModelInput.MLRegisterModelInputBuilder toBuilder()

getFunctionName

public FunctionName getFunctionName()

getModelName

public String getModelName()

getModelGroupId

public String getModelGroupId()

getVersion

public String getVersion()

getDescription

public String getDescription()

getIsEnabled

public Boolean getIsEnabled()

getRateLimiter

public MLRateLimiter getRateLimiter()

getUrl

public String getUrl()

getHashValue

public String getHashValue()

getModelFormat

public MLModelFormat getModelFormat()

getModelConfig

public MLModelConfig getModelConfig()

getDeploySetting

public MLDeploySetting getDeploySetting()

isDeployModel

public boolean isDeployModel()

getModelNodeIds

public String[] getModelNodeIds()

getConnector

public Connector getConnector()

getConnectorId

public String getConnectorId()

getBackendRoles

public List<String> getBackendRoles()

getAddAllBackendRoles

public Boolean getAddAllBackendRoles()

getAccessMode

public AccessMode getAccessMode()

getDoesVersionCreateModelGroup

public Boolean getDoesVersionCreateModelGroup()

getIsHidden

public Boolean getIsHidden()

getGuardrails

public Guardrails getGuardrails()

setFunctionName

public void setFunctionName(FunctionName functionName)

setModelName

public void setModelName(String modelName)

setModelGroupId

public void setModelGroupId(String modelGroupId)

setVersion

public void setVersion(String version)

setDescription

public void setDescription(String description)

setIsEnabled

public void setIsEnabled(Boolean isEnabled)

setRateLimiter

public void setRateLimiter(MLRateLimiter rateLimiter)

setUrl

public void setUrl(String url)

setHashValue

public void setHashValue(String hashValue)

setModelFormat

public void setModelFormat(MLModelFormat modelFormat)

setModelConfig

public void setModelConfig(MLModelConfig modelConfig)

setDeploySetting

public void setDeploySetting(MLDeploySetting deploySetting)

setDeployModel

public void setDeployModel(boolean deployModel)

setModelNodeIds

public void setModelNodeIds(String[] modelNodeIds)

setConnector

public void setConnector(Connector connector)

setConnectorId

public void setConnectorId(String connectorId)

setBackendRoles

public void setBackendRoles(List<String> backendRoles)

setAddAllBackendRoles

public void setAddAllBackendRoles(Boolean addAllBackendRoles)

setAccessMode

public void setAccessMode(AccessMode accessMode)

setDoesVersionCreateModelGroup

public void setDoesVersionCreateModelGroup(Boolean doesVersionCreateModelGroup)

setIsHidden

public void setIsHidden(Boolean isHidden)

setGuardrails

public void setGuardrails(Guardrails guardrails)

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