Package co.elastic.clients.elasticsearch.security

Class ElasticsearchSecurityAsyncClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchSecurityAsyncClient>

co.elastic.clients.elasticsearch.security.ElasticsearchSecurityAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchSecurityAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSecurityAsyncClient>

Client for the security namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchSecurityAsyncClient(ElasticsearchTransport transport)
ElasticsearchSecurityAsyncClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AuthenticateResponse>	authenticate()	Enables authentication as a user and retrieve information about the authenticated user.
CompletableFuture<ChangePasswordResponse>	changePassword()	Changes the passwords of users in the native realm and built-in users.
CompletableFuture<ChangePasswordResponse>	changePassword(ChangePasswordRequest request)	Changes the passwords of users in the native realm and built-in users.
final CompletableFuture<ChangePasswordResponse>	changePassword(Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)	Changes the passwords of users in the native realm and built-in users.
CompletableFuture<ClearApiKeyCacheResponse>	clearApiKeyCache(ClearApiKeyCacheRequest request)	Clear a subset or all entries from the API key cache.
final CompletableFuture<ClearApiKeyCacheResponse>	clearApiKeyCache(Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn)	Clear a subset or all entries from the API key cache.
CompletableFuture<ClearCachedPrivilegesResponse>	clearCachedPrivileges(ClearCachedPrivilegesRequest request)	Evicts application privileges from the native application privileges cache.
final CompletableFuture<ClearCachedPrivilegesResponse>	clearCachedPrivileges(Function<ClearCachedPrivilegesRequest.Builder,ObjectBuilder<ClearCachedPrivilegesRequest>> fn)	Evicts application privileges from the native application privileges cache.
CompletableFuture<ClearCachedRealmsResponse>	clearCachedRealms(ClearCachedRealmsRequest request)	Evicts users from the user cache.
final CompletableFuture<ClearCachedRealmsResponse>	clearCachedRealms(Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn)	Evicts users from the user cache.
CompletableFuture<ClearCachedRolesResponse>	clearCachedRoles(ClearCachedRolesRequest request)	Evicts roles from the native role cache.
final CompletableFuture<ClearCachedRolesResponse>	clearCachedRoles(Function<ClearCachedRolesRequest.Builder,ObjectBuilder<ClearCachedRolesRequest>> fn)	Evicts roles from the native role cache.
CompletableFuture<ClearCachedServiceTokensResponse>	clearCachedServiceTokens(ClearCachedServiceTokensRequest request)	Evicts tokens from the service account token caches.
final CompletableFuture<ClearCachedServiceTokensResponse>	clearCachedServiceTokens(Function<ClearCachedServiceTokensRequest.Builder,ObjectBuilder<ClearCachedServiceTokensRequest>> fn)	Evicts tokens from the service account token caches.
CompletableFuture<CreateApiKeyResponse>	createApiKey()	Creates an API key for access without requiring basic authentication.
CompletableFuture<CreateApiKeyResponse>	createApiKey(CreateApiKeyRequest request)	Creates an API key for access without requiring basic authentication.
final CompletableFuture<CreateApiKeyResponse>	createApiKey(Function<CreateApiKeyRequest.Builder,ObjectBuilder<CreateApiKeyRequest>> fn)	Creates an API key for access without requiring basic authentication.
CompletableFuture<CreateServiceTokenResponse>	createServiceToken(CreateServiceTokenRequest request)	Creates a service account token for access without requiring basic authentication.
final CompletableFuture<CreateServiceTokenResponse>	createServiceToken(Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn)	Creates a service account token for access without requiring basic authentication.
CompletableFuture<DeletePrivilegesResponse>	deletePrivileges(DeletePrivilegesRequest request)	Removes application privileges.
final CompletableFuture<DeletePrivilegesResponse>	deletePrivileges(Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn)	Removes application privileges.
CompletableFuture<DeleteRoleResponse>	deleteRole(DeleteRoleRequest request)	Removes roles in the native realm.
final CompletableFuture<DeleteRoleResponse>	deleteRole(Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)	Removes roles in the native realm.
CompletableFuture<DeleteRoleMappingResponse>	deleteRoleMapping(DeleteRoleMappingRequest request)	Removes role mappings.
final CompletableFuture<DeleteRoleMappingResponse>	deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn)	Removes role mappings.
CompletableFuture<DeleteServiceTokenResponse>	deleteServiceToken(DeleteServiceTokenRequest request)	Deletes a service account token.
final CompletableFuture<DeleteServiceTokenResponse>	deleteServiceToken(Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn)	Deletes a service account token.
CompletableFuture<DeleteUserResponse>	deleteUser(DeleteUserRequest request)	Deletes users from the native realm.
final CompletableFuture<DeleteUserResponse>	deleteUser(Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn)	Deletes users from the native realm.
CompletableFuture<DisableUserResponse>	disableUser(DisableUserRequest request)	Disables users in the native realm.
final CompletableFuture<DisableUserResponse>	disableUser(Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn)	Disables users in the native realm.
CompletableFuture<EnableUserResponse>	enableUser(EnableUserRequest request)	Enables users in the native realm.
final CompletableFuture<EnableUserResponse>	enableUser(Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn)	Enables users in the native realm.
CompletableFuture<GetApiKeyResponse>	getApiKey()	Retrieves information for one or more API keys.
CompletableFuture<GetApiKeyResponse>	getApiKey(GetApiKeyRequest request)	Retrieves information for one or more API keys.
final CompletableFuture<GetApiKeyResponse>	getApiKey(Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn)	Retrieves information for one or more API keys.
CompletableFuture<GetBuiltinPrivilegesResponse>	getBuiltinPrivileges()	Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
CompletableFuture<GetPrivilegesResponse>	getPrivileges()	Retrieves application privileges.
CompletableFuture<GetPrivilegesResponse>	getPrivileges(GetPrivilegesRequest request)	Retrieves application privileges.
final CompletableFuture<GetPrivilegesResponse>	getPrivileges(Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn)	Retrieves application privileges.
CompletableFuture<GetRoleResponse>	getRole()	Retrieves roles in the native realm.
CompletableFuture<GetRoleResponse>	getRole(GetRoleRequest request)	Retrieves roles in the native realm.
final CompletableFuture<GetRoleResponse>	getRole(Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)	Retrieves roles in the native realm.
CompletableFuture<GetRoleMappingResponse>	getRoleMapping()	Retrieves role mappings.
CompletableFuture<GetRoleMappingResponse>	getRoleMapping(GetRoleMappingRequest request)	Retrieves role mappings.
final CompletableFuture<GetRoleMappingResponse>	getRoleMapping(Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)	Retrieves role mappings.
CompletableFuture<GetServiceAccountsResponse>	getServiceAccounts()	Retrieves information about service accounts.
CompletableFuture<GetServiceAccountsResponse>	getServiceAccounts(GetServiceAccountsRequest request)	Retrieves information about service accounts.
final CompletableFuture<GetServiceAccountsResponse>	getServiceAccounts(Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn)	Retrieves information about service accounts.
CompletableFuture<GetServiceCredentialsResponse>	getServiceCredentials(GetServiceCredentialsRequest request)	Retrieves information of all service credentials for a service account.
final CompletableFuture<GetServiceCredentialsResponse>	getServiceCredentials(Function<GetServiceCredentialsRequest.Builder,ObjectBuilder<GetServiceCredentialsRequest>> fn)	Retrieves information of all service credentials for a service account.
CompletableFuture<GetTokenResponse>	getToken()	Creates a bearer token for access without requiring basic authentication.
CompletableFuture<GetTokenResponse>	getToken(GetTokenRequest request)	Creates a bearer token for access without requiring basic authentication.
final CompletableFuture<GetTokenResponse>	getToken(Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn)	Creates a bearer token for access without requiring basic authentication.
CompletableFuture<GetUserResponse>	getUser()	Retrieves information about users in the native realm and built-in users.
CompletableFuture<GetUserResponse>	getUser(GetUserRequest request)	Retrieves information about users in the native realm and built-in users.
final CompletableFuture<GetUserResponse>	getUser(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)	Retrieves information about users in the native realm and built-in users.
CompletableFuture<GetUserPrivilegesResponse>	getUserPrivileges()	Retrieves security privileges for the logged in user.
CompletableFuture<GetUserPrivilegesResponse>	getUserPrivileges(GetUserPrivilegesRequest request)	Retrieves security privileges for the logged in user.
final CompletableFuture<GetUserPrivilegesResponse>	getUserPrivileges(Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)	Retrieves security privileges for the logged in user.
CompletableFuture<GrantApiKeyResponse>	grantApiKey(GrantApiKeyRequest request)	Creates an API key on behalf of another user.
final CompletableFuture<GrantApiKeyResponse>	grantApiKey(Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn)	Creates an API key on behalf of another user.
CompletableFuture<HasPrivilegesResponse>	hasPrivileges()	Determines whether the specified user has a specified list of privileges.
CompletableFuture<HasPrivilegesResponse>	hasPrivileges(HasPrivilegesRequest request)	Determines whether the specified user has a specified list of privileges.
final CompletableFuture<HasPrivilegesResponse>	hasPrivileges(Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn)	Determines whether the specified user has a specified list of privileges.
CompletableFuture<InvalidateApiKeyResponse>	invalidateApiKey()	Invalidates one or more API keys.
CompletableFuture<InvalidateApiKeyResponse>	invalidateApiKey(InvalidateApiKeyRequest request)	Invalidates one or more API keys.
final CompletableFuture<InvalidateApiKeyResponse>	invalidateApiKey(Function<InvalidateApiKeyRequest.Builder,ObjectBuilder<InvalidateApiKeyRequest>> fn)	Invalidates one or more API keys.
CompletableFuture<InvalidateTokenResponse>	invalidateToken()	Invalidates one or more access tokens or refresh tokens.
CompletableFuture<InvalidateTokenResponse>	invalidateToken(InvalidateTokenRequest request)	Invalidates one or more access tokens or refresh tokens.
final CompletableFuture<InvalidateTokenResponse>	invalidateToken(Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn)	Invalidates one or more access tokens or refresh tokens.
CompletableFuture<PutPrivilegesResponse>	putPrivileges()	Adds or updates application privileges.
CompletableFuture<PutPrivilegesResponse>	putPrivileges(PutPrivilegesRequest request)	Adds or updates application privileges.
final CompletableFuture<PutPrivilegesResponse>	putPrivileges(Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)	Adds or updates application privileges.
CompletableFuture<PutRoleResponse>	putRole(PutRoleRequest request)	Adds and updates roles in the native realm.
final CompletableFuture<PutRoleResponse>	putRole(Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn)	Adds and updates roles in the native realm.
CompletableFuture<PutRoleMappingResponse>	putRoleMapping(PutRoleMappingRequest request)	Creates and updates role mappings.
final CompletableFuture<PutRoleMappingResponse>	putRoleMapping(Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)	Creates and updates role mappings.
CompletableFuture<PutUserResponse>	putUser(PutUserRequest request)	Adds and updates users in the native realm.
final CompletableFuture<PutUserResponse>	putUser(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)	Adds and updates users in the native realm.
ElasticsearchSecurityAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchSecurityAsyncClient

