Record Class Scenario
java.lang.Object
java.lang.Record
codes.grow.packages.betterstack.testing.Scenario
- Record Components:
id- scenario id, e.g.secrets.roundtripcategory-core,secrets,loggingortracingdescription- human descriptionrequires- capabilities the target must declaresteps- the steps in orderraw- the original JSON document
public record Scenario(String id, String category, String description, List<String> requires, List<Scenario.Step> steps, com.fasterxml.jackson.databind.JsonNode raw)
extends Record
A parsed conformance scenario (
conformance/scenarios/*.json).-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionOptional<com.fasterxml.jackson.databind.JsonNode> Returns thebatchOptionsobject of a logging scenario.category()Returns the value of thecategoryrecord component.Returns the value of thedescriptionrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.id()Returns the value of theidrecord component.static Scenarioparse(com.fasterxml.jackson.databind.JsonNode node) Parses a scenario document.com.fasterxml.jackson.databind.JsonNoderaw()Returns the value of therawrecord component.requires()Returns the value of therequiresrecord component.steps()Returns the value of thestepsrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
Scenario
public Scenario(String id, String category, String description, List<String> requires, List<Scenario.Step> steps, com.fasterxml.jackson.databind.JsonNode raw) Creates a scenario; lists are copied.- Parameters:
id- scenario idcategory- categorydescription- descriptionrequires- capabilitiessteps- stepsraw- original JSON
-
-
Method Details
-
batchOptions
Returns thebatchOptionsobject of a logging scenario.- Returns:
- the options, or empty
-
parse
Parses a scenario document.- Parameters:
node- scenario JSON- Returns:
- the scenario
- Throws:
IllegalArgumentException- when required fields are missing
-
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object). -
id
Returns the value of theidrecord component.- Returns:
- the value of the
idrecord component
-
category
Returns the value of thecategoryrecord component.- Returns:
- the value of the
categoryrecord component
-
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
requires
Returns the value of therequiresrecord component.- Returns:
- the value of the
requiresrecord component
-
steps
Returns the value of thestepsrecord component.- Returns:
- the value of the
stepsrecord component
-
raw
public com.fasterxml.jackson.databind.JsonNode raw()Returns the value of therawrecord component.- Returns:
- the value of the
rawrecord component
-