Get Categories API

edit

The Get Categories API retrieves one or more category results. It accepts a GetCategoriesRequest object and responds with a GetCategoriesResponse object.

Get Categories Request

edit

A GetCategoriesRequest object gets created with an existing non-null jobId.

GetCategoriesRequest request = new GetCategoriesRequest(jobId); 

Constructing a new request referencing an existing jobId

Optional Arguments

edit

The following arguments are optional:

request.setCategoryId(1L); 

The id of the category to get. Otherwise it will return all categories.

request.setPageParams(new PageParams(100, 200)); 

The page parameters from and size. from specifies the number of categories to skip. size specifies the maximum number of categories to get. Defaults to 0 and 100 respectively.

Synchronous Execution

edit

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 Execution

edit

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:

client.machineLearning().getCategoriesAsync(request, RequestOptions.DEFAULT, listener); 

The GetCategoriesRequest to execute and the ActionListener to use when the execution completes

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:

ActionListener<GetCategoriesResponse> listener =
        new ActionListener<GetCategoriesResponse>() {
            @Override
            public void onResponse(GetCategoriesResponse getcategoriesResponse) {
                
            }

            @Override
            public void onFailure(Exception e) {
                
            }
        };

Called when the execution is successfully completed.

Called when the whole GetCategoriesRequest fails.

Get Categories Response

edit

The returned GetCategoriesResponse contains the requested categories:

long count = response.count(); 
List<CategoryDefinition> categories = response.categories(); 

The count of categories that were matched

The categories retrieved