public ElasticsearchSecurityAsyncClient(ElasticsearchTransport transport)

ElasticsearchSecurityAsyncClient

public ElasticsearchSecurityAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSecurityAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSecurityAsyncClient>

authenticate

public CompletableFuture<AuthenticateResponse> authenticate()

Enables authentication as a user and retrieve information about the authenticated user.

See Also:

• Documentation on elastic.co

changePassword

public CompletableFuture<ChangePasswordResponse> changePassword(ChangePasswordRequest request)

Changes the passwords of users in the native realm and built-in users.

See Also:

• Documentation on elastic.co

changePassword

public final CompletableFuture<ChangePasswordResponse> changePassword(Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)

Changes the passwords of users in the native realm and built-in users.

Parameters:

fn - a function that initializes a builder to create the ChangePasswordRequest

See Also:

• Documentation on elastic.co

changePassword

public CompletableFuture<ChangePasswordResponse> changePassword()

Changes the passwords of users in the native realm and built-in users.

See Also:

• Documentation on elastic.co

clearApiKeyCache

public CompletableFuture<ClearApiKeyCacheResponse> clearApiKeyCache(ClearApiKeyCacheRequest request)

Clear a subset or all entries from the API key cache.

See Also:

• Documentation on elastic.co

clearApiKeyCache

