Package org.opensearch.client.opensearch.ml

Class UpdateMessageRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<UpdateMessageRequest.Builder>

org.opensearch.client.opensearch.ml.UpdateMessageRequest.Builder

All Implemented Interfaces:

CopyableBuilder<UpdateMessageRequest.Builder,UpdateMessageRequest>, MutableBuilder<UpdateMessageRequest.Builder,UpdateMessageRequest>, ObjectBuilder<UpdateMessageRequest>

Enclosing class:

UpdateMessageRequest

public static class UpdateMessageRequest.Builder
extends RequestBase.AbstractBuilder<UpdateMessageRequest.Builder>
implements CopyableBuilder<UpdateMessageRequest.Builder,UpdateMessageRequest>

Builder for UpdateMessageRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final UpdateMessageRequest.Builder	additionalInfo(String key, JsonData value)	API name: additional_info
final UpdateMessageRequest.Builder	additionalInfo(Map<String,JsonData> map)	API name: additional_info
UpdateMessageRequest	build()	Builds a UpdateMessageRequest.
UpdateMessageRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final UpdateMessageRequest.Builder	input(String value)	The question in the message.
final UpdateMessageRequest.Builder	messageId(String value)	Required - API name: message_id
final UpdateMessageRequest.Builder	origin(String value)	The system name that generated the response.
final UpdateMessageRequest.Builder	promptTemplate(String value)	The prompt template.
final UpdateMessageRequest.Builder	response(String value)	The answer to the question.
protected UpdateMessageRequest.Builder	self()

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public UpdateMessageRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<UpdateMessageRequest.Builder,UpdateMessageRequest>

Returns:

a new builder instance.

self

@Nonnull
protected UpdateMessageRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<UpdateMessageRequest.Builder>

additionalInfo

@Nonnull
public final UpdateMessageRequest.Builder additionalInfo(Map<String,JsonData> map)

API name: additional_info

Adds all elements of map to additionalInfo.

additionalInfo

@Nonnull
public final UpdateMessageRequest.Builder additionalInfo(String key,
 JsonData value)

API name: additional_info

Adds an entry to additionalInfo.

input

@Nonnull
public final UpdateMessageRequest.Builder input(@Nullable
 String value)

The question in the message.

API name: input

messageId

@Nonnull
public final UpdateMessageRequest.Builder messageId(String value)

Required - API name: message_id

origin

@Nonnull
public final UpdateMessageRequest.Builder origin(@Nullable
 String value)

The system name that generated the response.

API name: origin

promptTemplate

@Nonnull
public final UpdateMessageRequest.Builder promptTemplate(@Nullable
 String value)

The prompt template.

API name: prompt_template

response

@Nonnull
public final UpdateMessageRequest.Builder response(@Nullable
 String value)

The answer to the question.

API name: response

build

@Nonnull
public UpdateMessageRequest build()

Builds a UpdateMessageRequest.

Specified by:

build in interface ObjectBuilder<UpdateMessageRequest>

Throws:

NullPointerException - if some of the required fields are null.