Package org.opensearch.client.opensearch.ml

Class GetAgentRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.GetAgentRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetAgentRequest

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

Builder for GetAgentRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GetAgentRequest.Builder	agentId(String value)	Required - API name: agent_id
GetAgentRequest	build()	Builds a GetAgentRequest.
GetAgentRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected GetAgentRequest.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 GetAgentRequest.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<GetAgentRequest.Builder,GetAgentRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetAgentRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetAgentRequest.Builder>

agentId

@Nonnull
public final GetAgentRequest.Builder agentId(String value)

Required - API name: agent_id

build

@Nonnull
public GetAgentRequest build()

Builds a GetAgentRequest.

Specified by:

build in interface ObjectBuilder<GetAgentRequest>

Throws:

NullPointerException - if some of the required fields are null.