org.elasticsearch.test.rest.yaml.restspec

Class ClientYamlSuiteRestSpec

java.lang.Object

org.elasticsearch.test.rest.yaml.restspec.ClientYamlSuiteRestSpec

public class ClientYamlSuiteRestSpec
extends java.lang.Object

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

Method Summary

Modifier and Type	Method and Description
ClientYamlSuiteRestApi	getApi(java.lang.String api)
java.util.Collection<ClientYamlSuiteRestApi>	getApis()
boolean	isClientParameter(java.lang.String name) Returns whether the provided parameter is one of those parameters that are supported by the Elasticsearch language clients, meaning that they influence the client behaviour and don't get sent to Elasticsearch
boolean	isGlobalParameter(java.lang.String param) Returns whether the provided parameter is one of those parameters that are supported by all Elasticsearch api
static ClientYamlSuiteRestSpec	parseFrom(java.nio.file.FileSystem fileSystem, java.lang.String optionalPathPrefix, java.lang.String... paths) 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 Detail

getApi

public ClientYamlSuiteRestApi getApi(java.lang.String api)

getApis

public java.util.Collection<ClientYamlSuiteRestApi> getApis()

isGlobalParameter

public boolean isGlobalParameter(java.lang.String param)

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

isClientParameter

public boolean isClientParameter(java.lang.String name)

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

parseFrom

public static ClientYamlSuiteRestSpec parseFrom(java.nio.file.FileSystem fileSystem,
                                                java.lang.String optionalPathPrefix,
                                                java.lang.String... paths)
                                         throws java.io.IOException

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

Throws:

java.io.IOException