Package org.opensearch.client.opensearch.security

Class AuthinfoRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.AuthinfoRequest

All Implemented Interfaces:

ToCopyableBuilder<AuthinfoRequest.Builder,AuthinfoRequest>

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

Returns or updates authentication information for the currently authenticated user.

Nested Class Summary

Nested Classes

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

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<AuthinfoRequest,AuthinfoResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.authinfo".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
final String	authType()	The type of the current authentication request.
static AuthinfoRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static AuthinfoRequest	of(Function<AuthinfoRequest.Builder,ObjectBuilder<AuthinfoRequest>> fn)
AuthinfoRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Boolean	verbose()	Whether to return a verbose response.

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

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<AuthinfoRequest,AuthinfoResponse,ErrorResponse> _ENDPOINT

Endpoint "security.authinfo".

Method Details

of

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

authType

@Nullable
public final String authType()

The type of the current authentication request.

API name: auth_type

verbose

@Nullable
public final Boolean verbose()

Whether to return a verbose response.

API name: verbose

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static AuthinfoRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object