Package org.opensearch.client.opensearch.ml

Class UpdateMessageRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.UpdateMessageRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<UpdateMessageRequest.Builder,UpdateMessageRequest>

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

Update a message.

Nested Class Summary

Nested Classes

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

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<UpdateMessageRequest>	_DESERIALIZER	Json deserializer for UpdateMessageRequest
static final Endpoint<UpdateMessageRequest,UpdateMessageResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.update_message".

Method Summary

Modifier and Type	Method	Description
final Map<String,JsonData>	additionalInfo()	API name: additional_info
static UpdateMessageRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	input()	The question in the message.
final String	messageId()	Required - API name: message_id
static UpdateMessageRequest	of(Function<UpdateMessageRequest.Builder,ObjectBuilder<UpdateMessageRequest>> fn)
final String	origin()	The system name that generated the response.
final String	promptTemplate()	The prompt template.
final String	response()	The answer to the question.
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	setupUpdateMessageRequestDeserializer(ObjectDeserializer<UpdateMessageRequest.Builder> op)
UpdateMessageRequest.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<UpdateMessageRequest> _DESERIALIZER

Json deserializer for UpdateMessageRequest

_ENDPOINT

public static final Endpoint<UpdateMessageRequest,UpdateMessageResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.update_message".

Method Details

of

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

additionalInfo

@Nonnull
public final Map<String,JsonData> additionalInfo()

API name: additional_info

input

@Nullable
public final String input()

The question in the message.

API name: input

messageId

@Nonnull
public final String messageId()

Required - API name: message_id

origin

@Nullable
public final String origin()

The system name that generated the response.

API name: origin

promptTemplate

@Nullable
public final String promptTemplate()

The prompt template.

API name: prompt_template

response

@Nullable
public final String response()

The answer to the question.

API name: response

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 UpdateMessageRequest.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<UpdateMessageRequest.Builder,UpdateMessageRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static UpdateMessageRequest.Builder builder()

setupUpdateMessageRequestDeserializer

protected static void setupUpdateMessageRequestDeserializer(ObjectDeserializer<UpdateMessageRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object