- Java REST Client (deprecated): other versions:
- Overview
- Java Low Level REST Client
- Java High Level REST Client
- Getting started
- Document APIs
- Search APIs
- Miscellaneous APIs
- Indices APIs
- Analyze API
- Create Index API
- Delete Index API
- Indices Exists API
- Open Index API
- Close Index API
- Shrink Index API
- Split Index API
- Refresh API
- Flush API
- Flush Synced API
- Clear Cache API
- Force Merge API
- Rollover Index API
- Put Mapping API
- Get Mappings API
- Get Field Mappings API
- Index Aliases API
- Exists Alias API
- Get Alias API
- Update Indices Settings API
- Get Settings API
- Put Template API
- Validate Query API
- Get Templates API
- Templates Exist API
- Get Index API
- Freeze Index API
- Unfreeze Index API
- Delete Template API
- Cluster APIs
- Ingest APIs
- Snapshot APIs
- Tasks APIs
- Script APIs
- Licensing APIs
- Machine Learning APIs
- Put Job API
- Get Job API
- Delete Job API
- Open Job API
- Close Job API
- Update Job API
- Flush Job API
- Put Datafeed API
- Update Datafeed API
- Get Datafeed API
- Delete Datafeed API
- Preview Datafeed API
- Start Datafeed API
- Stop Datafeed API
- Get Datafeed Stats API
- Get Job Stats API
- Forecast Job API
- Delete Forecast API
- Get Buckets API
- Get Overall Buckets API
- Get Records API
- Post Data API
- Get Influencers API
- Get Categories API
- Get Calendars API
- Put Calendar API
- Get Calendar Events API
- Post Calendar Event API
- Delete Calendar Event API
- Put Calendar Job API
- Delete Calendar Job API
- Delete Calendar API
- Put Filter API
- Get Filters API
- Update Filter API
- Delete Filter API
- Get Model Snapshots API
- Delete Model Snapshot API
- Revert Model Snapshot API
- Update Model Snapshot API
- ML Get Info API
- Delete Expired Data API
- Set Upgrade Mode API
- Migration APIs
- Rollup APIs
- Security APIs
- Put User API
- Get Users API
- Delete User API
- Enable User API
- Disable User API
- Change Password API
- Put Role API
- Get Roles API
- Delete Role API
- Delete Privileges API
- Get Privileges API
- Clear Roles Cache API
- Clear Realm Cache API
- Authenticate API
- Has Privileges API
- Get User Privileges API
- SSL Certificate API
- Put Role Mapping API
- Get Role Mappings API
- Delete Role Mapping API
- Create Token API
- Invalidate Token API
- Put Privileges API
- Create API Key API
- Get API Key information API
- Invalidate API Key API
- Watcher APIs
- Graph APIs
- CCR APIs
- Index Lifecycle Management APIs
- Using Java Builders
- Migration Guide
- License
NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Start Trial
editStart Trial
editExecution
editThis API creates and enables a trial license using the startTrial()
method.
Response
editThe returned StartTrialResponse
returns a field indicating whether the
trial was started. If it was started, the response returns a the type of
license started. If it was not started, it returns an error message describing
why.
Acknowledgement messages may also be returned if this API was called without
the acknowledge
flag set to true
. In this case you need to display the
messages to the end user and if they agree, resubmit the request with the
acknowledge
flag set to true
. Please note that the response will still
return a 200 return code even if it requires an acknowledgement. So, it is
necessary to check the acknowledged
flag.
boolean acknowledged = response.isAcknowledged(); boolean trialWasStarted = response.isTrialWasStarted(); String licenseType = response.getLicenseType(); String errorMessage = response.getErrorMessage(); String acknowledgeHeader = response.getAcknowledgeHeader(); Map<String, String[]> acknowledgeMessages = response.getAcknowledgeMessages();
Whether or not the request had the |
|
Whether or not this request caused a trial to start |
|
If this request caused a trial to start, which type of license it registered |
|
If this request did not cause a trial to start, a message explaining why |
|
If the user’s request did not have the |
|
If the user’s request did not have the |
Asynchronous execution
editThis request can be executed asynchronously:
client.license().startTrialAsync(request, 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.
A typical listener for StartTrialResponse
looks like:
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now