Package org.opensearch.client.opensearch.ml

Class GetToolRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.GetToolRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetToolRequest

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

Builder for GetToolRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetToolRequest	build()	Builds a GetToolRequest.
GetToolRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected GetToolRequest.Builder	self()
final GetToolRequest.Builder	toolName(String value)	Required - API name: tool_name

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

Returns:

a new builder instance.

self

@Nonnull
protected GetToolRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetToolRequest.Builder>

toolName

@Nonnull
public final GetToolRequest.Builder toolName(String value)

Required - API name: tool_name

build

@Nonnull
public GetToolRequest build()

Builds a GetToolRequest.

Specified by:

build in interface ObjectBuilder<GetToolRequest>

Throws:

NullPointerException - if some of the required fields are null.