Package org.opensearch.client.opensearch.ml

Class UpdateModelGroupRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.UpdateModelGroupRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

UpdateModelGroupRequest

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

Builder for UpdateModelGroupRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final UpdateModelGroupRequest.Builder	addAllBackendRoles(Boolean value)	Whether to include all backend roles.
final UpdateModelGroupRequest.Builder	addBackendRoles(String value, String... values)	The backend roles to add.
final UpdateModelGroupRequest.Builder	addBackendRoles(List<String> list)	The backend roles to add.
final UpdateModelGroupRequest.Builder	backendRoles(String value, String... values)	The backend roles.
final UpdateModelGroupRequest.Builder	backendRoles(List<String> list)	The backend roles.
UpdateModelGroupRequest	build()	Builds a UpdateModelGroupRequest.
UpdateModelGroupRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final UpdateModelGroupRequest.Builder	description(String value)	The model group description.
final UpdateModelGroupRequest.Builder	modelAccessName(String value)	The model access name
final UpdateModelGroupRequest.Builder	modelGroupId(String value)	Required - API name: model_group_id
final UpdateModelGroupRequest.Builder	name(String value)	The model group name.
protected UpdateModelGroupRequest.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 UpdateModelGroupRequest.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<UpdateModelGroupRequest.Builder,UpdateModelGroupRequest>

Returns:

a new builder instance.

self

@Nonnull
protected UpdateModelGroupRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<UpdateModelGroupRequest.Builder>

addAllBackendRoles

@Nonnull
public final UpdateModelGroupRequest.Builder addAllBackendRoles(@Nullable
 Boolean value)

Whether to include all backend roles.

API name: add_all_backend_roles

addBackendRoles

@Nonnull
public final UpdateModelGroupRequest.Builder addBackendRoles(List<String> list)

The backend roles to add.

API name: add_backend_roles

Adds all elements of list to addBackendRoles.

addBackendRoles

@Nonnull
public final UpdateModelGroupRequest.Builder addBackendRoles(String value,
 String... values)

The backend roles to add.

API name: add_backend_roles

Adds one or more values to addBackendRoles.

backendRoles

@Nonnull
public final UpdateModelGroupRequest.Builder backendRoles(List<String> list)

The backend roles.

API name: backend_roles

Adds all elements of list to backendRoles.

backendRoles

@Nonnull
public final UpdateModelGroupRequest.Builder backendRoles(String value,
 String... values)

The backend roles.

API name: backend_roles

Adds one or more values to backendRoles.

description

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

The model group description.

API name: description

modelAccessName

@Nonnull
public final UpdateModelGroupRequest.Builder modelAccessName(@Nullable
 String value)

The model access name

API name: model_access_name

modelGroupId

@Nonnull
public final UpdateModelGroupRequest.Builder modelGroupId(String value)

Required - API name: model_group_id

name

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

The model group name.

API name: name

build

@Nonnull
public UpdateModelGroupRequest build()

Builds a UpdateModelGroupRequest.

Specified by:

build in interface ObjectBuilder<UpdateModelGroupRequest>

Throws:

NullPointerException - if some of the required fields are null.