org.elasticsearch.test.rest.yaml

Class Stash

java.lang.Object

org.elasticsearch.test.rest.yaml.Stash

All Implemented Interfaces:

org.elasticsearch.common.xcontent.ToXContent

public class Stash
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContent

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static Stash	EMPTY

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Stash()

Method Summary

Modifier and Type	Method and 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
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)

Methods inherited from class java.lang.Object

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

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 org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
                                                                    org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws java.io.IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

java.io.IOException