Package org.opensearch.client.opensearch.ml

Class UploadModelRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.UploadModelRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

UploadModelRequest

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

Builder for UploadModelRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UploadModelRequest	build()	Builds a UploadModelRequest.
UploadModelRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final UploadModelRequest.Builder	description(String value)	The model description.
final UploadModelRequest.Builder	modelFormat(ModelFormat value)	API name: model_format
final UploadModelRequest.Builder	modelGroupId(String value)	API name: model_group_id
final UploadModelRequest.Builder	name(String value)	Required - The model name.
protected UploadModelRequest.Builder	self()
final UploadModelRequest.Builder	version(String value)	Required - API name: version

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 UploadModelRequest.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<UploadModelRequest.Builder,UploadModelRequest>

Returns:

a new builder instance.

self

@Nonnull
protected UploadModelRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<UploadModelRequest.Builder>

description

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

The model description.

API name: description

modelFormat

@Nonnull
public final UploadModelRequest.Builder modelFormat(@Nullable
 ModelFormat value)

API name: model_format

modelGroupId

@Nonnull
public final UploadModelRequest.Builder modelGroupId(@Nullable
 String value)

API name: model_group_id

name

@Nonnull
public final UploadModelRequest.Builder name(String value)

Required - The model name.

API name: name

version

@Nonnull
public final UploadModelRequest.Builder version(String value)

Required - API name: version

build

@Nonnull
public UploadModelRequest build()

Builds a UploadModelRequest.

Specified by:

build in interface ObjectBuilder<UploadModelRequest>

Throws:

NullPointerException - if some of the required fields are null.