Module org.elasticsearch.server
Interface SnapshotNamePredicate
public interface SnapshotNamePredicate
Represents a filter on snapshots by name, including some special values such as
_all and _current, as supported by
TransportGetSnapshotsAction.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final SnapshotNamePredicateASnapshotNamePredicatewhich matches all snapshots (and requires no specific names).static final SnapshotNamePredicateASnapshotNamePredicatewhich matches all currently-executing snapshots (and requires no specific names). -
Method Summary
Modifier and TypeMethodDescriptionstatic SnapshotNamePredicateforSnapshots(boolean ignoreUnavailable, String[] snapshots) boolean
-
Field Details
-
MATCH_ALL
ASnapshotNamePredicatewhich matches all snapshots (and requires no specific names). -
MATCH_CURRENT_ONLY
ASnapshotNamePredicatewhich matches all currently-executing snapshots (and requires no specific names).
-
-
Method Details
-
test
- Returns:
- Whether a snapshot with the given name should be selected.
-
requiredNames
Collection<String> requiredNames()- Returns:
- the snapshot names that must be present in a repository. If one of these snapshots is missing then this repository should
yield a
SnapshotMissingExceptionrather than any snapshots.
-
forSnapshots
- Returns:
- a
SnapshotNamePredicatefrom the givenGetSnapshotsRequestparameters.
-