Package org.opensearch.client.opensearch.security

Class GetUserRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.GetUserRequest

All Implemented Interfaces:

ToCopyableBuilder<GetUserRequest.Builder,GetUserRequest>

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

Retrieve information about the specified internal user.

Nested Class Summary

Nested Classes

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

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<GetUserRequest,GetUserResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_user".

Method Summary

Modifier and Type	Method	Description
static GetUserRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static GetUserRequest	of(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)
GetUserRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	username()	Required - The name of the user to retrieve.

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<GetUserRequest,GetUserResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_user".

Method Details

of

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

username

@Nonnull
public final String username()

Required - The name of the user to retrieve.

API name: username

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static GetUserRequest.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object