Package co.elastic.clients.elasticsearch.snapshot

Class GetSnapshotRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetSnapshotRequest.Builder>
co.elastic.clients.elasticsearch.snapshot.GetSnapshotRequest.Builder
All Implemented Interfaces:
WithJson<GetSnapshotRequest.Builder>, ObjectBuilder<GetSnapshotRequest>
Enclosing class:
GetSnapshotRequest
public static class GetSnapshotRequest.Builder extends RequestBase.AbstractBuilder<GetSnapshotRequest.Builder> implements ObjectBuilder<GetSnapshotRequest>
Builder for GetSnapshotRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • after

      public final GetSnapshotRequest.Builder after(@Nullable String value)
      An offset identifier to start pagination from as returned by the next field in the response body.

      API name: after

    • fromSortValue

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

      API name: from_sort_value

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • includeRepository

      public final GetSnapshotRequest.Builder includeRepository(@Nullable Boolean value)
      If true, the response includes the repository name in each snapshot.

      API name: include_repository

    • indexDetails

      public final GetSnapshotRequest.Builder indexDetails(@Nullable Boolean value)
      If true, the response includes 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. The default is false, meaning that this information is omitted.

      API name: index_details

    • indexNames

      public final GetSnapshotRequest.Builder indexNames(@Nullable Boolean value)
      If true, the response includes the name of each index in each snapshot.

      API name: index_names

    • masterTimeout

      public final GetSnapshotRequest.Builder masterTimeout(@Nullable Time value)
      The 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

    • masterTimeout

      public final GetSnapshotRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The 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

      public final GetSnapshotRequest.Builder offset(@Nullable Integer value)
      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

      public final GetSnapshotRequest.Builder order(@Nullable SortOrder value)
      The sort order. Valid values are asc for ascending and desc for descending order. The default behavior is ascending order.

      API name: order

    • repository

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

      API name: repository

    • size

      public final GetSnapshotRequest.Builder size(@Nullable Integer value)
      The maximum number of snapshots to return. The default is 0, which means to return all that match the request without limit.

      API name: size

    • slmPolicyFilter

      public final GetSnapshotRequest.Builder slmPolicyFilter(@Nullable String value)
      Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.

      You can use wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. For example, the pattern *,-policy-a-\* will return all snapshots except for those that were created by an SLM policy with a name starting with policy-a-. Note that the wildcard pattern * matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy. To include snapshots that were 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 GetSnapshotRequest.Builder snapshot(List<String> list)
      Required - A comma-separated list of snapshot names to retrieve Wildcards (*) are supported.
      • 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

      Adds all elements of list to snapshot.

    • snapshot

      public final GetSnapshotRequest.Builder snapshot(String value, String... values)
      Required - A comma-separated list of snapshot names to retrieve Wildcards (*) are supported.
      • 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

      Adds one or more values to snapshot.

    • sort

      public final GetSnapshotRequest.Builder sort(@Nullable SnapshotSort value)
      The sort order for the result. The default behavior is sorting by snapshot start time stamp.

      API name: sort

    • state

      public final GetSnapshotRequest.Builder state(List<SnapshotState> list)
      Only return snapshots with a state found in the given comma-separated list of snapshot states. The default is all snapshot states.

      API name: state

      Adds all elements of list to state.

    • state

      public final GetSnapshotRequest.Builder state(SnapshotState value, SnapshotState... values)
      Only return snapshots with a state found in the given comma-separated list of snapshot states. The default is all snapshot states.

      API name: state

      Adds one or more values to state.

    • verbose

      public final GetSnapshotRequest.Builder verbose(@Nullable Boolean value)
      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.

      NOTE: The parameters size, order, after, from_sort_value, offset, slm_policy_filter, and sort are not supported when you set verbose=false and the sort order for requests with verbose=false is undefined.

      API name: verbose

    • self

      protected GetSnapshotRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<GetSnapshotRequest.Builder>

    • build

      public GetSnapshotRequest build()
      Builds a GetSnapshotRequest.
      Specified by:
      build in interface ObjectBuilder<GetSnapshotRequest>
      Throws:
      NullPointerException - if some of the required fields are null.