Package org.opensearch.client.opensearch.security

Class GenerateOboTokenRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.GenerateOboTokenRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<GenerateOboTokenRequest.Builder,GenerateOboTokenRequest>

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

Generates a On-Behalf-Of token for the current user.

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<GenerateOboTokenRequest>	_DESERIALIZER	Json deserializer for GenerateOboTokenRequest
static final Endpoint<GenerateOboTokenRequest,GenerateOboTokenResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.generate_obo_token".

Method Summary

Modifier and Type	Method	Description
static GenerateOboTokenRequest.Builder	builder()
final String	description()	Required - The description supplied by the user to describe the token.
final String	duration()	A duration in seconds.
boolean	equals(Object o)
int	hashCode()
static GenerateOboTokenRequest	of(Function<GenerateOboTokenRequest.Builder,ObjectBuilder<GenerateOboTokenRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
final String	service()	The name of the service when generating a token for that service.
protected static void	setupGenerateOboTokenRequestDeserializer(ObjectDeserializer<GenerateOboTokenRequest.Builder> op)
GenerateOboTokenRequest.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.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GenerateOboTokenRequest> _DESERIALIZER

Json deserializer for GenerateOboTokenRequest

_ENDPOINT

public static final Endpoint<GenerateOboTokenRequest,GenerateOboTokenResponse,ErrorResponse> _ENDPOINT

Endpoint "security.generate_obo_token".

Method Details

of

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

description

@Nonnull
public final String description()

Required - The description supplied by the user to describe the token.

API name: description

duration

@Nullable
public final String duration()

A duration in seconds.

API name: duration

service

@Nullable
public final String service()

The name of the service when generating a token for that service.

API name: service

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static GenerateOboTokenRequest.Builder builder()

setupGenerateOboTokenRequestDeserializer

protected static void setupGenerateOboTokenRequestDeserializer(ObjectDeserializer<GenerateOboTokenRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object