Class GetApiKeyRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetApiKeyRequest.Builder>
co.elastic.clients.elasticsearch.security.GetApiKeyRequest.Builder
- All Implemented Interfaces:
WithJson<GetApiKeyRequest.Builder>
,ObjectBuilder<GetApiKeyRequest>
- Enclosing class:
- GetApiKeyRequest
public static class GetApiKeyRequest.Builder
extends RequestBase.AbstractBuilder<GetApiKeyRequest.Builder>
implements ObjectBuilder<GetApiKeyRequest>
Builder for
GetApiKeyRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aGetApiKeyRequest
.final GetApiKeyRequest.Builder
API key id of the API key to be retrievedfinal GetApiKeyRequest.Builder
API key name of the API key to be retrievedfinal GetApiKeyRequest.Builder
flag to query API keys owned by the currently authenticated userfinal GetApiKeyRequest.Builder
realm name of the user who created this API key to be retrievedprotected GetApiKeyRequest.Builder
self()
final GetApiKeyRequest.Builder
user name of the user who created this API key to be retrievedMethods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
id
API key id of the API key to be retrievedAPI name:
id
-
name
API key name of the API key to be retrievedAPI name:
name
-
owner
flag to query API keys owned by the currently authenticated userAPI name:
owner
-
realmName
realm name of the user who created this API key to be retrievedAPI name:
realm_name
-
username
user name of the user who created this API key to be retrievedAPI name:
username
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetApiKeyRequest.Builder>
-
build
Builds aGetApiKeyRequest
.- Specified by:
build
in interfaceObjectBuilder<GetApiKeyRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-