Package org.opensearch.ml.common

Class MLModel

java.lang.Object

org.opensearch.ml.common.MLModel

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class MLModel
extends Object
implements org.opensearch.core.xcontent.ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MLModel.MLModelBuilder

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALGORITHM_FIELD	Deprecated.
static final String	AUTO_REDEPLOY_RETRY_TIMES_FIELD
static final String	CHUNK_NUMBER_FIELD
static final String	CONNECTOR_FIELD
static final String	CONNECTOR_ID_FIELD
static final String	CREATED_TIME_FIELD
static final String	CURRENT_WORKER_NODE_COUNT_FIELD
static final String	DEPLOY_SETTING_FIELD
static final String	DEPLOY_TO_ALL_NODES_FIELD
static final String	DESCRIPTION_FIELD
static final String	FUNCTION_NAME_FIELD
static final String	GUARDRAILS_FIELD
static final String	IS_CONTROLLER_ENABLED_FIELD
static final String	IS_ENABLED_FIELD
static final String	IS_HIDDEN_FIELD
static final String	LAST_DEPLOYED_TIME_FIELD
static final String	LAST_LOADED_TIME_FIELD	Deprecated.
static final String	LAST_REGISTERED_TIME_FIELD
static final String	LAST_UNDEPLOYED_TIME_FIELD
static final String	LAST_UNLOADED_TIME_FIELD	Deprecated.
static final String	LAST_UPDATED_TIME_FIELD
static final String	LAST_UPLOADED_TIME_FIELD	Deprecated.
static final String	MODEL_CONFIG_FIELD
static final String	MODEL_CONTENT_FIELD
static final String	MODEL_CONTENT_HASH_VALUE_FIELD
static final String	MODEL_CONTENT_SIZE_IN_BYTES_FIELD
static final String	MODEL_FORMAT_FIELD
static final String	MODEL_GROUP_ID_FIELD
static final String	MODEL_ID_FIELD
static final String	MODEL_NAME_FIELD
static final String	MODEL_STATE_FIELD
static final String	MODEL_VERSION_FIELD
static final String	OLD_MODEL_CONTENT_FIELD
static final String	OLD_MODEL_VERSION_FIELD
static final String	PLANNING_WORKER_NODE_COUNT_FIELD
static final String	PLANNING_WORKER_NODES_FIELD
static final String	RATE_LIMITER_FIELD
static final String	TOTAL_CHUNKS_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLModel(String name, String modelGroupId, FunctionName algorithm, String version, String content, org.opensearch.commons.authuser.User user, String description, MLModelFormat modelFormat, MLModelState modelState, Long modelContentSizeInBytes, String modelContentHash, Boolean isEnabled, Boolean isControllerEnabled, MLRateLimiter rateLimiter, MLModelConfig modelConfig, MLDeploySetting deploySetting, Instant createdTime, Instant lastUpdateTime, Instant lastRegisteredTime, Instant lastDeployedTime, Instant lastUndeployedTime, Integer autoRedeployRetryTimes, String modelId, Integer chunkNumber, Integer totalChunks, Integer planningWorkerNodeCount, Integer currentWorkerNodeCount, String[] planningWorkerNodes, boolean deployToAllNodes, Boolean isHidden, Connector connector, String connectorId, Guardrails guardrails)
MLModel(org.opensearch.core.common.io.stream.StreamInput input)

Method Summary

