SnapshotQuery

A Snapshot query is used to filter snapshots based on the filter information supplied. Snapshots can be filtered by supplying the following:
  • snapshot id - unique identifier of the snapshot
  • Created Date - from, before or between two dates
  • Expiry Date - from, before or between two dates
  • Snapshot fields - list of snapshot fields to match. see Snapshot#getFields()
If no expiry date is supplied for the query, only unexpired snapshots will be included within the results.

Further documentation.

SnapshotQuery Functions

setFields SnapshotQuery.setFields( snapshotFields ) Sets additional information to filter snapshots.
getFields SnapshotQuery.getFields( ) Returns a list of snapshot fields used to filter a snapshot.
setSearchCreatedDateFrom SnapshotQuery.setSearchCreatedDateFrom( date ) Query snapshots created starting from this date, used in conjunction with #setSearchCreatedDateTo(Date) to search between two dates.
getSearchCreatedDateFrom SnapshotQuery.getSearchCreatedDateFrom( ) Returns query from creation date.
setSearchCreatedDateTo SnapshotQuery.setSearchCreatedDateTo( date ) Query snapshots created up until this date, used in conjunction with #setSearchCreatedDateFrom(Date) to search between two dates.
getSearchCreatedDateTo SnapshotQuery.getSearchCreatedDateTo( ) Returns query to creation date
setSearchExpiryDateFrom SnapshotQuery.setSearchExpiryDateFrom( date ) Query snapshots which expire starting from this date, used in conjunction with #setSearchExpiryDateTo(Date) to search between two dates.
getSearchExpiryDateFrom SnapshotQuery.getSearchExpiryDateFrom( ) Returns query from expiry date.
setSearchExpiryDateTo SnapshotQuery.setSearchExpiryDateTo( date ) Query snapshots which expire up until this date, used in conjunction with #setSearchExpiryDateFrom(Date) to search between two dates.
getSearchExpiryDateTo SnapshotQuery.getSearchExpiryDateTo( ) Returns query to expiry date.
setSnapshotId SnapshotQuery.setSnapshotId( snapshotId ) Snapshot unique identifier
getSnapshotId SnapshotQuery.getSnapshotId( ) Returns the snapshot id.