public final CompletableFuture<ClearApiKeyCacheResponse> clearApiKeyCache(Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn)

Clear a subset or all entries from the API key cache.

Parameters:

fn - a function that initializes a builder to create the ClearApiKeyCacheRequest

See Also:

• Documentation on elastic.co

clearCachedPrivileges

public CompletableFuture<ClearCachedPrivilegesResponse> clearCachedPrivileges(ClearCachedPrivilegesRequest request)

Evicts application privileges from the native application privileges cache.

See Also:

• Documentation on elastic.co

clearCachedPrivileges

public final CompletableFuture<ClearCachedPrivilegesResponse> clearCachedPrivileges(Function<ClearCachedPrivilegesRequest.Builder,ObjectBuilder<ClearCachedPrivilegesRequest>> fn)

Evicts application privileges from the native application privileges cache.

Parameters:

fn - a function that initializes a builder to create the ClearCachedPrivilegesRequest

See Also:

• Documentation on elastic.co

clearCachedRealms

public CompletableFuture<ClearCachedRealmsResponse> clearCachedRealms(ClearCachedRealmsRequest request)

Evicts users from the user cache. Can completely clear the cache or evict specific users.

See Also:

• Documentation on elastic.co

clearCachedRealms

public final CompletableFuture<ClearCachedRealmsResponse> clearCachedRealms(Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn)

