Class ClientYamlSuiteRestApi
java.lang.Object
org.elasticsearch.test.rest.yaml.restspec.ClientYamlSuiteRestApi
public class ClientYamlSuiteRestApi
extends java.lang.Object
Specification of an Elasticsearch endpoint used by the YAML specs to generate REST requests.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClientYamlSuiteRestApi.Body
static class
ClientYamlSuiteRestApi.Path
static class
ClientYamlSuiteRestApi.Stability
-
Method Summary
Modifier and Type Method Description java.util.List<ClientYamlSuiteRestApi.Path>
getBestMatchingPaths(java.util.Set<java.lang.String> params)
Returns the best matching paths based on the provided parameters, which may include either path parts or query_string parameters.java.lang.String
getLocation()
java.lang.String
getName()
java.util.Map<java.lang.String,java.lang.Boolean>
getParams()
Gets all parameters supported by the api.java.util.Collection<ClientYamlSuiteRestApi.Path>
getPaths()
ClientYamlSuiteRestApi.Stability
getStability()
boolean
isBodyRequired()
boolean
isBodySupported()
void
setStability(java.lang.String stability)
-
Method Details
-
getName
public java.lang.String getName() -
getLocation
public java.lang.String getLocation() -
getPaths
-
getParams
public java.util.Map<java.lang.String,java.lang.Boolean> 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
public void setStability(java.lang.String stability) -
getStability
-
getBestMatchingPaths
public java.util.List<ClientYamlSuiteRestApi.Path> getBestMatchingPaths(java.util.Set<java.lang.String> params)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}
-