Package org.opensearch.client.opensearch.ml

Class GetToolRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.GetToolRequest

All Implemented Interfaces:

ToCopyableBuilder<GetToolRequest.Builder,GetToolRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class GetToolRequest
extends RequestBase
implements ToCopyableBuilder<GetToolRequest.Builder,GetToolRequest>

Get tools.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetToolRequest.Builder	Builder for GetToolRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetToolRequest,GetToolResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.get_tool".

Method Summary

Modifier and Type	Method	Description
static GetToolRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static GetToolRequest	of(Function<GetToolRequest.Builder,ObjectBuilder<GetToolRequest>> fn)
GetToolRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	toolName()	Required - API name: tool_name

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<GetToolRequest,GetToolResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.get_tool".

Method Details

of

public static GetToolRequest of(Function<GetToolRequest.Builder,ObjectBuilder<GetToolRequest>> fn)

toolName

@Nonnull
public final String toolName()

Required - API name: tool_name

toBuilder

@Nonnull
public GetToolRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetToolRequest.Builder,GetToolRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetToolRequest.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object