Package org.opensearch.client.opensearch.security

Class GetUserRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.security.GetUserRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetUserRequest

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

Builder for GetUserRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetUserRequest	build()	Builds a GetUserRequest.
GetUserRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected GetUserRequest.Builder	self()
final GetUserRequest.Builder	username(String value)	Required - The name of the user to retrieve.

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

Returns:

a new builder instance.

self

@Nonnull
protected GetUserRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetUserRequest.Builder>

username

@Nonnull
public final GetUserRequest.Builder username(String value)

Required - The name of the user to retrieve.

API name: username

build

@Nonnull
public GetUserRequest build()

Builds a GetUserRequest.

Specified by:

build in interface ObjectBuilder<GetUserRequest>

Throws:

NullPointerException - if some of the required fields are null.