Package org.elasticsearch.client.ml
Class GetTrainedModelsRequest
java.lang.Object
org.elasticsearch.client.ml.GetTrainedModelsRequest
- All Implemented Interfaces:
Validatable
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static GetTrainedModelsRequest
Helper method to create a request that will get ALL TrainedModelConfigsgetIds()
getTags()
int
hashCode()
setAllowNoMatch
(boolean allowNoMatch) Whether to ignore if a wildcard expression matches no trained models.setDecompressDefinition
(Boolean decompressDefinition) Whether or not to decompress the trained model, or keep it in its compressed string formsetExcludeGenerated
(Boolean excludeGenerated) Setting this flag to `true` removes certain fields from the model definition on retrieval.setIncludeDefinition
(Boolean includeDefinition) Deprecated.setPageParams
(PageParams pageParams) SeesetTags(List)
The tags that the trained model must match.validate()
Perform validation.
-
Field Details
-
ALLOW_NO_MATCH
- See Also:
-
EXCLUDE_GENERATED
- See Also:
-
DECOMPRESS_DEFINITION
- See Also:
-
TAGS
- See Also:
-
INCLUDE
- See Also:
-
-
Constructor Details
-
GetTrainedModelsRequest
-
-
Method Details
-
getAllTrainedModelConfigsRequest
Helper method to create a request that will get ALL TrainedModelConfigs- Returns:
- new
GetTrainedModelsRequest
object for the id "_all"
-
getIds
-
getAllowNoMatch
-
setAllowNoMatch
Whether to ignore if a wildcard expression matches no trained models.- Parameters:
allowNoMatch
- If this isfalse
, then an error is returned when a wildcard (or_all
) does not match any trained models
-
getPageParams
-
setPageParams
-
getIncludes
-
includeDefinition
-
includeTotalFeatureImportance
-
includeFeatureImportanceBaseline
-
setIncludeDefinition
Deprecated.Whether to include the full model definition. The full model definition can be very large.- Parameters:
includeDefinition
- Iftrue
, the definition is included.
-
getDecompressDefinition
-
setDecompressDefinition
Whether or not to decompress the trained model, or keep it in its compressed string form- Parameters:
decompressDefinition
- Iftrue
, the definition is decompressed.
-
getTags
-
setTags
The tags that the trained model must match. These correspond toTrainedModelConfig.getTags()
. The models returned will match ALL tags supplied. If none are provided, only the provided ids are used to find models- Parameters:
tags
- The tags to match when finding models
-
setTags
SeesetTags(List)
-
getExcludeGenerated
-
setExcludeGenerated
Setting this flag to `true` removes certain fields from the model definition on retrieval. This is useful when getting the model and wanting to put it in another cluster. Default value is false.- Parameters:
excludeGenerated
- Boolean value indicating if certain fields should be removed from the mode on GET
-
validate
Description copied from interface:Validatable
Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. AValidationException
that is not null is assumed to contain validation errors and will be thrown.- Specified by:
validate
in interfaceValidatable
- Returns:
- An
Optional
ValidationException
that contains a list of validation errors.
-
equals
-
hashCode
public int hashCode()
-
includeDefinition()