Package co.elastic.clients.elasticsearch.security

Class InvalidateApiKeyRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<InvalidateApiKeyRequest.Builder>

co.elastic.clients.elasticsearch.security.InvalidateApiKeyRequest.Builder

All Implemented Interfaces:

WithJson<InvalidateApiKeyRequest.Builder>, ObjectBuilder<InvalidateApiKeyRequest>

Enclosing class:

InvalidateApiKeyRequest

public static class InvalidateApiKeyRequest.Builder
extends RequestBase.AbstractBuilder<InvalidateApiKeyRequest.Builder>
implements ObjectBuilder<InvalidateApiKeyRequest>

Builder for InvalidateApiKeyRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InvalidateApiKeyRequest	build()	Builds a InvalidateApiKeyRequest.
final InvalidateApiKeyRequest.Builder	id(String value)	API name: id
final InvalidateApiKeyRequest.Builder	ids(String value, String... values)	A list of API key ids.
final InvalidateApiKeyRequest.Builder	ids(List<String> list)	A list of API key ids.
final InvalidateApiKeyRequest.Builder	name(String value)	An API key name.
final InvalidateApiKeyRequest.Builder	owner(Boolean value)	Query API keys owned by the currently authenticated user.
final InvalidateApiKeyRequest.Builder	realmName(String value)	The name of an authentication realm.
protected InvalidateApiKeyRequest.Builder	self()
final InvalidateApiKeyRequest.Builder	username(String value)	The username of a user.

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

id

public final InvalidateApiKeyRequest.Builder id(@Nullable
 String value)

API name: id

ids

public final InvalidateApiKeyRequest.Builder ids(List<String> list)

A list of API key ids. This parameter cannot be used with any of name, realm_name, or username.

API name: ids

Adds all elements of list to ids.

ids

public final InvalidateApiKeyRequest.Builder ids(String value,
 String... values)

A list of API key ids. This parameter cannot be used with any of name, realm_name, or username.

API name: ids

Adds one or more values to ids.

name

public final InvalidateApiKeyRequest.Builder name(@Nullable
 String value)

An API key name. This parameter cannot be used with any of ids, realm_name or username.

API name: name

owner

public final InvalidateApiKeyRequest.Builder owner(@Nullable
 Boolean value)

Query API keys owned by the currently authenticated user. The realm_name or username parameters cannot be specified when this parameter is set to true as they are assumed to be the currently authenticated ones.

NOTE: At least one of ids, name, username, and realm_name must be specified if owner is false.

API name: owner

realmName

public final InvalidateApiKeyRequest.Builder realmName(@Nullable
 String value)

The name of an authentication realm. This parameter cannot be used with either ids or name, or when owner flag is set to true.

API name: realm_name

username

public final InvalidateApiKeyRequest.Builder username(@Nullable
 String value)

The username of a user. This parameter cannot be used with either ids or name or when owner flag is set to true.

API name: username

self

protected InvalidateApiKeyRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<InvalidateApiKeyRequest.Builder>

build

public InvalidateApiKeyRequest build()

Builds a InvalidateApiKeyRequest.

Specified by:

build in interface ObjectBuilder<InvalidateApiKeyRequest>

Throws:

NullPointerException - if some of the required fields are null.