Class ClientYamlSuiteRestSpec

java.lang.Object

org.opensearch.test.rest.yaml.restspec.ClientYamlSuiteRestSpec

public class ClientYamlSuiteRestSpec
extends Object

Holds the specification used to turn do actions in the YAML suite into REST api calls.

Method Summary

Modifier and Type	Method	Description
ClientYamlSuiteRestApi	getApi(String api)
Collection<ClientYamlSuiteRestApi>	getApis()
boolean	isClientParameter(String name)	Returns whether the provided parameter is one of those parameters that are supported by the OpenSearch language clients, meaning that they influence the client behaviour and don't get sent to OpenSearch
boolean	isGlobalParameter(String param)	Returns whether the provided parameter is one of those parameters that are supported by all OpenSearch api
static ClientYamlSuiteRestSpec	load(String classpathPrefix)	Parses the complete set of REST spec available under the provided directories

Methods inherited from class java.lang.Object

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

Method Details

getApi

public ClientYamlSuiteRestApi getApi(String api)

getApis

public Collection<ClientYamlSuiteRestApi> getApis()

isGlobalParameter

public boolean isGlobalParameter(String param)

Returns whether the provided parameter is one of those parameters that are supported by all OpenSearch api

isClientParameter

public boolean isClientParameter(String name)

Returns whether the provided parameter is one of those parameters that are supported by the OpenSearch language clients, meaning that they influence the client behaviour and don't get sent to OpenSearch

load

public static ClientYamlSuiteRestSpec load(String classpathPrefix)
                                    throws Exception

Parses the complete set of REST spec available under the provided directories

Throws:

Exception