WARNING: Deprecated in 7.15.0.
The Java REST Client is deprecated in favor of the Java API Client.
Get Service Accounts API
editGet Service Accounts API
editGet Service Accounts Request
editRetrieving a service account can be performed by setting the namespace
and service-name on GetServiceAccountsRequest
:
final GetServiceAccountsRequest getServiceAccountsRequest = new GetServiceAccountsRequest("elastic", "fleet-server");
Retrieving service accounts belong to a namespace can be performed
by just setting the namespace on GetServiceAccountsRequest
:
final GetServiceAccountsRequest getServiceAccountsRequest = new GetServiceAccountsRequest("elastic");
Retrieving all service accounts can be performed without specifying
either namespace or service-name on GetServiceAccountsRequest
:
final GetServiceAccountsRequest getServiceAccountsRequest = new GetServiceAccountsRequest();
Synchronous execution
editWhen executing a GetServiceAccountsRequest
in the following manner, the client waits
for the GetServiceAccountsResponse
to be returned before continuing with code execution:
final GetServiceAccountsResponse getServiceAccountsResponse = client.security().getServiceAccounts(getServiceAccountsRequest, RequestOptions.DEFAULT);
Synchronous calls may throw an IOException
in case of either failing to
parse the REST response in the high-level REST client, the request times out
or similar cases where there is no response coming back from the server.
In cases where the server returns a 4xx
or 5xx
error code, the high-level
client tries to parse the response body error details instead and then throws
a generic ElasticsearchException
and adds the original ResponseException
as a
suppressed exception to it.
Asynchronous execution
editExecuting a GetServiceAccountsRequest
can also be done in an asynchronous fashion so that
the client can return directly. Users need to specify how the response or
potential failures will be handled by passing the request and a listener to the
asynchronous get-service-accounts method:
client.security().getServiceAccountsAsync(getServiceAccountsRequest, RequestOptions.DEFAULT, listener);
The asynchronous method does not block and returns immediately. Once it is
completed the ActionListener
is called back using the onResponse
method
if the execution successfully completed or using the onFailure
method if
it failed. Failure scenarios and expected exceptions are the same as in the
synchronous execution case.
A typical listener for get-service-accounts
looks like:
Get Service Accounts Response
editThe returned GetServiceAccountsResponse
allows getting information about the retrieved service accounts as follows.