GetTokenRequest (java-client 7.17.5 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.GetTokenRequest

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public class GetTokenRequest
extends RequestBase
implements JsonpSerializable

Creates a bearer token for access without requiring basic authentication.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GetTokenRequest.Builder
Builder for GetTokenRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type	Field	Description
`static JsonpDeserializer<GetTokenRequest>`	`_DESERIALIZER`	Json deserializer for `GetTokenRequest`
`static Endpoint<GetTokenRequest,GetTokenResponse,ErrorResponse>`	`_ENDPOINT`	Endpoint "`security.get_token`".

Method Summary

Modifier and Type	Method	Description
`AccessTokenGrantType`	`grantType()`	API name: `grant_type`
`java.lang.String`	`kerberosTicket()`	API name: `kerberos_ticket`
`static GetTokenRequest`	`of(java.util.function.Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn)`
`java.lang.String`	`password()`	API name: `password`
`java.lang.String`	`refreshToken()`	API name: `refresh_token`
`java.lang.String`	`scope()`	API name: `scope`
`void`	`serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`	Serialize this object to JSON.
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupGetTokenRequestDeserializer(ObjectDeserializer<GetTokenRequest.Builder> op)`
`java.lang.String`	`username()`	API name: `username`

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<GetTokenRequest> _DESERIALIZER
  
  Json deserializer for GetTokenRequest
- _ENDPOINT
  
  public static final Endpoint<GetTokenRequest,GetTokenResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "security.get_token".
Method Details
- of
  
  public static GetTokenRequest of(java.util.function.Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn)
- grantType
  
  @Nullable public final AccessTokenGrantType grantType()
  
  API name: grant_type
- kerberosTicket
  
  @Nullable public final java.lang.String kerberosTicket()
  
  API name: kerberos_ticket
- password
  
  @Nullable public final java.lang.String password()
  
  API name: password
- refreshToken
  
  @Nullable public final java.lang.String refreshToken()
  
  API name: refresh_token
- scope
  
  @Nullable public final java.lang.String scope()
  
  API name: scope
- username
  
  @Nullable public final java.lang.String username()
  
  API name: username
- 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)
- setupGetTokenRequestDeserializer
  
  protected static void setupGetTokenRequestDeserializer(ObjectDeserializer<GetTokenRequest.Builder> op)