Package org.opensearch.ml.common

Class MLModelGroup

java.lang.Object

org.opensearch.ml.common.MLModelGroup

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MLModelGroup.MLModelGroupBuilder

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	ACCESS
static final String	BACKEND_ROLES_FIELD
static final String	CREATED_TIME_FIELD
static final String	DESCRIPTION_FIELD
static final String	LAST_UPDATED_TIME_FIELD
static final String	LATEST_VERSION_FIELD
static final String	MODEL_GROUP_ID_FIELD
static final String	MODEL_GROUP_NAME_FIELD
static final String	OWNER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLModelGroup(String name, String description, int latestVersion, List<String> backendRoles, org.opensearch.commons.authuser.User owner, String access, String modelGroupId, Instant createdTime, Instant lastUpdatedTime)
MLModelGroup(org.opensearch.core.common.io.stream.StreamInput input)

Method Summary

Modifier and Type	Method	Description
static MLModelGroup.MLModelGroupBuilder	builder()
static MLModelGroup	fromStream(org.opensearch.core.common.io.stream.StreamInput in)
String	getAccess()
List<String>	getBackendRoles()
Instant	getCreatedTime()
String	getDescription()
Instant	getLastUpdatedTime()
int	getLatestVersion()
String	getModelGroupId()
String	getName()
org.opensearch.commons.authuser.User	getOwner()
static MLModelGroup	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setName(String name)
MLModelGroup.MLModelGroupBuilder	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

MODEL_GROUP_NAME_FIELD

public static final String MODEL_GROUP_NAME_FIELD

See Also:

• Constant Field Values

DESCRIPTION_FIELD

public static final String DESCRIPTION_FIELD

See Also:

• Constant Field Values

LATEST_VERSION_FIELD

public static final String LATEST_VERSION_FIELD

See Also:

• Constant Field Values

BACKEND_ROLES_FIELD

public static final String BACKEND_ROLES_FIELD

See Also:

• Constant Field Values

OWNER

public static final String OWNER

See Also:

• Constant Field Values

ACCESS

public static final String ACCESS

See Also:

• Constant Field Values

MODEL_GROUP_ID_FIELD

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

Constructor Details

MLModelGroup

public MLModelGroup(String name,
 String description,
 int latestVersion,
 List<String> backendRoles,
 org.opensearch.commons.authuser.User owner,
 String access,
 String modelGroupId,
 Instant createdTime,
 Instant lastUpdatedTime)

MLModelGroup

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

Throws:

IOException

fromStream

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

Throws:

IOException

builder

public static MLModelGroup.MLModelGroupBuilder builder()

toBuilder

public MLModelGroup.MLModelGroupBuilder toBuilder()

getName

public String getName()

getDescription

public String getDescription()

getLatestVersion

public int getLatestVersion()

getBackendRoles

public List<String> getBackendRoles()

getOwner

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

getAccess

public String getAccess()

getModelGroupId

public String getModelGroupId()

getCreatedTime

public Instant getCreatedTime()

getLastUpdatedTime

public Instant getLastUpdatedTime()

setName

public void setName(String name)