Class GetDatafeedsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetDatafeedsRequest

public class GetDatafeedsRequest
extends RequestBase
Retrieves configuration information for datafeeds. You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>. This API returns a maximum of 10,000 datafeeds.
See Also:
API specification
  • Field Details

  • Method Details

    • of

      public static GetDatafeedsRequest of​(java.util.function.Function<GetDatafeedsRequest.Builder,​ObjectBuilder<GetDatafeedsRequest>> fn)
    • allowNoDatafeeds

      @Deprecated @Nullable public final java.lang.Boolean allowNoDatafeeds()
      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

      @Nullable public final java.lang.Boolean allowNoMatch()
      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 java.util.List<java.lang.String> datafeedId()
      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

    • excludeGenerated

      @Nullable public final java.lang.Boolean excludeGenerated()
      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