Package co.elastic.clients.elasticsearch.cat

Class MlDatafeedsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.cat.MlDatafeedsRequest.Builder
All Implemented Interfaces:
ObjectBuilder<MlDatafeedsRequest>
Enclosing class:
MlDatafeedsRequest
public static class MlDatafeedsRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<MlDatafeedsRequest>
Builder for MlDatafeedsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoDatafeeds

      @Deprecated public final MlDatafeedsRequest.Builder allowNoDatafeeds​(@Nullable java.lang.Boolean value)
      Deprecated.
      7.10.0 Use allow_no_match instead.
      Whether to ignore if a wildcard expression matches no datafeeds. (This includes _all string or when no datafeeds have been specified)

      API name: allow_no_datafeeds

    • allowNoMatch

      public final MlDatafeedsRequest.Builder allowNoMatch​(@Nullable java.lang.Boolean value)
      Specifies what to do when the request:
      • Contains wildcard expressions and there are no datafeeds that match.
      • Contains the _all string or no identifiers and there are no matches.
      • Contains wildcard expressions and there are only partial matches.

      If true, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

      API name: allow_no_match

    • datafeedId

      public final MlDatafeedsRequest.Builder datafeedId​(@Nullable java.lang.String value)
      A numerical character string that uniquely identifies the datafeed.

      API name: datafeed_id

    • format

      public final MlDatafeedsRequest.Builder format​(@Nullable java.lang.String value)
      Short version of the HTTP accept header. Valid values include JSON, YAML, for example.

      API name: format

    • h

      public final MlDatafeedsRequest.Builder h​(java.util.List<CatDatafeedColumn> list)
      Comma-separated list of column names to display.

      API name: h

      Adds all elements of list to h.

    • h

      public final MlDatafeedsRequest.Builder h​(CatDatafeedColumn value, CatDatafeedColumn... values)
      Comma-separated list of column names to display.

      API name: h

      Adds one or more values to h.

    • help

      public final MlDatafeedsRequest.Builder help​(@Nullable java.lang.Boolean value)
      If true, the response includes help information.

      API name: help

    • s

      public final MlDatafeedsRequest.Builder s​(java.util.List<CatDatafeedColumn> list)
      Comma-separated list of column names or column aliases used to sort the response.

      API name: s

      Adds all elements of list to s.

    • s

      public final MlDatafeedsRequest.Builder s​(CatDatafeedColumn value, CatDatafeedColumn... values)
      Comma-separated list of column names or column aliases used to sort the response.

      API name: s

      Adds one or more values to s.

    • time

      public final MlDatafeedsRequest.Builder time​(@Nullable TimeUnit value)
      The unit used to display time values.

      API name: time

    • v

      public final MlDatafeedsRequest.Builder v​(@Nullable java.lang.Boolean value)
      If true, the response includes column headings.

      API name: v

    • build

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