Package org.elasticsearch.test.rest.yaml

Class Stash

java.lang.Object

org.elasticsearch.test.rest.yaml.Stash

All Implemented Interfaces:

ToXContent, ToXContentFragment

public class Stash
extends java.lang.Object
implements ToXContentFragment

Allows to cache the last obtained test response and or part of it within variables that can be used as input values in following requests and assertions.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static Stash	EMPTY

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Stash()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the previously stashed values
boolean	containsStashedValue(java.lang.Object key)	Tells whether a particular key needs to be looked up in the stash based on its name.
java.lang.Object	getValue(java.lang.String key)	Retrieves a value from the current stash.
java.util.Map<java.lang.String,java.lang.Object>	replaceStashedValues(java.util.Map<java.lang.String,java.lang.Object> map)	Goes recursively against each map entry and replaces any string value starting with "$" with its corresponding value retrieved from the stash
void	stashValue(java.lang.String key, java.lang.Object value)	Allows to saved a specific field in the stash as key-value pair
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

EMPTY

public static final Stash EMPTY

Constructor Detail

Stash

public Stash()

Method Detail

stashValue

public void stashValue(java.lang.String key,
                       java.lang.Object value)

Allows to saved a specific field in the stash as key-value pair

clear

public void clear()

Clears the previously stashed values

containsStashedValue

public boolean containsStashedValue(java.lang.Object key)

Tells whether a particular key needs to be looked up in the stash based on its name. Returns true if the string representation of the key starts with "$", false otherwise The stash contains fields eventually extracted from previous responses that can be reused as arguments for following requests (e.g. scroll_id)

getValue

public java.lang.Object getValue(java.lang.String key)
                          throws java.io.IOException

Retrieves a value from the current stash. The stash contains fields eventually extracted from previous responses that can be reused as arguments for following requests (e.g. scroll_id)

Throws:

java.io.IOException

replaceStashedValues

public java.util.Map<java.lang.String,java.lang.Object> replaceStashedValues(java.util.Map<java.lang.String,java.lang.Object> map)
                                                                      throws java.io.IOException

Goes recursively against each map entry and replaces any string value starting with "$" with its corresponding value retrieved from the stash

Throws:

java.io.IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException