Package io.karatelabs.core

Class StepResult.Embed

java.lang.Object

io.karatelabs.core.StepResult.Embed

Enclosing class:

StepResult

public static class StepResult.Embed
extends Object

A named report embed, generalised to one-or-more StepResult.Parts plus optional meta (see EXT.md § Embeds). A legacy single-asset embed (screenshot, doc HTML, karate.embed) is one "primary" part carrying inline bytes; a multi-asset embed (e.g. image-comparison: baseline / current / diff) carries several parts, typically url-based.

Wire shape is uniform: {name, parts:[{role, mime, data|url|file}], meta}. There is no legacy flat (mime_type) form — v2 has no released embed consumers, so this is a clean break. The legacy constructor + accessors remain only as ergonomic helpers for core code that deals in single-asset embeds.

Constructor Summary

Constructors

Constructor	Description
Embed(byte[] data, String mimeType, String name)	Legacy single inline-bytes embed — wrapped as one "primary" part.
Embed(String name, List<StepResult.Part> parts, Map<String,Object> meta)	Multi-asset embed (e.g. image-comparison).

Method Summary

Modifier and Type	Method	Description
byte[]	getData()
String	getFileName()
Map<String,Object>	getMeta()
String	getMimeType()
String	getName()
List<StepResult.Part>	getParts()
void	setFileName(String fileName)	Set by HtmlReportWriter after writing the primary part's bytes to disk.
Map<String,Object>	toMap()

Methods inherited from class java.lang.Object

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

Constructor Details

Embed

public Embed(byte[] data,
 String mimeType,
 String name)

Legacy single inline-bytes embed — wrapped as one "primary" part.

Embed

public Embed(String name,
 List<StepResult.Part> parts,
 Map<String,Object> meta)

Multi-asset embed (e.g. image-comparison). parts must be non-empty.

Method Details

getData

public byte[] getData()

getMimeType

public String getMimeType()

getName

public String getName()

setFileName

public void setFileName(String fileName)

Set by HtmlReportWriter after writing the primary part's bytes to disk.

getFileName

public String getFileName()

getParts

public List<StepResult.Part> getParts()

getMeta

public Map<String,Object> getMeta()

toMap

public Map<String,Object> toMap()