Package co.elastic.clients.elasticsearch.ml

Class GetTrainedModelsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetTrainedModelsRequest.Builder>
co.elastic.clients.elasticsearch.ml.GetTrainedModelsRequest.Builder
All Implemented Interfaces:
WithJson<GetTrainedModelsRequest.Builder>, ObjectBuilder<GetTrainedModelsRequest>
Enclosing class:
GetTrainedModelsRequest
public static class GetTrainedModelsRequest.Builder extends RequestBase.AbstractBuilder<GetTrainedModelsRequest.Builder> implements ObjectBuilder<GetTrainedModelsRequest>
Builder for GetTrainedModelsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoMatch

      public final GetTrainedModelsRequest.Builder allowNoMatch(@Nullable 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.

      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

      public final GetTrainedModelsRequest.Builder decompressDefinition(@Nullable 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 final GetTrainedModelsRequest.Builder excludeGenerated(@Nullable 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 final GetTrainedModelsRequest.Builder from(@Nullable Integer value)
      Skips the specified number of models.

      API name: from

    • include

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

      API name: include

    • modelId

      public final GetTrainedModelsRequest.Builder modelId(List<String> list)
      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

      Adds all elements of list to modelId.

    • modelId

      public final GetTrainedModelsRequest.Builder modelId(String value, String... values)
      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

      Adds one or more values to modelId.

    • size

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

      API name: size

    • tags

      public final GetTrainedModelsRequest.Builder tags(List<String> list)
      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

      Adds all elements of list to tags.

    • tags

      public final GetTrainedModelsRequest.Builder tags(String value, String... values)
      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

      Adds one or more values to tags.

    • self

      protected GetTrainedModelsRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<GetTrainedModelsRequest.Builder>

    • build

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