Get Categories APIedit
The Get Categories API retrieves one or more category results.
It accepts a GetCategoriesRequest
object and responds
with a GetCategoriesResponse
object.
Get Categories Requestedit
A GetCategoriesRequest
object gets created with an existing non-null jobId
.
Optional Argumentsedit
The following arguments are optional:
Synchronous Executionedit
When executing a GetCategoriesRequest
in the following manner, the client waits
for the GetCategoriesResponse
to be returned before continuing with code execution:
GetCategoriesResponse response = client.machineLearning().getCategories(request, RequestOptions.DEFAULT);
Asynchronous Executionedit
Executing a GetCategoriesRequest
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-categories method:
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.
A typical listener for get-categories
looks like:
Get Categories Responseedit
The returned GetCategoriesResponse
contains the requested categories: