- Java REST Client (deprecated): other versions:
- Overview
- Java Low Level REST Client
- Java High Level REST Client
- Getting started
- Document APIs
- Search APIs
- Async Search APIs
- Miscellaneous APIs
- Index APIs
- Analyze API
- Create Index API
- Delete Index API
- Index Exists API
- Open Index API
- Close Index API
- Shrink Index API
- Split Index API
- Clone 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
- Delete Alias 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
- Reload Search Analyzers API
- Get Composable Index Templates API
- Put Composable Index Template API
- Delete Composable Index Template API
- Optional arguments
- Simulate Index Template API
- Cluster APIs
- Ingest APIs
- Snapshot APIs
- Tasks APIs
- Script APIs
- Licensing APIs
- Machine Learning APIs
- Put anomaly detection job API
- Get anomaly detection jobs API
- Delete anomaly detection job API
- Open anomaly detection job API
- Close anomaly detection job API
- Update anomaly detection 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 anomaly detection 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 anomaly detection jobs in calendar API
- Delete anomaly detection jobs from calendar API
- Delete calendar API
- Estimate anomaly detection job model memory API
- Get data frame analytics jobs API
- Get data frame analytics jobs stats API
- Put data frame analytics jobs API
- Delete data frame analytics jobs API
- Start data frame analytics jobs API
- Stop data frame analytics jobs API
- Evaluate data frame analytics API
- Explain data frame analytics API
- Get trained models API
- Put trained model API
- Get trained models stats API
- Delete trained model 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 Builtin 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
- Snapshot Lifecycle Management APIs
- Put Snapshot Lifecycle Policy API
- Delete Snapshot Lifecycle Policy API
- Get Snapshot Lifecycle Policy API
- Start Snapshot Lifecycle Management API
- Stop Snapshot Lifecycle Management API
- Snapshot Lifecycle Management Status API
- Execute Snapshot Lifecycle Policy API
- Execute Snapshot Lifecycle Retention API
- Transform APIs
- Enrich APIs
- Using Java Builders
- Migration Guide
- License
Get Rollup Index Capabilities API
editGet Rollup Index Capabilities API
editThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
The Get Rollup Index Capabilities API allows the user to determine if a concrete index or index pattern contains
stored rollup jobs and data. If it contains data stored from rollup jobs, the capabilities of those jobs
are returned. The API accepts a GetRollupIndexCapsRequest
object as a request and returns a GetRollupIndexCapsResponse
.
Get Rollup Index Capabilities Request
editA GetRollupIndexCapsRequest
requires a single parameter: the target index or index pattern (e.g. rollup-foo
):
GetRollupIndexCapsRequest getRollupIndexCapsRequest = new GetRollupIndexCapsRequest("rollup");
Execution
editThe Get Rollup Index Capabilities API can be executed through a RollupClient
instance. Such instance can be retrieved from a RestHighLevelClient
using the rollup()
method:
GetRollupIndexCapsResponse capsResponse = client.rollup() .getRollupIndexCapabilities(getRollupIndexCapsRequest, RequestOptions.DEFAULT);
Response
editThe returned GetRollupIndexCapsResponse
holds lists and maps of values which correspond to the capabilities
of the rollup index/index pattern (what jobs are stored in the index, their capabilities, what
aggregations are available, etc). Because multiple jobs can be stored in one index, the
response may include several jobs with different configurations.
The capabilities are essentially the same as the original job configuration, just presented in a different manner. For example, if we had created a job with the following config:
final String indexPattern = "docs"; final String rollupIndexName = "rollup"; final String cron = "*/1 * * * * ?"; final int pageSize = 100; final TimeValue timeout = null; String id = "job_1"; RollupJobConfig config = new RollupJobConfig(id, indexPattern, rollupIndexName, cron, pageSize, groups, metrics, timeout); PutRollupJobRequest request = new PutRollupJobRequest(config); AcknowledgedResponse response = client.rollup().putRollupJob(request, RequestOptions.DEFAULT); boolean acknowledged = response.isAcknowledged();
The GetRollupIndexCapsResponse
object would contain the same information, laid out in a slightly different manner:
Map<String, RollableIndexCaps> rolledPatterns = capsResponse.getJobs(); RollableIndexCaps docsPattern = rolledPatterns.get("rollup"); // indexName will be "rollup", the target index we requested String indexName = docsPattern.getIndexName(); // Each index pattern can have multiple jobs that rolled it up, sogetJobCaps()
// returns a list of jobs that rolled up the pattern List<RollupJobCaps> rollupJobs = docsPattern.getJobCaps(); RollupJobCaps jobCaps = rollupJobs.get(0); // jobID is the identifier we used when we created the job (e.g.job1
) String jobID = jobCaps.getJobID(); // rollupIndex is the location that the job stored it's rollup docs (e.g.rollup
) String rollupIndex = jobCaps.getRollupIndex(); // Finally, fieldCaps are the capabilities of individual fields in the config // The key is the field name, and the value is a RollupFieldCaps object which // provides more info. Map<String, RollupJobCaps.RollupFieldCaps> fieldCaps = jobCaps.getFieldCaps(); // If we retrieve the "timestamp" field, it returns a list of maps. Each list // item represents a different aggregation that can be run against the "timestamp" // field, and any additional details specific to that agg (interval, etc) List<Map<String, Object>> timestampCaps = fieldCaps.get("timestamp").getAggs(); logger.error(timestampCaps.get(0).toString()); assert timestampCaps.get(0).toString().equals("{agg=date_histogram, fixed_interval=1h, delay=7d, time_zone=UTC}"); // In contrast to the timestamp field, the temperature field has multiple aggs configured List<Map<String, Object>> temperatureCaps = fieldCaps.get("temperature").getAggs(); assert temperatureCaps.toString().equals("[{agg=min}, {agg=max}, {agg=sum}]");
Asynchronous Execution
editThis request can be executed asynchronously:
client.rollup().getRollupIndexCapabilitiesAsync(getRollupIndexCapsRequest, 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 GetRollupIndexCapsResponse
looks like: