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.grant_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`	`expiration(Time value)`	API name: `expiration`
`ApiKey.Builder`	`expiration(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)`	API name: `expiration`
`ApiKey.Builder`	`name(java.lang.String value)`	Required - API name: `name`
`ApiKey.Builder`	`roleDescriptors(java.util.List<java.util.Map<java.lang.String,JsonData>> list)`	API name: `role_descriptors`
`ApiKey.Builder`	`roleDescriptors(java.util.Map<java.lang.String,JsonData> value, java.util.Map<java.lang.String,JsonData>... values)`	API name: `role_descriptors`
`protected ApiKey.Builder`	`self()`

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
- name
  
  public final ApiKey.Builder name(java.lang.String value)
  
  Required - API name: name
- expiration
  
  public final ApiKey.Builder expiration(@Nullable Time value)
  
  API name: expiration
- expiration
  
  public final ApiKey.Builder expiration(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
  
  API name: expiration
- roleDescriptors
  
  public final ApiKey.Builder roleDescriptors(java.util.List<java.util.Map<java.lang.String,JsonData>> list)
  
  API name: role_descriptors
  Adds all elements of list to roleDescriptors.
- roleDescriptors
  
  public final ApiKey.Builder roleDescriptors(java.util.Map<java.lang.String,JsonData> value, java.util.Map<java.lang.String,JsonData>... values)
  
  API name: role_descriptors
  Adds one or more values to roleDescriptors.
- 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.