Skip to content

Commit

Permalink
[API] Updates source code docs for snapshot.get
Browse files Browse the repository at this point in the history
  • Loading branch information
picandocodigo committed Oct 20, 2022
1 parent 13d3884 commit fd892b4
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ module Actions
# @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
# @option arguments [Boolean] :index_details Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
# @option arguments [Boolean] :include_repository Whether to include the repository name in the snapshot info. Defaults to true.
# @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)
# @option arguments [Integer] :size Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit.
# @option arguments [String] :order Sort order (options: asc, desc)
# @option arguments [String] :from_sort_value Value of the current sort column at which to start retrieval.
# @option arguments [String] :after Offset identifier to start pagination from as returned by the 'next' field in the response body.
# @option arguments [Integer] :offset Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0
# @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
# @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
# @option arguments [Hash] :headers Custom HTTP headers
#
Expand Down Expand Up @@ -64,6 +71,13 @@ def get(arguments = {})
:ignore_unavailable,
:index_details,
:include_repository,
:sort,
:size,
:order,
:from_sort_value,
:after,
:offset,
:slm_policy_filter,
:verbose
].freeze)
end
Expand Down

0 comments on commit fd892b4

Please sign in to comment.