Package co.elastic.clients.elasticsearch.snapshot

Class GetSnapshotRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.snapshot.GetSnapshotRequest
public class GetSnapshotRequest extends RequestBase
Get snapshot information.
See Also:

  • Field Details

  • Method Details

    • of

      public static GetSnapshotRequest of(Function<GetSnapshotRequest.Builder,ObjectBuilder<GetSnapshotRequest>> fn)

    • after

      @Nullable public final String after()
      Offset identifier to start pagination from as returned by the next field in the response body.

      API name: after

    • fromSortValue

      @Nullable public final String fromSortValue()
      Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count.

      API name: from_sort_value

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error for any snapshots that are unavailable.

      API name: ignore_unavailable

    • includeRepository

      @Nullable public final Boolean includeRepository()
      If true, returns the repository name in each snapshot.

      API name: include_repository

    • indexDetails

      @Nullable public final Boolean indexDetails()
      If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted.

      API name: index_details

    • indexNames

      @Nullable public final Boolean indexNames()
      If true, returns the name of each index in each snapshot.

      API name: index_names

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • offset

      @Nullable public final Integer offset()
      Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.

      API name: offset

    • order

      @Nullable public final SortOrder order()
      Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order.

      API name: order

    • repository

      public final String repository()
      Required - Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.

      API name: repository

    • size

      @Nullable public final Integer size()
      Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit.

      API name: size

    • slmPolicyFilter

      @Nullable public final String slmPolicyFilter()
      Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy.

      API name: slm_policy_filter

    • snapshot

      public final List<String> snapshot()
      Required - Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*).
      • To get information about all snapshots in a registered repository, use a wildcard (*) or _all.
      • To get information about any snapshots that are currently running, use _current.

      API name: snapshot

    • sort

      @Nullable public final SnapshotSort sort()
      Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp.

      API name: sort

    • verbose

      @Nullable public final Boolean verbose()
      If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.

      API name: verbose