Class ClientYamlSuiteRestApi
java.lang.Object
org.elasticsearch.test.rest.yaml.restspec.ClientYamlSuiteRestApi
Specification of an Elasticsearch endpoint used by the YAML specs to generate REST requests.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumstatic final recordstatic enumstatic enum -
Method Summary
Modifier and TypeMethodDescriptiongetBestMatchingPaths(Set<String> pathParams) Returns the best matching paths based on the provided parameters, which may include either path parts or query_string parameters.getName()Gets all parameters supported by the api.getPaths()booleanbooleanvoidsetFeatureFlag(String featureFlag) voidsetRequestMimeTypes(List<String> mimeTypes) voidsetResponseMimeTypes(List<String> mimeTypes) voidsetStability(String stability) voidsetVisibility(String visibility)
-
Method Details
-
getName
-
getLocation
-
getPaths
-
getParams
Gets all parameters supported by the api. For every parameter defines if it is required or optional. -
isBodySupported
public boolean isBodySupported() -
isBodyRequired
public boolean isBodyRequired() -
setStability
-
getStability
-
setVisibility
-
getVisibility
-
setFeatureFlag
-
getFeatureFlag
-
setResponseMimeTypes
-
getResponseMimeTypes
-
setRequestMimeTypes
-
getRequestMimeTypes
-
getBestMatchingPaths
Returns the best matching paths based on the provided parameters, which may include either path parts or query_string parameters. The best path is the one that has exactly the same number of placeholders to replace (e.g. /{index}/{type}/{id} when the path params are exactly index, type and id). It returns a list instead of a single path as there are cases where there is more than one best matching path: - /{index}/_alias/{name}, /{index}/_aliases/{name} - /{index}/{type}/_mapping, /{index}/{type}/_mappings, /{index}/_mappings/{type}, /{index}/_mapping/{type}
-