Package org.opensearch.client.opensearch.ml

Class RegisterModelGroupRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.RegisterModelGroupRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RegisterModelGroupRequest
extends RequestBase
implements PlainJsonSerializable

Registers a model group.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RegisterModelGroupRequest.Builder	Builder for RegisterModelGroupRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<RegisterModelGroupRequest>	_DESERIALIZER	Json deserializer for RegisterModelGroupRequest
static Endpoint<RegisterModelGroupRequest,RegisterModelGroupResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.register_model_group".

Method Summary

Modifier and Type	Method	Description
java.lang.String	accessMode()	The model group access mode.
java.lang.Boolean	addAllBackendRoles()	The add all backend roles.
java.util.List<java.lang.String>	backendRoles()	The backend roles.
java.lang.String	description()	The model group description.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	name()	Required - The model group name.
static RegisterModelGroupRequest	of(java.util.function.Function<RegisterModelGroupRequest.Builder,ObjectBuilder<RegisterModelGroupRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRegisterModelGroupRequestDeserializer(ObjectDeserializer<RegisterModelGroupRequest.Builder> op)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<RegisterModelGroupRequest> _DESERIALIZER

Json deserializer for RegisterModelGroupRequest

_ENDPOINT

public static final Endpoint<RegisterModelGroupRequest,RegisterModelGroupResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.register_model_group".

Method Detail

of

public static RegisterModelGroupRequest of(java.util.function.Function<RegisterModelGroupRequest.Builder,ObjectBuilder<RegisterModelGroupRequest>> fn)

accessMode

@Nullable
public final java.lang.String accessMode()

The model group access mode.

API name: access_mode

addAllBackendRoles

@Nullable
public final java.lang.Boolean addAllBackendRoles()

The add all backend roles.

API name: add_all_backend_roles

backendRoles

@Nonnull
public final java.util.List<java.lang.String> backendRoles()

The backend roles.

API name: backend_roles

description

@Nullable
public final java.lang.String description()

The model group description.

API name: description

name

@Nonnull
public final java.lang.String name()

Required - The model group name.

API name: name

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupRegisterModelGroupRequestDeserializer

protected static void setupRegisterModelGroupRequestDeserializer(ObjectDeserializer<RegisterModelGroupRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object