Package org.opensearch.client.opensearch.ml

Class RegisterModelGroupRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.RegisterModelGroupRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

RegisterModelGroupRequest

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

Builder for RegisterModelGroupRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RegisterModelGroupRequest.Builder	accessMode(java.lang.String value)	The model group access mode.
RegisterModelGroupRequest.Builder	addAllBackendRoles(java.lang.Boolean value)	The add all backend roles.
RegisterModelGroupRequest.Builder	backendRoles(java.lang.String value, java.lang.String... values)	The backend roles.
RegisterModelGroupRequest.Builder	backendRoles(java.util.List<java.lang.String> list)	The backend roles.
RegisterModelGroupRequest	build()	Builds a RegisterModelGroupRequest.
RegisterModelGroupRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
RegisterModelGroupRequest.Builder	description(java.lang.String value)	The model group description.
RegisterModelGroupRequest.Builder	name(java.lang.String value)	Required - The model group name.
protected RegisterModelGroupRequest.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, _listAdd, _listAddAll, _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 Detail

Builder

public Builder()

Method Detail

copy

@Nonnull
public RegisterModelGroupRequest.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<RegisterModelGroupRequest.Builder,RegisterModelGroupRequest>

Returns:

a new builder instance.

self

@Nonnull
protected RegisterModelGroupRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RegisterModelGroupRequest.Builder>

accessMode

@Nonnull
public final RegisterModelGroupRequest.Builder accessMode(@Nullable
                                                          java.lang.String value)

The model group access mode.

API name: access_mode

addAllBackendRoles

@Nonnull
public final RegisterModelGroupRequest.Builder addAllBackendRoles(@Nullable
                                                                  java.lang.Boolean value)

The add all backend roles.

API name: add_all_backend_roles

backendRoles

@Nonnull
public final RegisterModelGroupRequest.Builder backendRoles(java.util.List<java.lang.String> list)

The backend roles.

API name: backend_roles

Adds all elements of list to backendRoles.

backendRoles

@Nonnull
public final RegisterModelGroupRequest.Builder backendRoles(java.lang.String value,
                                                            java.lang.String... values)

The backend roles.

API name: backend_roles

Adds one or more values to backendRoles.

description

@Nonnull
public final RegisterModelGroupRequest.Builder description(@Nullable
                                                           java.lang.String value)

The model group description.

API name: description

name

@Nonnull
public final RegisterModelGroupRequest.Builder name(java.lang.String value)

Required - The model group name.

API name: name

build

@Nonnull
public RegisterModelGroupRequest build()

Builds a RegisterModelGroupRequest.

Specified by:

build in interface ObjectBuilder<RegisterModelGroupRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.