Package org.opensearch.ml.common.transport.upload_chunk

Class MLRegisterModelMetaInput

java.lang.Object

org.opensearch.ml.common.transport.upload_chunk.MLRegisterModelMetaInput

All Implemented Interfaces:

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

public class MLRegisterModelMetaInput
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	MLRegisterModelMetaInput.MLRegisterModelMetaInputBuilder

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
static final String	ADD_ALL_BACKEND_ROLES
static final String	BACKEND_ROLES_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	IS_ENABLED_FIELD
static final String	MODEL_CONFIG_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_NAME_FIELD
static final String	MODEL_STATE_FIELD
static final String	RATE_LIMITER_FIELD
static final String	TOTAL_CHUNKS_FIELD
static final String	VERSION_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLRegisterModelMetaInput(String name, FunctionName functionName, String modelGroupId, String version, String description, Boolean isEnabled, MLRateLimiter rateLimiter, MLModelFormat modelFormat, MLModelState modelState, Long modelContentSizeInBytes, String modelContentHashValue, MLModelConfig modelConfig, MLDeploySetting deploySetting, Integer totalChunks, List<String> backendRoles, AccessMode accessMode, Boolean isAddAllBackendRoles, Boolean doesVersionCreateModelGroup, Boolean isHidden)
MLRegisterModelMetaInput(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static MLRegisterModelMetaInput.MLRegisterModelMetaInputBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
AccessMode	getAccessMode()
List<String>	getBackendRoles()
MLDeploySetting	getDeploySetting()
String	getDescription()
Boolean	getDoesVersionCreateModelGroup()
FunctionName	getFunctionName()
Boolean	getIsAddAllBackendRoles()
Boolean	getIsEnabled()
Boolean	getIsHidden()
MLModelConfig	getModelConfig()
String	getModelContentHashValue()
Long	getModelContentSizeInBytes()
MLModelFormat	getModelFormat()
String	getModelGroupId()
MLModelState	getModelState()
String	getName()
MLRateLimiter	getRateLimiter()
Integer	getTotalChunks()
String	getVersion()
int	hashCode()
static MLRegisterModelMetaInput	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setAccessMode(AccessMode accessMode)
void	setBackendRoles(List<String> backendRoles)
void	setDeploySetting(MLDeploySetting deploySetting)
void	setDescription(String description)
void	setDoesVersionCreateModelGroup(Boolean doesVersionCreateModelGroup)
void	setFunctionName(FunctionName functionName)
void	setIsAddAllBackendRoles(Boolean isAddAllBackendRoles)
void	setIsEnabled(Boolean isEnabled)
void	setIsHidden(Boolean isHidden)
void	setModelConfig(MLModelConfig modelConfig)
void	setModelContentHashValue(String modelContentHashValue)
void	setModelContentSizeInBytes(Long modelContentSizeInBytes)
void	setModelFormat(MLModelFormat modelFormat)
void	setModelGroupId(String modelGroupId)
void	setModelState(MLModelState modelState)
void	setName(String name)
void	setRateLimiter(MLRateLimiter rateLimiter)
void	setTotalChunks(Integer totalChunks)
void	setVersion(String version)
MLRegisterModelMetaInput.MLRegisterModelMetaInputBuilder	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

MODEL_NAME_FIELD

public static final String MODEL_NAME_FIELD

See Also:

• Constant Field Values

DESCRIPTION_FIELD

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

VERSION_FIELD

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

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

TOTAL_CHUNKS_FIELD

public static final String TOTAL_CHUNKS_FIELD

See Also:

• Constant Field Values

MODEL_GROUP_ID_FIELD

public static final String MODEL_GROUP_ID_FIELD

See Also:

• Constant Field Values

BACKEND_ROLES_FIELD

public static final String BACKEND_ROLES_FIELD

See Also:

• Constant Field Values

ACCESS_MODE

public static final String ACCESS_MODE

See Also:

• Constant Field Values

ADD_ALL_BACKEND_ROLES

public static final String ADD_ALL_BACKEND_ROLES

See Also:

• Constant Field Values

DOES_VERSION_CREATE_MODEL_GROUP

public static final String DOES_VERSION_CREATE_MODEL_GROUP

See Also:

• Constant Field Values

Constructor Details

MLRegisterModelMetaInput

public MLRegisterModelMetaInput(String name,
 FunctionName functionName,
 String modelGroupId,
 String version,
 String description,
 Boolean isEnabled,
 MLRateLimiter rateLimiter,
 MLModelFormat modelFormat,
 MLModelState modelState,
 Long modelContentSizeInBytes,
 String modelContentHashValue,
 MLModelConfig modelConfig,
 MLDeploySetting deploySetting,
 Integer totalChunks,
 List<String> backendRoles,
 AccessMode accessMode,
 Boolean isAddAllBackendRoles,
 Boolean doesVersionCreateModelGroup,
 Boolean isHidden)

MLRegisterModelMetaInput

public MLRegisterModelMetaInput(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 MLRegisterModelMetaInput parse(org.opensearch.core.xcontent.XContentParser parser)
                                      throws IOException

Throws:

IOException

builder

public static MLRegisterModelMetaInput.MLRegisterModelMetaInputBuilder builder()

toBuilder

public MLRegisterModelMetaInput.MLRegisterModelMetaInputBuilder toBuilder()

getFunctionName

public FunctionName getFunctionName()

getName

public String getName()

getModelGroupId

public String getModelGroupId()

getDescription

public String getDescription()

getVersion

public String getVersion()

getIsEnabled

public Boolean getIsEnabled()

getRateLimiter

public MLRateLimiter getRateLimiter()

getModelFormat

public MLModelFormat getModelFormat()

getModelState

public MLModelState getModelState()

getModelContentSizeInBytes

public Long getModelContentSizeInBytes()

getModelContentHashValue

public String getModelContentHashValue()

getModelConfig

public MLModelConfig getModelConfig()

getDeploySetting

public MLDeploySetting getDeploySetting()

getTotalChunks

public Integer getTotalChunks()

getBackendRoles

public List<String> getBackendRoles()

getAccessMode

public AccessMode getAccessMode()

getIsAddAllBackendRoles

public Boolean getIsAddAllBackendRoles()

getDoesVersionCreateModelGroup

public Boolean getDoesVersionCreateModelGroup()

getIsHidden

public Boolean getIsHidden()

setFunctionName

public void setFunctionName(FunctionName functionName)

setName

public void setName(String name)

setModelGroupId

public void setModelGroupId(String modelGroupId)

setDescription

public void setDescription(String description)

setVersion

public void setVersion(String version)

setIsEnabled

public void setIsEnabled(Boolean isEnabled)

setRateLimiter

public void setRateLimiter(MLRateLimiter rateLimiter)

setModelFormat

public void setModelFormat(MLModelFormat modelFormat)

setModelState

public void setModelState(MLModelState modelState)

setModelContentSizeInBytes

public void setModelContentSizeInBytes(Long modelContentSizeInBytes)

setModelContentHashValue

public void setModelContentHashValue(String modelContentHashValue)

setModelConfig

public void setModelConfig(MLModelConfig modelConfig)

setDeploySetting

public void setDeploySetting(MLDeploySetting deploySetting)

setTotalChunks

public void setTotalChunks(Integer totalChunks)

setBackendRoles

public void setBackendRoles(List<String> backendRoles)

setAccessMode

public void setAccessMode(AccessMode accessMode)

setIsAddAllBackendRoles

public void setIsAddAllBackendRoles(Boolean isAddAllBackendRoles)

setDoesVersionCreateModelGroup

public void setDoesVersionCreateModelGroup(Boolean doesVersionCreateModelGroup)

setIsHidden

public void setIsHidden(Boolean isHidden)

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