Skip to content

Commit fd892b4

Browse files
committed
[API] Updates source code docs for snapshot.get
1 parent 13d3884 commit fd892b4

File tree

1 file changed

+14
-0
lines changed
  • elasticsearch-api/lib/elasticsearch/api/actions/snapshot

1 file changed

+14
-0
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb

+14
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ module Actions
2727
# @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
2828
# @option arguments [Boolean] :index_details Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
2929
# @option arguments [Boolean] :include_repository Whether to include the repository name in the snapshot info. Defaults to true.
30+
# @option arguments [String] :sort Allows setting a sort order for the result. Defaults to start_time (options: start_time, duration, name, repository, index_count, shard_count, failed_shard_count)
31+
# @option arguments [Integer] :size Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit.
32+
# @option arguments [String] :order Sort order (options: asc, desc)
33+
# @option arguments [String] :from_sort_value Value of the current sort column at which to start retrieval.
34+
# @option arguments [String] :after Offset identifier to start pagination from as returned by the 'next' field in the response body.
35+
# @option arguments [Integer] :offset Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0
36+
# @option arguments [String] :slm_policy_filter Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy
3037
# @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
3138
# @option arguments [Hash] :headers Custom HTTP headers
3239
#
@@ -64,6 +71,13 @@ def get(arguments = {})
6471
:ignore_unavailable,
6572
:index_details,
6673
:include_repository,
74+
:sort,
75+
:size,
76+
:order,
77+
:from_sort_value,
78+
:after,
79+
:offset,
80+
:slm_policy_filter,
6781
:verbose
6882
].freeze)
6983
end

0 commit comments

Comments
 (0)