Class ClientYamlTestClient

java.lang.Object

org.opensearch.test.rest.yaml.ClientYamlTestClient

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ClientYamlDocsTestClient

public class ClientYamlTestClient
extends Object
implements Closeable

Used by OpenSearchClientYamlSuiteTestCase to execute REST requests according to the tests written in yaml suite files. Wraps a RestClient instance used to send the REST requests. Holds the ClientYamlSuiteRestSpec used to translate api calls into REST calls.

Method Summary

Modifier and Type	Method	Description
ClientYamlTestResponse	callApi(String apiName, Map<String,String> params, org.apache.hc.core5.http.HttpEntity entity, Map<String,String> headers, org.opensearch.client.NodeSelector nodeSelector)	Calls an api with the provided parameters and body
void	close()
org.opensearch.Version	getClusterManagerVersion()
org.opensearch.Version	getEsVersion()
protected org.opensearch.client.RestClient	getRestClient(org.opensearch.client.NodeSelector nodeSelector)
protected static void	setOptions(org.opensearch.client.Request request, Map<String,String> headers)

Methods inherited from class java.lang.Object

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

Method Details

getEsVersion

public org.opensearch.Version getEsVersion()

getClusterManagerVersion

public org.opensearch.Version getClusterManagerVersion()

callApi

public ClientYamlTestResponse callApi(String apiName,
 Map<String,String> params,
 org.apache.hc.core5.http.HttpEntity entity,
 Map<String,String> headers,
 org.opensearch.client.NodeSelector nodeSelector)
                               throws IOException

Calls an api with the provided parameters and body

Throws:

IOException

getRestClient

protected org.opensearch.client.RestClient getRestClient(org.opensearch.client.NodeSelector nodeSelector)

setOptions

protected static void setOptions(org.opensearch.client.Request request,
 Map<String,String> headers)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException