Package co.elastic.clients.elasticsearch.cat

Class MlTrainedModelsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.MlTrainedModelsRequest
public class MlTrainedModelsRequest extends CatRequestBase
Returns configuration and usage information about inference trained models.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.

See Also:

  • Field Details

  • Method Details

    • of

      public static MlTrainedModelsRequest of(Function<MlTrainedModelsRequest.Builder,ObjectBuilder<MlTrainedModelsRequest>> fn)

    • allowNoMatch

      @Nullable public final Boolean allowNoMatch()
      Specifies what to do when the request: contains wildcard expressions and there are no models 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 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

    • bytes

      @Nullable public final Bytes bytes()
      The unit used to display byte values.

      API name: bytes

    • from

      @Nullable public final Integer from()
      Skips the specified number of transforms.

      API name: from

    • h

      public final List<CatTrainedModelsColumn> h()
      A comma-separated list of column names to display.

      API name: h

    • modelId

      @Nullable public final String modelId()
      A unique identifier for the trained model.

      API name: model_id

    • s

      public final List<CatTrainedModelsColumn> s()
      A comma-separated list of column names or aliases used to sort the response.

      API name: s

    • size

      @Nullable public final Integer size()
      The maximum number of transforms to display.

      API name: size