Package org.opensearch.client.opensearch.security

Class GetRoleRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.GetRoleRequest

All Implemented Interfaces:

ToCopyableBuilder<GetRoleRequest.Builder,GetRoleRequest>

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

Retrieves one role.

Nested Class Summary

Nested Classes

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

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<GetRoleRequest,GetRoleResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_role".

Method Summary

Modifier and Type	Method	Description
static GetRoleRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static GetRoleRequest	of(Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)
final String	role()	Required - The name of the role to retrieve.
GetRoleRequest.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<GetRoleRequest,GetRoleResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_role".

Method Details

of

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

role

@Nonnull
public final String role()

Required - The name of the role to retrieve.

API name: role

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static GetRoleRequest.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object