Package com.applitools.eyes
Class BatchInfo
java.lang.Object
com.applitools.eyes.BatchInfo
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddProperty(String name, String value) booleangetId()getName()booleanbooleanvoidsetCompleted(boolean completed) voidSets a unique identifier for the batch.voidsetNotifyOnCompletion(boolean notifyOnCompletion) voidsetSequenceName(String sequenceName) voidsetStartedAt(String startedAt) toString()withBatchId(String id) Sets a unique identifier for the batch and allows chaining of the id with the instance then returns that instance.
-
Constructor Details
-
BatchInfo
-
BatchInfo
-
BatchInfo
public BatchInfo() -
BatchInfo
SeeBatchInfo(String, Calendar).startedAtdefaults to the current time.- Parameters:
name- The name of the batch.
-
-
Method Details
-
getName
- Returns:
- The name of the batch or
nullif anonymous.
-
getId
- Returns:
- The id of the current batch.
-
setId
Sets a unique identifier for the batch. Sessions with batch info which includes the same ID will be grouped together.- Parameters:
id- The batch's ID
-
withBatchId
Sets a unique identifier for the batch and allows chaining of the id with the instance then returns that instance. Sessions with batch info which includes the same ID will be grouped together.- Parameters:
id- The batch's ID- Returns:
- The updated
BatchInfoinstance.
-
getStartedAt
- Returns:
- The batch start date and time in ISO 8601 format.
-
setStartedAt
-
toString
-
getSequenceName
-
setSequenceName
-
equals
-
isNotifyOnCompletion
public boolean isNotifyOnCompletion() -
setNotifyOnCompletion
public void setNotifyOnCompletion(boolean notifyOnCompletion) -
isCompleted
public boolean isCompleted() -
setCompleted
public void setCompleted(boolean completed) -
addProperty
-
getProperties
-