Evicts users from the user cache. Can completely clear the cache or evict specific users.

Parameters:

fn - a function that initializes a builder to create the ClearCachedRealmsRequest

See Also:

• Documentation on elastic.co

clearCachedRoles

public CompletableFuture<ClearCachedRolesResponse> clearCachedRoles(ClearCachedRolesRequest request)

Evicts roles from the native role cache.

See Also:

• Documentation on elastic.co

clearCachedRoles

public final CompletableFuture<ClearCachedRolesResponse> clearCachedRoles(Function<ClearCachedRolesRequest.Builder,ObjectBuilder<ClearCachedRolesRequest>> fn)

Evicts roles from the native role cache.

Parameters:

fn - a function that initializes a builder to create the ClearCachedRolesRequest

See Also:

• Documentation on elastic.co

clearCachedServiceTokens

public CompletableFuture<ClearCachedServiceTokensResponse> clearCachedServiceTokens(ClearCachedServiceTokensRequest request)

Evicts tokens from the service account token caches.

See Also:

• Documentation on elastic.co

clearCachedServiceTokens

public final CompletableFuture<ClearCachedServiceTokensResponse> clearCachedServiceTokens(Function<ClearCachedServiceTokensRequest.Builder,ObjectBuilder<ClearCachedServiceTokensRequest>> fn)

Evicts tokens from the service account token caches.

Parameters:

fn - a function that initializes a builder to create the ClearCachedServiceTokensRequest

See Also:

• Documentation on elastic.co

createApiKey

public CompletableFuture<CreateApiKeyResponse> createApiKey(CreateApiKeyRequest request)

Creates an API key for access without requiring basic authentication.

See Also:

• Documentation on elastic.co

createApiKey

public final CompletableFuture<CreateApiKeyResponse> createApiKey(Function<CreateApiKeyRequest.Builder,ObjectBuilder<CreateApiKeyRequest>> fn)

Creates an API key for access without requiring basic authentication.

Parameters:

fn - a function that initializes a builder to create the CreateApiKeyRequest

See Also:

• Documentation on elastic.co

createApiKey

public CompletableFuture<CreateApiKeyResponse> createApiKey()

Creates an API key for access without requiring basic authentication.

See Also:

• Documentation on elastic.co

createServiceToken

public CompletableFuture<CreateServiceTokenResponse> createServiceToken(CreateServiceTokenRequest request)

Creates a service account token for access without requiring basic authentication.

See Also:

• Documentation on elastic.co

createServiceToken

public final CompletableFuture<CreateServiceTokenResponse> createServiceToken(Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn)

Creates a service account token for access without requiring basic authentication.

Parameters:

fn - a function that initializes a builder to create the CreateServiceTokenRequest

See Also:

• Documentation on elastic.co

deletePrivileges

public CompletableFuture<DeletePrivilegesResponse> deletePrivileges(DeletePrivilegesRequest request)

Removes application privileges.

See Also:

• Documentation on elastic.co

deletePrivileges

