Package org.opensearch.client.opensearch.security

Class AuthinfoRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.security.AuthinfoRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

AuthinfoRequest

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

Builder for AuthinfoRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AuthinfoRequest.Builder	authType(String value)	The type of the current authentication request.
AuthinfoRequest	build()	Builds a AuthinfoRequest.
AuthinfoRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected AuthinfoRequest.Builder	self()
final AuthinfoRequest.Builder	verbose(Boolean value)	Whether to return a verbose response.

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

Returns:

a new builder instance.

self

@Nonnull
protected AuthinfoRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AuthinfoRequest.Builder>

authType

@Nonnull
public final AuthinfoRequest.Builder authType(@Nullable
 String value)

The type of the current authentication request.

API name: auth_type

verbose

@Nonnull
public final AuthinfoRequest.Builder verbose(@Nullable
 Boolean value)

Whether to return a verbose response.

API name: verbose

build

@Nonnull
public AuthinfoRequest build()

Builds a AuthinfoRequest.

Specified by:

build in interface ObjectBuilder<AuthinfoRequest>

Throws:

NullPointerException - if some of the required fields are null.