Package co.elastic.clients.elasticsearch.ml

Class GetTrainedModelsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetTrainedModelsRequest
public class GetTrainedModelsRequest extends RequestBase
Get trained model configuration info.
See Also:

  • Field Details

  • Method Details

    • of

      public static GetTrainedModelsRequest of(Function<GetTrainedModelsRequest.Builder,ObjectBuilder<GetTrainedModelsRequest>> 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, it returns an empty array when there are no matches and the subset of results when there are partial matches.

      API name: allow_no_match

    • decompressDefinition

      @Nullable public final Boolean decompressDefinition()
      Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false).

      API name: decompress_definition

    • excludeGenerated

      @Nullable public final 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

    • from

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

      API name: from

    • include

      @Nullable public final Include include()
      A comma delimited string of optional fields to include in the response body.

      API name: include

    • modelId

      public final List<String> modelId()
      The unique identifier of the trained model or a model alias.

      You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

      API name: model_id

    • size

      @Nullable public final Integer size()
      Specifies the maximum number of models to obtain.

      API name: size

    • tags

      public final List<String> tags()
      A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned.

      API name: tags