Package co.elastic.clients.elasticsearch.ml

Class GetTrainedModelsRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.ml.GetTrainedModelsRequest.Builder
All Implemented Interfaces:
ObjectBuilder<GetTrainedModelsRequest>
Enclosing class:
GetTrainedModelsRequest
public static class GetTrainedModelsRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetTrainedModelsRequest>
Builder for GetTrainedModelsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • modelId

      public GetTrainedModelsRequest.Builder modelId​(@Nullable java.lang.String value)
      The unique identifier of the trained model.

      API name: model_id

    • allowNoMatch

      public GetTrainedModelsRequest.Builder allowNoMatch​(@Nullable java.lang.Boolean value)
      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.

      API name: allow_no_match

    • decompressDefinition

      public GetTrainedModelsRequest.Builder decompressDefinition​(@Nullable java.lang.Boolean value)
      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

      public GetTrainedModelsRequest.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

    • from

      public GetTrainedModelsRequest.Builder from​(@Nullable java.lang.Integer value)
      Skips the specified number of models.

      API name: from

    • include

      public GetTrainedModelsRequest.Builder include​(@Nullable java.lang.String value)
      A comma delimited string of optional fields to include in the response body.

      API name: include

    • size

      public GetTrainedModelsRequest.Builder size​(@Nullable java.lang.Integer value)
      Specifies the maximum number of models to obtain.

      API name: size

    • tags

      public GetTrainedModelsRequest.Builder tags​(@Nullable java.lang.String value)
      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

    • build

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