Package org.opensearch.client.opensearch.security

Class GetRoleRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.security.GetRoleRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetRoleRequest

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

Builder for GetRoleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

Returns:

a new builder instance.

self

@Nonnull
protected GetRoleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetRoleRequest.Builder>

role

@Nonnull
public final GetRoleRequest.Builder role(String value)

Required - The name of the role to retrieve.

API name: role

build

@Nonnull
public GetRoleRequest build()

Builds a GetRoleRequest.

Specified by:

build in interface ObjectBuilder<GetRoleRequest>

Throws:

NullPointerException - if some of the required fields are null.