Package co.elastic.clients.elasticsearch.ml

Class GetDatafeedsRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoMatch

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

      The default value is true, which returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

      API name: allow_no_match

    • datafeedId

      public final GetDatafeedsRequest.Builder datafeedId​(java.util.List<java.lang.String> list)
      Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds.

      API name: datafeed_id

      Adds all elements of list to datafeedId.

    • datafeedId

      public final GetDatafeedsRequest.Builder datafeedId​(java.lang.String value, java.lang.String... values)
      Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds.

      API name: datafeed_id

      Adds one or more values to datafeedId.

    • excludeGenerated

      public final GetDatafeedsRequest.Builder excludeGenerated​(@Nullable java.lang.Boolean value)
      Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

      API name: exclude_generated

    • self

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

    • build

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