public final CompletableFuture<DeletePrivilegesResponse> deletePrivileges(Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn)

Removes application privileges.

Parameters:

fn - a function that initializes a builder to create the DeletePrivilegesRequest

See Also:

• Documentation on elastic.co

deleteRole

public CompletableFuture<DeleteRoleResponse> deleteRole(DeleteRoleRequest request)

Removes roles in the native realm.

See Also:

• Documentation on elastic.co

deleteRole

public final CompletableFuture<DeleteRoleResponse> deleteRole(Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)

Removes roles in the native realm.

Parameters:

fn - a function that initializes a builder to create the DeleteRoleRequest

See Also:

• Documentation on elastic.co

deleteRoleMapping

public CompletableFuture<DeleteRoleMappingResponse> deleteRoleMapping(DeleteRoleMappingRequest request)

Removes role mappings.

See Also:

• Documentation on elastic.co

deleteRoleMapping

public final CompletableFuture<DeleteRoleMappingResponse> deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn)

Removes role mappings.

Parameters:

fn - a function that initializes a builder to create the DeleteRoleMappingRequest

See Also:

• Documentation on elastic.co

deleteServiceToken

public CompletableFuture<DeleteServiceTokenResponse> deleteServiceToken(DeleteServiceTokenRequest request)

Deletes a service account token.

See Also:

• Documentation on elastic.co

deleteServiceToken

public final CompletableFuture<DeleteServiceTokenResponse> deleteServiceToken(Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn)

Deletes a service account token.

Parameters:

fn - a function that initializes a builder to create the DeleteServiceTokenRequest

See Also:

• Documentation on elastic.co

deleteUser

public CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest request)

Deletes users from the native realm.

See Also:

• Documentation on elastic.co

deleteUser

public final CompletableFuture<DeleteUserResponse> deleteUser(Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn)

Deletes users from the native realm.

Parameters:

fn - a function that initializes a builder to create the DeleteUserRequest

See Also:

• Documentation on elastic.co

disableUser

public CompletableFuture<DisableUserResponse> disableUser(DisableUserRequest request)

Disables users in the native realm.

See Also:

• Documentation on elastic.co

disableUser

public final CompletableFuture<DisableUserResponse> disableUser(Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn)

Disables users in the native realm.

Parameters:

fn - a function that initializes a builder to create the DisableUserRequest

See Also:

• Documentation on elastic.co

enableUser

public CompletableFuture<EnableUserResponse> enableUser(EnableUserRequest request)

Enables users in the native realm.

See Also:

• Documentation on elastic.co

enableUser

public final CompletableFuture<EnableUserResponse> enableUser(Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn)

Enables users in the native realm.

Parameters:

fn - a function that initializes a builder to create the EnableUserRequest

See Also:

• Documentation on elastic.co

getApiKey

public CompletableFuture<GetApiKeyResponse> getApiKey(GetApiKeyRequest request)

Retrieves information for one or more API keys.

See Also:

• Documentation on elastic.co

getApiKey

public final CompletableFuture<GetApiKeyResponse> getApiKey(Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn)

Retrieves information for one or more API keys.

Parameters:

fn - a function that initializes a builder to create the GetApiKeyRequest

See Also:

• Documentation on elastic.co

getApiKey

public CompletableFuture<GetApiKeyResponse> getApiKey()

Retrieves information for one or more API keys.

See Also:

• Documentation on elastic.co

getBuiltinPrivileges

public CompletableFuture<GetBuiltinPrivilegesResponse> getBuiltinPrivileges()

Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.

See Also:

• Documentation on elastic.co

getPrivileges

public CompletableFuture<GetPrivilegesResponse> getPrivileges(GetPrivilegesRequest request)

Retrieves application privileges.

See Also:

• Documentation on elastic.co

getPrivileges

public final CompletableFuture<GetPrivilegesResponse> getPrivileges(Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn)

Retrieves application privileges.

Parameters:

fn - a function that initializes a builder to create the GetPrivilegesRequest

See Also:

• Documentation on elastic.co

getPrivileges

public CompletableFuture<GetPrivilegesResponse> getPrivileges()

Retrieves application privileges.

See Also:

• Documentation on elastic.co

getRole

public CompletableFuture<GetRoleResponse> getRole(GetRoleRequest request)

