- 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.
Create Snapshot API
editCreate Snapshot API
editUse the Create Snapshot API to create a new snapshot.
Create Snapshot Request
editA CreateSnapshotRequest
:
CreateSnapshotRequest request = new CreateSnapshotRequest();
Required Arguments
editThe following arguments are mandatory:
Optional Arguments
editThe following arguments are optional:
Set |
Set |
Timeout to connect to the master node as a |
|
Timeout to connect to the master node as a |
Synchronous Execution
editExecute a CreateSnapshotRequest
synchronously to receive a CreateSnapshotResponse
.
CreateSnapshotResponse response = client.snapshot().create(request, RequestOptions.DEFAULT);
Retrieve the SnapshotInfo
from a CreateSnapshotResponse
when the snapshot is fully created.
(The waitForCompletion
parameter is true
).
Asynchronous Execution
editThe asynchronous execution of a create snapshot request requires both the
CreateSnapshotRequest
instance and an ActionListener
instance to be
passed as arguments to the asynchronous method:
The asynchronous method does not block and returns immediately. Once it is
completed the ActionListener
is called back with the onResponse
method
if the execution is successful or the onFailure
method if the execution
failed.
A typical listener for CreateSnapshotResponse
looks like:
Snapshot Create Response
editUse the CreateSnapshotResponse
to retrieve information about the evaluated
request:
On this page