Package co.elastic.clients.elasticsearch.cat

Class SnapshotsRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bytes

      public final SnapshotsRequest.Builder bytes(@Nullable Bytes value)
      Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      API name: bytes

    • h

      public final SnapshotsRequest.Builder h(List<String> list)
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

      Adds all elements of list to h.

    • h

      public final SnapshotsRequest.Builder h(String value, String... values)
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

      Adds one or more values to h.

    • h

      public final SnapshotsRequest.Builder h(CatSnapshotsColumn value, CatSnapshotsColumn... values)
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

      Adds one or more enum values to h.

    • ignoreUnavailable

      public final SnapshotsRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If true, the response does not include information from unavailable snapshots.

      API name: ignore_unavailable

    • masterTimeout

      public final SnapshotsRequest.Builder masterTimeout(@Nullable Time value)
      Period to wait for a connection to the master node.

      API name: master_timeout

    • masterTimeout

      public final SnapshotsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Period to wait for a connection to the master node.

      API name: master_timeout

    • repository

      public final SnapshotsRequest.Builder repository(List<String> list)
      A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.

      API name: repository

      Adds all elements of list to repository.

    • repository

      public final SnapshotsRequest.Builder repository(String value, String... values)
      A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.

      API name: repository

      Adds one or more values to repository.

    • s

      public final SnapshotsRequest.Builder s(List<String> list)
      List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      API name: s

      Adds all elements of list to s.

    • s

      public final SnapshotsRequest.Builder s(String value, String... values)
      List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      API name: s

      Adds one or more values to s.

    • time

      public final SnapshotsRequest.Builder time(@Nullable TimeUnit value)
      Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      API name: time

    • self

      protected SnapshotsRequest.Builder self()
      Specified by:
      self in class CatRequestBase.AbstractBuilder<SnapshotsRequest.Builder>

    • build

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