Class ObjectPath

java.lang.Object

org.opensearch.test.rest.yaml.ObjectPath

public class ObjectPath
extends Object

Holds an object and allows to extract specific values from it given their path

Constructor Summary

Constructors

Constructor	Description
ObjectPath(Object object)

Method Summary

Modifier and Type	Method	Description
static ObjectPath	createFromResponse(org.opensearch.client.Response response)
static ObjectPath	createFromXContent(org.opensearch.core.xcontent.XContent xContent, org.opensearch.core.common.bytes.BytesReference input)
static <T> T	evaluate(Object object, String path)	A utility method that creates an ObjectPath via ObjectPath(Object) returns the result of calling evaluate(String) on it.
<T> T	evaluate(String path)	Returns the object corresponding to the provided path if present, null otherwise
<T> T	evaluate(String path, Stash stash)	Returns the object corresponding to the provided path if present, null otherwise
org.opensearch.core.xcontent.XContentBuilder	toXContentBuilder(org.opensearch.core.xcontent.XContent xContent)	Create a new XContentBuilder from the xContent object underlying this ObjectPath.

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectPath

public ObjectPath(Object object)

Method Details

createFromResponse

public static ObjectPath createFromResponse(org.opensearch.client.Response response)
                                     throws IOException

Throws:

IOException

createFromXContent

public static ObjectPath createFromXContent(org.opensearch.core.xcontent.XContent xContent,
 org.opensearch.core.common.bytes.BytesReference input)
                                     throws IOException

Throws:

IOException

evaluate

public static <T> T evaluate(Object object,
 String path)
                      throws IOException

A utility method that creates an ObjectPath via ObjectPath(Object) returns the result of calling evaluate(String) on it.

Throws:

IOException

evaluate

public <T> T evaluate(String path)
               throws IOException

Returns the object corresponding to the provided path if present, null otherwise

Throws:

IOException

evaluate

public <T> T evaluate(String path,
 Stash stash)
               throws IOException

Returns the object corresponding to the provided path if present, null otherwise

Throws:

IOException

toXContentBuilder

public org.opensearch.core.xcontent.XContentBuilder toXContentBuilder(org.opensearch.core.xcontent.XContent xContent)
                                                               throws IOException

Create a new XContentBuilder from the xContent object underlying this ObjectPath. This only works for ObjectPath instances created from an xContent object, not from nested substructures. We throw an UnsupportedOperationException in those cases.

Throws:

IOException