Modifier and Type	Method	Description
static MLModel.MLModelBuilder	builder()
static MLModel	fromStream(org.opensearch.core.common.io.stream.StreamInput in)
FunctionName	getAlgorithm()
Integer	getAutoRedeployRetryTimes()
Integer	getChunkNumber()
Connector	getConnector()
String	getConnectorId()
String	getContent()
Instant	getCreatedTime()
Integer	getCurrentWorkerNodeCount()
MLDeploySetting	getDeploySetting()
String	getDescription()
Guardrails	getGuardrails()
Boolean	getIsControllerEnabled()
Boolean	getIsEnabled()
Boolean	getIsHidden()
Instant	getLastDeployedTime()
Instant	getLastRegisteredTime()
Instant	getLastUndeployedTime()
Instant	getLastUpdateTime()
MLModelConfig	getModelConfig()
String	getModelContentHash()
Long	getModelContentSizeInBytes()
MLModelFormat	getModelFormat()
String	getModelGroupId()
String	getModelId()
MLModelState	getModelState()
String	getName()
Integer	getPlanningWorkerNodeCount()
String[]	getPlanningWorkerNodes()
MLRateLimiter	getRateLimiter()
Integer	getTotalChunks()
org.opensearch.commons.authuser.User	getUser()
String	getVersion()
boolean	isDeployToAllNodes()
static MLModel	parse(org.opensearch.core.xcontent.XContentParser parser, String algorithmName)
void	setConnector(Connector connector)
void	setDescription(String description)
void	setModelId(String modelId)
MLModel.MLModelBuilder	toBuilder()
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

isFragment

Field Details

ALGORITHM_FIELD

@Deprecated
public static final String ALGORITHM_FIELD

Deprecated.

See Also:

• Constant Field Values

FUNCTION_NAME_FIELD

public static final String FUNCTION_NAME_FIELD

See Also:

• Constant Field Values

MODEL_NAME_FIELD

public static final String MODEL_NAME_FIELD

See Also:

• Constant Field Values

MODEL_GROUP_ID_FIELD

public static final String MODEL_GROUP_ID_FIELD

See Also:

• Constant Field Values

OLD_MODEL_VERSION_FIELD

public static final String OLD_MODEL_VERSION_FIELD

See Also:

• Constant Field Values

MODEL_VERSION_FIELD

public static final String MODEL_VERSION_FIELD

See Also:

• Constant Field Values

OLD_MODEL_CONTENT_FIELD

public static final String OLD_MODEL_CONTENT_FIELD

See Also:

• Constant Field Values

MODEL_CONTENT_FIELD

public static final String MODEL_CONTENT_FIELD

See Also:

• Constant Field Values

DESCRIPTION_FIELD

public static final String DESCRIPTION_FIELD

See Also:

• Constant Field Values

MODEL_FORMAT_FIELD

public static final String MODEL_FORMAT_FIELD

See Also:

• Constant Field Values

MODEL_STATE_FIELD

public static final String MODEL_STATE_FIELD

See Also:

• Constant Field Values

MODEL_CONTENT_SIZE_IN_BYTES_FIELD

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

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

IS_CONTROLLER_ENABLED_FIELD

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

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

LAST_UPLOADED_TIME_FIELD

@Deprecated
public static final String LAST_UPLOADED_TIME_FIELD

Deprecated.

See Also:

• Constant Field Values

LAST_LOADED_TIME_FIELD

@Deprecated
public static final String LAST_LOADED_TIME_FIELD

Deprecated.

See Also:

• Constant Field Values

LAST_UNLOADED_TIME_FIELD

@Deprecated
public static final String LAST_UNLOADED_TIME_FIELD

Deprecated.

See Also:

• Constant Field Values

LAST_REGISTERED_TIME_FIELD

public static final String LAST_REGISTERED_TIME_FIELD

See Also:

• Constant Field Values

LAST_DEPLOYED_TIME_FIELD

public static final String LAST_DEPLOYED_TIME_FIELD

See Also:

• Constant Field Values

LAST_UNDEPLOYED_TIME_FIELD

public static final String LAST_UNDEPLOYED_TIME_FIELD

See Also:

• Constant Field Values

MODEL_ID_FIELD

public static final String MODEL_ID_FIELD

See Also:

• Constant Field Values

AUTO_REDEPLOY_RETRY_TIMES_FIELD

public static final String AUTO_REDEPLOY_RETRY_TIMES_FIELD

See Also:

• Constant Field Values

CHUNK_NUMBER_FIELD

public static final String CHUNK_NUMBER_FIELD

See Also:

• Constant Field Values

TOTAL_CHUNKS_FIELD

public static final String TOTAL_CHUNKS_FIELD

See Also:

• Constant Field Values

PLANNING_WORKER_NODE_COUNT_FIELD

