ApiKey.Builder (java-client 7.17.5 API)

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<ApiKey.Builder>

co.elastic.clients.elasticsearch.security.get_api_key.ApiKey.Builder

All Implemented Interfaces:: WithJson<ApiKey.Builder>, ObjectBuilder<ApiKey>

Enclosing class:: ApiKey

public static class ApiKey.Builder
extends WithJsonObjectBuilderBase<ApiKey.Builder>
implements ObjectBuilder<ApiKey>

Builder for ApiKey.

Constructor Summary

Constructors

Constructor Description

Builder()

Method Summary

Modifier and Type	Method	Description
`ApiKey`	`build()`	Builds a `ApiKey`.
`ApiKey.Builder`	`creation(long value)`	Required - API name: `creation`
`ApiKey.Builder`	`expiration(java.lang.Long value)`	API name: `expiration`
`ApiKey.Builder`	`id(java.lang.String value)`	Required - API name: `id`
`ApiKey.Builder`	`invalidated(boolean value)`	Required - API name: `invalidated`
`ApiKey.Builder`	`metadata(java.lang.String key, JsonData value)`	API name: `metadata`
`ApiKey.Builder`	`metadata(java.util.Map<java.lang.String,JsonData> map)`	API name: `metadata`
`ApiKey.Builder`	`name(java.lang.String value)`	Required - API name: `name`
`ApiKey.Builder`	`realm(java.lang.String value)`	Required - API name: `realm`
`protected ApiKey.Builder`	`self()`
`ApiKey.Builder`	`username(java.lang.String value)`	Required - API name: `username`

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details
- Builder
  
  public Builder()
Method Details
- creation
  
  public final ApiKey.Builder creation(long value)
  
  Required - API name: creation
- expiration
  
  public final ApiKey.Builder expiration(@Nullable java.lang.Long value)
  
  API name: expiration
- id
  
  public final ApiKey.Builder id(java.lang.String value)
  
  Required - API name: id
- invalidated
  
  public final ApiKey.Builder invalidated(boolean value)
  
  Required - API name: invalidated
- name
  
  public final ApiKey.Builder name(java.lang.String value)
  
  Required - API name: name
- realm
  
  public final ApiKey.Builder realm(java.lang.String value)
  
  Required - API name: realm
- username
  
  public final ApiKey.Builder username(java.lang.String value)
  
  Required - API name: username
- metadata
  
  public final ApiKey.Builder metadata(java.util.Map<java.lang.String,JsonData> map)
  
  API name: metadata
  Adds all entries of map to metadata.
- metadata
  
  public final ApiKey.Builder metadata(java.lang.String key, JsonData value)
  
  API name: metadata
  Adds an entry to metadata.
- self
  
  protected ApiKey.Builder self()
  
  Specified by:
  
  self in class WithJsonObjectBuilderBase<ApiKey.Builder>
- build
  
  public ApiKey build()
  
  Builds a ApiKey.
  
  Specified by:
  
  build in interface ObjectBuilder<ApiKey>
  
  Throws:
  
  java.lang.NullPointerException - if some of the required fields are null.