Package org.opensearch.ml.common.controller

Class MLController

java.lang.Object

org.opensearch.ml.common.controller.MLController

All Implemented Interfaces:

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

public class MLController
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	MLController.MLControllerBuilder

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	MODEL_ID_FIELD
static final String	USER_RATE_LIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLController(String modelId, Map<String,MLRateLimiter> userRateLimiter)
MLController(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static MLController.MLControllerBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getModelId()
Map<String,MLRateLimiter>	getUserRateLimiter()
int	hashCode()
boolean	isDeployRequiredAfterUpdate(MLController updateContent)	Checks if a deployment is required after updating the MLController.
static MLController	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setModelId(String modelId)
void	setUserRateLimiter(Map<String,MLRateLimiter> userRateLimiter)
MLController.MLControllerBuilder	toBuilder()
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	update(MLController updateContent)
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

MODEL_ID_FIELD

public static final String MODEL_ID_FIELD

See Also:

• Constant Field Values

USER_RATE_LIMITER

public static final String USER_RATE_LIMITER

See Also:

• Constant Field Values

Constructor Details

MLController

public MLController(String modelId,
 Map<String,MLRateLimiter> userRateLimiter)

MLController

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

Throws:

IOException

Method Details

parse

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

Throws:

IOException

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

isDeployRequiredAfterUpdate

public boolean isDeployRequiredAfterUpdate(MLController updateContent)

Checks if a deployment is required after updating the MLController.

Parameters:

updateContent - The updated MLController object.

Returns:

True if a deployment is required, false otherwise.

update

public void update(MLController updateContent)

builder

public static MLController.MLControllerBuilder builder()

toBuilder

public MLController.MLControllerBuilder toBuilder()

getUserRateLimiter

public Map<String,MLRateLimiter> getUserRateLimiter()

setModelId

public void setModelId(String modelId)

setUserRateLimiter

public void setUserRateLimiter(Map<String,MLRateLimiter> userRateLimiter)

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

getModelId

public String getModelId()