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, ToCopyableBuilder<RegisterModelGroupRequest.Builder,RegisterModelGroupRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class RegisterModelGroupRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<RegisterModelGroupRequest.Builder,RegisterModelGroupRequest>

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 final JsonpDeserializer<RegisterModelGroupRequest>	_DESERIALIZER	Json deserializer for RegisterModelGroupRequest
static final Endpoint<RegisterModelGroupRequest,RegisterModelGroupResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.register_model_group".

Method Summary

Modifier and Type	Method	Description
final String	accessMode()	The model group access mode.
final Boolean	addAllBackendRoles()	The add all backend roles.
final List<String>	backendRoles()	The backend roles.
static RegisterModelGroupRequest.Builder	builder()
final String	description()	The model group description.
boolean	equals(Object o)
int	hashCode()
final String	name()	Required - The model group name.
static RegisterModelGroupRequest	of(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)
RegisterModelGroupRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_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 Details

of

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

accessMode

@Nullable
public final String accessMode()

The model group access mode.

API name: access_mode

addAllBackendRoles

@Nullable
public final Boolean addAllBackendRoles()

The add all backend roles.

API name: add_all_backend_roles

backendRoles

@Nonnull
public final List<String> backendRoles()

The backend roles.

API name: backend_roles

description

@Nullable
public final String description()

The model group description.

API name: description

name

@Nonnull
public final 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)

toBuilder

@Nonnull
public RegisterModelGroupRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterModelGroupRequest.Builder,RegisterModelGroupRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static RegisterModelGroupRequest.Builder builder()

setupRegisterModelGroupRequestDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object