GetApiKeyRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.GetApiKeyRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class GetApiKeyRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GetApiKeyRequest.Builder
Builder for GetApiKeyRequest.

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 Endpoint<GetApiKeyRequest,GetApiKeyResponse,ElasticsearchError> ENDPOINT
Endpoint "security.get_api_key".

Constructor Summary

Constructors
Constructor	Description
`GetApiKeyRequest(GetApiKeyRequest.Builder builder)`
`GetApiKeyRequest(java.util.function.Function<GetApiKeyRequest.Builder,GetApiKeyRequest.Builder> fn)`

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`id()`	API key id of the API key to be retrieved
`java.lang.String`	`name()`	API key name of the API key to be retrieved
`java.lang.Boolean`	`owner()`	flag to query API keys owned by the currently authenticated user
`java.lang.String`	`realmName()`	realm name of the user who created this API key to be retrieved
`java.lang.String`	`username()`	user name of the user who created this API key to be retrieved

Methods inherited from class java.lang.Object

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

Field Details
- ENDPOINT
  
  public static final Endpoint<GetApiKeyRequest,GetApiKeyResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "security.get_api_key".
Constructor Details
- GetApiKeyRequest
  
  public GetApiKeyRequest(GetApiKeyRequest.Builder builder)
- GetApiKeyRequest
  
  public GetApiKeyRequest(java.util.function.Function<GetApiKeyRequest.Builder,GetApiKeyRequest.Builder> fn)
Method Details
- id
  
  @Nullable public java.lang.String id()
  
  API key id of the API key to be retrieved
  API name: id
- name
  
  @Nullable public java.lang.String name()
  
  API key name of the API key to be retrieved
  API name: name
- owner
  
  @Nullable public java.lang.Boolean owner()
  
  flag to query API keys owned by the currently authenticated user
  API name: owner
- realmName
  
  @Nullable public java.lang.String realmName()
  
  realm name of the user who created this API key to be retrieved
  API name: realm_name
- username
  
  @Nullable public java.lang.String username()
  
  user name of the user who created this API key to be retrieved
  API name: username