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
Retrieves configuration information for a trained model.
See Also:
API specification

  • Field Details

  • Method Details

    • of

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

    • allowNoMatch

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

    • from

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

      @Nullable public final java.lang.String modelId()
      The unique identifier of the trained model.

      API name: model_id

    • size

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

      API name: size

    • tags

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