Retrieves roles in the native realm.

See Also:

• Documentation on elastic.co

getRole

public final CompletableFuture<GetRoleResponse> getRole(Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)

Retrieves roles in the native realm.

Parameters:

fn - a function that initializes a builder to create the GetRoleRequest

See Also:

• Documentation on elastic.co

getRole

public CompletableFuture<GetRoleResponse> getRole()

Retrieves roles in the native realm.

See Also:

• Documentation on elastic.co

getRoleMapping

public CompletableFuture<GetRoleMappingResponse> getRoleMapping(GetRoleMappingRequest request)

Retrieves role mappings.

See Also:

• Documentation on elastic.co

getRoleMapping

public final CompletableFuture<GetRoleMappingResponse> getRoleMapping(Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)

Retrieves role mappings.

Parameters:

fn - a function that initializes a builder to create the GetRoleMappingRequest

See Also:

• Documentation on elastic.co

getRoleMapping

public CompletableFuture<GetRoleMappingResponse> getRoleMapping()

Retrieves role mappings.

See Also:

• Documentation on elastic.co

getServiceAccounts

public CompletableFuture<GetServiceAccountsResponse> getServiceAccounts(GetServiceAccountsRequest request)

Retrieves information about service accounts.

See Also:

• Documentation on elastic.co

getServiceAccounts

public final CompletableFuture<GetServiceAccountsResponse> getServiceAccounts(Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn)

Retrieves information about service accounts.

Parameters:

fn - a function that initializes a builder to create the GetServiceAccountsRequest

See Also:

• Documentation on elastic.co

getServiceAccounts

public CompletableFuture<GetServiceAccountsResponse> getServiceAccounts()

Retrieves information about service accounts.

See Also:

• Documentation on elastic.co

getServiceCredentials

public CompletableFuture<GetServiceCredentialsResponse> getServiceCredentials(GetServiceCredentialsRequest request)

Retrieves information of all service credentials for a service account.

See Also:

• Documentation on elastic.co

getServiceCredentials

public final CompletableFuture<GetServiceCredentialsResponse> getServiceCredentials(Function<GetServiceCredentialsRequest.Builder,ObjectBuilder<GetServiceCredentialsRequest>> fn)

Retrieves information of all service credentials for a service account.

Parameters:

fn - a function that initializes a builder to create the GetServiceCredentialsRequest

See Also:

• Documentation on elastic.co

getToken

public CompletableFuture<GetTokenResponse> getToken(GetTokenRequest request)

Creates a bearer token for access without requiring basic authentication.

See Also:

• Documentation on elastic.co

getToken

public final CompletableFuture<GetTokenResponse> getToken(Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn)

Creates a bearer token for access without requiring basic authentication.

Parameters:

fn - a function that initializes a builder to create the GetTokenRequest

See Also:

• Documentation on elastic.co

getToken

public CompletableFuture<GetTokenResponse> getToken()

Creates a bearer token for access without requiring basic authentication.

See Also:

• Documentation on elastic.co

getUser

public CompletableFuture<GetUserResponse> getUser(GetUserRequest request)

Retrieves information about users in the native realm and built-in users.

See Also:

• Documentation on elastic.co

getUser

public final CompletableFuture<GetUserResponse> getUser(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)

Retrieves information about users in the native realm and built-in users.

Parameters:

fn - a function that initializes a builder to create the GetUserRequest

See Also:

• Documentation on elastic.co

getUser

public CompletableFuture<GetUserResponse> getUser()

Retrieves information about users in the native realm and built-in users.

See Also:

• Documentation on elastic.co

getUserPrivileges

public CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges(GetUserPrivilegesRequest request)

Retrieves security privileges for the logged in user.

See Also:

• Documentation on elastic.co

getUserPrivileges

public final CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges(Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)

Retrieves security privileges for the logged in user.

Parameters:

fn - a function that initializes a builder to create the GetUserPrivilegesRequest

See Also:

• Documentation on elastic.co

getUserPrivileges

public CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges()

Retrieves security privileges for the logged in user.

See Also:

• Documentation on elastic.co

grantApiKey

public CompletableFuture<GrantApiKeyResponse> grantApiKey(GrantApiKeyRequest request)

Creates an API key on behalf of another user.

