Package org.opensearch.client.opensearch.ml

Class UpdateModelRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.UpdateModelRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

UpdateModelRequest

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

Builder for UpdateModelRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpdateModelRequest	build()	Builds a UpdateModelRequest.
final UpdateModelRequest.Builder	connector(String key, JsonData value)	The connector to use for the model.
final UpdateModelRequest.Builder	connector(Map<String,JsonData> map)	The connector to use for the model.
final UpdateModelRequest.Builder	connectorId(String value)	The connector ID.
UpdateModelRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final UpdateModelRequest.Builder	description(String value)	The model description.
final UpdateModelRequest.Builder	guardrails(Function<Guardrails.Builder,ObjectBuilder<Guardrails>> fn)	API name: guardrails
final UpdateModelRequest.Builder	guardrails(Guardrails value)	API name: guardrails
final UpdateModelRequest.Builder	interface_(String key, JsonData value)	The model interface.
final UpdateModelRequest.Builder	interface_(Map<String,JsonData> map)	The model interface.
final UpdateModelRequest.Builder	isEnabled(Boolean value)	Whether the model is enabled.
final UpdateModelRequest.Builder	modelConfig(Function<ModelConfig.Builder,ObjectBuilder<ModelConfig>> fn)	API name: model_config
final UpdateModelRequest.Builder	modelConfig(ModelConfig value)	API name: model_config
final UpdateModelRequest.Builder	modelId(String value)	Required - API name: model_id
final UpdateModelRequest.Builder	name(String value)	The model name.
final UpdateModelRequest.Builder	rateLimiter(Function<RateLimiter.Builder,ObjectBuilder<RateLimiter>> fn)	API name: rate_limiter
final UpdateModelRequest.Builder	rateLimiter(RateLimiter value)	API name: rate_limiter
protected UpdateModelRequest.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 UpdateModelRequest.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<UpdateModelRequest.Builder,UpdateModelRequest>

Returns:

a new builder instance.

self

@Nonnull
protected UpdateModelRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<UpdateModelRequest.Builder>

connector

@Nonnull
public final UpdateModelRequest.Builder connector(Map<String,JsonData> map)

The connector to use for the model.

API name: connector

Adds all elements of map to connector.

connector

@Nonnull
public final UpdateModelRequest.Builder connector(String key,
 JsonData value)

The connector to use for the model.

API name: connector

Adds an entry to connector.

connectorId

@Nonnull
public final UpdateModelRequest.Builder connectorId(@Nullable
 String value)

The connector ID.

API name: connector_id

description

@Nonnull
public final UpdateModelRequest.Builder description(@Nullable
 String value)

The model description.

API name: description

guardrails

@Nonnull
public final UpdateModelRequest.Builder guardrails(@Nullable
 Guardrails value)

API name: guardrails

guardrails

@Nonnull
public final UpdateModelRequest.Builder guardrails(Function<Guardrails.Builder,ObjectBuilder<Guardrails>> fn)

API name: guardrails

interface_

@Nonnull
public final UpdateModelRequest.Builder interface_(Map<String,JsonData> map)

The model interface.

API name: interface

Adds all elements of map to interface_.

interface_

@Nonnull
public final UpdateModelRequest.Builder interface_(String key,
 JsonData value)

The model interface.

API name: interface

Adds an entry to interface_.

isEnabled

@Nonnull
public final UpdateModelRequest.Builder isEnabled(@Nullable
 Boolean value)

Whether the model is enabled.

API name: is_enabled

modelConfig

@Nonnull
public final UpdateModelRequest.Builder modelConfig(@Nullable
 ModelConfig value)

API name: model_config

modelConfig

@Nonnull
public final UpdateModelRequest.Builder modelConfig(Function<ModelConfig.Builder,ObjectBuilder<ModelConfig>> fn)

API name: model_config

modelId

@Nonnull
public final UpdateModelRequest.Builder modelId(String value)

Required - API name: model_id

name

@Nonnull
public final UpdateModelRequest.Builder name(@Nullable
 String value)

The model name.

API name: name

rateLimiter

@Nonnull
public final UpdateModelRequest.Builder rateLimiter(@Nullable
 RateLimiter value)

API name: rate_limiter

rateLimiter

@Nonnull
public final UpdateModelRequest.Builder rateLimiter(Function<RateLimiter.Builder,ObjectBuilder<RateLimiter>> fn)

API name: rate_limiter

build

@Nonnull
public UpdateModelRequest build()

Builds a UpdateModelRequest.

Specified by:

build in interface ObjectBuilder<UpdateModelRequest>

Throws:

NullPointerException - if some of the required fields are null.