ApiKey.Builder (java-client 7.15.1 API)

java.lang.Object

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

All Implemented Interfaces:: ObjectBuilder<ApiKey>

Enclosing class:: ApiKey

public static class ApiKey.Builder
extends java.lang.Object
implements ObjectBuilder<ApiKey>

Builder for ApiKey.

Constructor Summary

Constructors

Constructor Description

Builder()

Method Summary

Modifier and Type	Method	Description
`ApiKey.Builder`	`addRoleDescriptors(java.util.Map<java.lang.String,JsonData> value)`	Add a value to `roleDescriptors(List)`, creating the list if needed.
`ApiKey`	`build()`	Builds a `ApiKey`.
`ApiKey.Builder`	`expiration(java.lang.String value)`	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>> value)`	API name: `role_descriptors`
`ApiKey.Builder`	`roleDescriptors(java.util.Map<java.lang.String,JsonData>... value)`	API name: `role_descriptors`

Methods inherited from class java.lang.Object

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

Constructor Details
- Builder
  
  public Builder()
Method Details
- name
  
  public ApiKey.Builder name(java.lang.String value)
  
  Required - API name: name
- expiration
  
  public ApiKey.Builder expiration(@Nullable java.lang.String value)
  
  API name: expiration
- roleDescriptors
  
  public ApiKey.Builder roleDescriptors(@Nullable java.util.List<java.util.Map<java.lang.String,JsonData>> value)
  
  API name: role_descriptors
- roleDescriptors
  
  public ApiKey.Builder roleDescriptors(java.util.Map<java.lang.String,JsonData>... value)
  
  API name: role_descriptors
- addRoleDescriptors
  
  public ApiKey.Builder addRoleDescriptors(java.util.Map<java.lang.String,JsonData> value)
  
  Add a value to roleDescriptors(List), creating the list if needed.
- 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.