See Also:

• Documentation on elastic.co

grantApiKey

public final CompletableFuture<GrantApiKeyResponse> grantApiKey(Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn)

Creates an API key on behalf of another user.

Parameters:

fn - a function that initializes a builder to create the GrantApiKeyRequest

See Also:

• Documentation on elastic.co

hasPrivileges

public CompletableFuture<HasPrivilegesResponse> hasPrivileges(HasPrivilegesRequest request)

Determines whether the specified user has a specified list of privileges.

See Also:

• Documentation on elastic.co

hasPrivileges

public final CompletableFuture<HasPrivilegesResponse> hasPrivileges(Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn)

Determines whether the specified user has a specified list of privileges.

Parameters:

fn - a function that initializes a builder to create the HasPrivilegesRequest

See Also:

• Documentation on elastic.co

hasPrivileges

public CompletableFuture<HasPrivilegesResponse> hasPrivileges()

Determines whether the specified user has a specified list of privileges.

See Also:

• Documentation on elastic.co

invalidateApiKey

public CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey(InvalidateApiKeyRequest request)

Invalidates one or more API keys.

See Also:

• Documentation on elastic.co

invalidateApiKey

public final CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey(Function<InvalidateApiKeyRequest.Builder,ObjectBuilder<InvalidateApiKeyRequest>> fn)

Invalidates one or more API keys.

Parameters:

fn - a function that initializes a builder to create the InvalidateApiKeyRequest

See Also:

• Documentation on elastic.co

invalidateApiKey

public CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey()

Invalidates one or more API keys.

See Also:

• Documentation on elastic.co

invalidateToken

public CompletableFuture<InvalidateTokenResponse> invalidateToken(InvalidateTokenRequest request)

Invalidates one or more access tokens or refresh tokens.

See Also:

• Documentation on elastic.co

invalidateToken

public final CompletableFuture<InvalidateTokenResponse> invalidateToken(Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn)

Invalidates one or more access tokens or refresh tokens.

Parameters:

fn - a function that initializes a builder to create the InvalidateTokenRequest

See Also:

• Documentation on elastic.co

invalidateToken

public CompletableFuture<InvalidateTokenResponse> invalidateToken()

Invalidates one or more access tokens or refresh tokens.

See Also:

• Documentation on elastic.co

putPrivileges

public CompletableFuture<PutPrivilegesResponse> putPrivileges(PutPrivilegesRequest request)

Adds or updates application privileges.

See Also:

• Documentation on elastic.co

putPrivileges

public final CompletableFuture<PutPrivilegesResponse> putPrivileges(Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)

Adds or updates application privileges.

Parameters:

fn - a function that initializes a builder to create the PutPrivilegesRequest

See Also:

• Documentation on elastic.co

putPrivileges

public CompletableFuture<PutPrivilegesResponse> putPrivileges()

Adds or updates application privileges.

See Also:

• Documentation on elastic.co

putRole

public CompletableFuture<PutRoleResponse> putRole(PutRoleRequest request)

Adds and updates roles in the native realm.

See Also:

• Documentation on elastic.co

putRole

public final CompletableFuture<PutRoleResponse> putRole(Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn)

Adds and updates roles in the native realm.

Parameters:

fn - a function that initializes a builder to create the PutRoleRequest

See Also:

• Documentation on elastic.co

putRoleMapping

public CompletableFuture<PutRoleMappingResponse> putRoleMapping(PutRoleMappingRequest request)

Creates and updates role mappings.

See Also:

• Documentation on elastic.co

putRoleMapping

public final CompletableFuture<PutRoleMappingResponse> putRoleMapping(Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)

Creates and updates role mappings.

Parameters:

fn - a function that initializes a builder to create the PutRoleMappingRequest

See Also:

• Documentation on elastic.co

putUser

public CompletableFuture<PutUserResponse> putUser(PutUserRequest request)

Adds and updates users in the native realm. These users are commonly referred to as native users.

See Also:

• Documentation on elastic.co

putUser

public final CompletableFuture<PutUserResponse> putUser(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)

Adds and updates users in the native realm. These users are commonly referred to as native users.

Parameters:

fn - a function that initializes a builder to create the PutUserRequest

See Also:

• Documentation on elastic.co