Package org.opensearch.client.opensearch.ml

Class CreateMessageRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.CreateMessageRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

CreateMessageRequest

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

Builder for CreateMessageRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

self

@Nonnull
protected CreateMessageRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CreateMessageRequest.Builder>

additionalInfo

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

API name: additional_info

Adds all elements of map to additionalInfo.

additionalInfo

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

API name: additional_info

Adds an entry to additionalInfo.

input

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

The question in the message.

API name: input

memoryId

@Nonnull
public final CreateMessageRequest.Builder memoryId(String value)

Required - API name: memory_id

origin

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

The system name that generated the response.

API name: origin

promptTemplate

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

The prompt template.

API name: prompt_template

response

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

The answer to the question.

API name: response

build

@Nonnull
public CreateMessageRequest build()

Builds a CreateMessageRequest.

Specified by:

build in interface ObjectBuilder<CreateMessageRequest>

Throws:

NullPointerException - if some of the required fields are null.