The Get Influencers API retrieves one or more influencer results.
It accepts a GetInfluencersRequest object and responds
with a GetInfluencersResponse object.
Get Influencers Request
edit A GetInfluencersRequest object gets created with an existing non-null jobId.
GetInfluencersRequest request = new GetInfluencersRequest(jobId);
|
|
Constructing a new request referencing an existing jobId
|
The following arguments are optional:
request.setDescending(true);
|
|
If true, the influencers are sorted in descending order. Defaults to false.
|
request.setEnd("2018-08-21T00:00:00Z");
|
|
Influencers with timestamps earlier than this time will be returned.
|
request.setExcludeInterim(true);
|
|
If true, interim results will be excluded. Defaults to false.
|
request.setInfluencerScore(75.0);
|
|
Influencers with influencer_score greater or equal than this value will be returned.
|
request.setPageParams(new PageParams(100, 200));
|
|
The page parameters from and size. from specifies the number of influencers to skip.
size specifies the maximum number of influencers to get. Defaults to 0 and 100 respectively.
|
request.setSort("probability");
|
|
The field to sort influencers on. Defaults to influencer_score.
|
request.setStart("2018-08-01T00:00:00Z");
|
|
Influencers with timestamps on or after this time will be returned.
|
Synchronous Execution
edit When executing a GetInfluencersRequest in the following manner, the client waits
for the GetInfluencersResponse to be returned before continuing with code execution:
GetInfluencersResponse response = client.machineLearning().getInfluencers(request, RequestOptions.DEFAULT);
Asynchronous Execution
edit Executing a GetInfluencersRequest 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-influencers method:
client.machineLearning().getInfluencersAsync(request, RequestOptions.DEFAULT, listener);
|
|
The GetInfluencersRequest 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-influencers looks like:
ActionListener<GetInfluencersResponse> listener =
new ActionListener<GetInfluencersResponse>() {
@Override
public void onResponse(GetInfluencersResponse getInfluencersResponse) {
}
@Override
public void onFailure(Exception e) {
}
};
|
|
Called when the execution is successfully completed.
|
|
|
Called when the whole GetInfluencersRequest fails.
|
Get Influencers Response
edit The returned GetInfluencersResponse contains the requested influencers:
long count = response.count();
List<Influencer> influencers = response.influencers();
|
|
The count of influencers that were matched
|
|
|
The influencers retrieved
|