Package org.elasticsearch.test.rest.yaml.restspec

Class ClientYamlSuiteRestApi

  • public class ClientYamlSuiteRestApi
extends java.lang.Object
    Specification of an Elasticsearch endpoint used by the YAML specs to generate REST requests.

    • Method Summary

      Modifier and Type Method Description
      ClientYamlSuiteRestPath[] getFinalPaths​(java.util.Map<java.lang.String,​java.lang.String> pathParams)
      Finds the best matching rest path given the current parameters and replaces placeholders with their corresponding values received as arguments
      java.lang.String getLocation()  
      java.util.List<java.lang.String> getMethods()  
      java.lang.String getName()  
      java.util.Map<java.lang.String,​java.lang.Boolean> getParams()
      Gets all parameters supported by the api.
      java.util.Map<java.lang.String,​java.lang.Boolean> getPathParts()
      Gets all path parts supported by the api.
      java.util.List<java.lang.String> getPaths()  
      ClientYamlSuiteRestApi.Stability getStability()  
      java.util.List<java.lang.String> getSupportedMethods​(java.util.Set<java.lang.String> restParams)
      Returns the supported http methods given the rest parameters provided
      boolean isBodyRequired()  
      boolean isBodySupported()  
      void setStability​(java.lang.String stability)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getName

        public java.lang.String getName()

      • getLocation

        public java.lang.String getLocation()

      • getMethods

        public java.util.List<java.lang.String> getMethods()

      • getSupportedMethods

        public java.util.List<java.lang.String> getSupportedMethods​(java.util.Set<java.lang.String> restParams)
        Returns the supported http methods given the rest parameters provided

      • getPaths

        public java.util.List<java.lang.String> getPaths()

      • getPathParts

        public java.util.Map<java.lang.String,​java.lang.Boolean> getPathParts()
        Gets all path parts supported by the api. For every path part defines if it is required or optional.

      • 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)

      • getFinalPaths

        public ClientYamlSuiteRestPath[] getFinalPaths​(java.util.Map<java.lang.String,​java.lang.String> pathParams)
        Finds the best matching rest path given the current parameters and replaces placeholders with their corresponding values received as arguments