Package org.opensearch.client.opensearch.security

Class WhoAmIProtectedRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.WhoAmIProtectedRequest

All Implemented Interfaces:

ToCopyableBuilder<WhoAmIProtectedRequest.Builder,WhoAmIProtectedRequest>

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

Gets the identity information for the user currently logged in. To use this operation, you must have access to this endpoint when authorization at REST layer is enabled.

Nested Class Summary

Nested Classes

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

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<WhoAmIProtectedRequest,WhoAmIProtectedResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.who_am_i_protected".

Method Summary

Modifier and Type	Method	Description
static WhoAmIProtectedRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static WhoAmIProtectedRequest	of(Function<WhoAmIProtectedRequest.Builder,ObjectBuilder<WhoAmIProtectedRequest>> fn)
WhoAmIProtectedRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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<WhoAmIProtectedRequest,WhoAmIProtectedResponse,ErrorResponse> _ENDPOINT

Endpoint "security.who_am_i_protected".

Method Details

of

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

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static WhoAmIProtectedRequest.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object