org.elasticsearch.test.rest.yaml

Class ClientYamlDocsTestClient

java.lang.Object

org.elasticsearch.test.rest.yaml.ClientYamlTestClient

org.elasticsearch.test.rest.yaml.ClientYamlDocsTestClient

public final class ClientYamlDocsTestClient
extends ClientYamlTestClient

Used to execute REST requests according to the docs snippets that need to be tests. Wraps a RestClient instance used to send the REST requests. Holds the ClientYamlSuiteRestSpec used to translate api calls into REST calls. Supports raw requests besides the usual api calls based on the rest spec.

Field Summary

Fields inherited from class org.elasticsearch.test.rest.yaml.ClientYamlTestClient

hostVersionMap, restClient

Constructor Summary

Constructors

Constructor and Description
ClientYamlDocsTestClient(ClientYamlSuiteRestSpec restSpec, RestClient restClient, java.util.List<org.apache.http.HttpHost> hosts, Version esVersion, java.util.Map<org.apache.http.HttpHost,Version> hostVersionMap)

Method Summary

Modifier and Type	Method and Description
ClientYamlTestResponse	callApi(java.lang.String apiName, java.util.Map<java.lang.String,java.lang.String> params, org.apache.http.HttpEntity entity, java.util.Map<java.lang.String,java.lang.String> headers) Calls an api with the provided parameters and body

Methods inherited from class org.elasticsearch.test.rest.yaml.ClientYamlTestClient

getEsVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientYamlDocsTestClient

public ClientYamlDocsTestClient(ClientYamlSuiteRestSpec restSpec,
                                RestClient restClient,
                                java.util.List<org.apache.http.HttpHost> hosts,
                                Version esVersion,
                                java.util.Map<org.apache.http.HttpHost,Version> hostVersionMap)
                         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

callApi

public ClientYamlTestResponse callApi(java.lang.String apiName,
                                      java.util.Map<java.lang.String,java.lang.String> params,
                                      org.apache.http.HttpEntity entity,
                                      java.util.Map<java.lang.String,java.lang.String> headers)
                               throws java.io.IOException

Description copied from class: ClientYamlTestClient

Calls an api with the provided parameters and body

Overrides:

callApi in class ClientYamlTestClient

Throws:

java.io.IOException