public static final String PLANNING_WORKER_NODE_COUNT_FIELD

See Also:

• Constant Field Values

CURRENT_WORKER_NODE_COUNT_FIELD

public static final String CURRENT_WORKER_NODE_COUNT_FIELD

See Also:

• Constant Field Values

PLANNING_WORKER_NODES_FIELD

public static final String PLANNING_WORKER_NODES_FIELD

See Also:

• Constant Field Values

DEPLOY_TO_ALL_NODES_FIELD

public static final String DEPLOY_TO_ALL_NODES_FIELD

See Also:

• Constant Field Values

IS_HIDDEN_FIELD

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

GUARDRAILS_FIELD

public static final String GUARDRAILS_FIELD

See Also:

• Constant Field Values

Constructor Details

MLModel

public MLModel(String name,
 String modelGroupId,
 FunctionName algorithm,
 String version,
 String content,
 org.opensearch.commons.authuser.User user,
 String description,
 MLModelFormat modelFormat,
 MLModelState modelState,
 Long modelContentSizeInBytes,
 String modelContentHash,
 Boolean isEnabled,
 Boolean isControllerEnabled,
 MLRateLimiter rateLimiter,
 MLModelConfig modelConfig,
 MLDeploySetting deploySetting,
 Instant createdTime,
 Instant lastUpdateTime,
 Instant lastRegisteredTime,
 Instant lastDeployedTime,
 Instant lastUndeployedTime,
 Integer autoRedeployRetryTimes,
 String modelId,
 Integer chunkNumber,
 Integer totalChunks,
 Integer planningWorkerNodeCount,
 Integer currentWorkerNodeCount,
 String[] planningWorkerNodes,
 boolean deployToAllNodes,
 Boolean isHidden,
 Connector connector,
 String connectorId,
 Guardrails guardrails)

MLModel

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

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             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

parse

public static MLModel parse(org.opensearch.core.xcontent.XContentParser parser,
 String algorithmName)
                     throws IOException

Throws:

IOException

fromStream

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

Throws:

IOException

builder

public static MLModel.MLModelBuilder builder()

toBuilder

public MLModel.MLModelBuilder toBuilder()

getName

public String getName()

getModelGroupId

public String getModelGroupId()

getAlgorithm

public FunctionName getAlgorithm()

getVersion

public String getVersion()

getContent

public String getContent()

getUser

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

getDescription

public String getDescription()

getModelFormat

public MLModelFormat getModelFormat()

getModelState

public MLModelState getModelState()

getModelContentSizeInBytes

public Long getModelContentSizeInBytes()

getModelContentHash

public String getModelContentHash()

getModelConfig

public MLModelConfig getModelConfig()

getDeploySetting

public MLDeploySetting getDeploySetting()

getIsEnabled

public Boolean getIsEnabled()

getIsControllerEnabled

public Boolean getIsControllerEnabled()

getRateLimiter

public MLRateLimiter getRateLimiter()

getCreatedTime

public Instant getCreatedTime()

getLastUpdateTime

public Instant getLastUpdateTime()

getLastRegisteredTime

public Instant getLastRegisteredTime()

getLastDeployedTime

public Instant getLastDeployedTime()

getLastUndeployedTime

public Instant getLastUndeployedTime()

getModelId

public String getModelId()

getAutoRedeployRetryTimes

public Integer getAutoRedeployRetryTimes()

getChunkNumber

public Integer getChunkNumber()

getTotalChunks

public Integer getTotalChunks()

getPlanningWorkerNodeCount

public Integer getPlanningWorkerNodeCount()

getCurrentWorkerNodeCount

public Integer getCurrentWorkerNodeCount()

getPlanningWorkerNodes

public String[] getPlanningWorkerNodes()

isDeployToAllNodes

public boolean isDeployToAllNodes()

getIsHidden

public Boolean getIsHidden()

getConnector

public Connector getConnector()

getConnectorId

public String getConnectorId()

getGuardrails

public Guardrails getGuardrails()

setDescription

public void setDescription(String description)

setModelId

public void setModelId(String modelId)

setConnector

public void setConnector(Connector connector)