Interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
,RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Enclosing interface:
- RobotFrameworkEndpointBuilderFactory
public static interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder extends RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder, RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
Builder for endpoint for the Robot Framework component.
-
-
Method Summary
-
Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
-
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, greedy, greedy, initialDelay, initialDelay, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay
-
-
-
-
Method Detail
-
advanced
default RobotFrameworkEndpointBuilderFactory.AdvancedRobotFrameworkEndpointBuilder advanced()
- Specified by:
advanced
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
advanced
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
-
allowContextMapAll
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder allowContextMapAll(boolean allowContextMapAll)
Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
allowContextMapAll
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
allowContextMapAll
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
allowContextMapAll
- the value to set- Returns:
- the dsl builder
-
allowContextMapAll
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder allowContextMapAll(String allowContextMapAll)
Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
allowContextMapAll
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
allowContextMapAll
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
allowContextMapAll
- the value to set- Returns:
- the dsl builder
-
allowTemplateFromHeader
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder allowTemplateFromHeader(boolean allowTemplateFromHeader)
Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
allowTemplateFromHeader
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
allowTemplateFromHeader
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
allowTemplateFromHeader
- the value to set- Returns:
- the dsl builder
-
allowTemplateFromHeader
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder allowTemplateFromHeader(String allowTemplateFromHeader)
Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
allowTemplateFromHeader
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
allowTemplateFromHeader
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
allowTemplateFromHeader
- the value to set- Returns:
- the dsl builder
-
argumentFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder argumentFile(File argumentFile)
A text file to read more arguments from. The option is a: <code>java.io.File</code> type. Group: common- Specified by:
argumentFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
argumentFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
argumentFile
- the value to set- Returns:
- the dsl builder
-
argumentFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder argumentFile(String argumentFile)
A text file to read more arguments from. The option will be converted to a <code>java.io.File</code> type. Group: common- Specified by:
argumentFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
argumentFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
argumentFile
- the value to set- Returns:
- the dsl builder
-
combinedTagStats
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder combinedTagStats(String combinedTagStats)
Creates combined statistics based on tags. Use the format tags:title List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
combinedTagStats
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
combinedTagStats
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
combinedTagStats
- the value to set- Returns:
- the dsl builder
-
contentCache
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder contentCache(boolean contentCache)
Sets whether to use resource content cache or not. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
contentCache
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
contentCache
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
contentCache
- the value to set- Returns:
- the dsl builder
-
contentCache
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder contentCache(String contentCache)
Sets whether to use resource content cache or not. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
contentCache
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
contentCache
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
contentCache
- the value to set- Returns:
- the dsl builder
-
criticalTags
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder criticalTags(String criticalTags)
Tests that have the given tags are considered critical. List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
criticalTags
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
criticalTags
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
criticalTags
- the value to set- Returns:
- the dsl builder
-
debugFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder debugFile(File debugFile)
A debug file that is written during execution. The option is a: <code>java.io.File</code> type. Group: common- Specified by:
debugFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
debugFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
debugFile
- the value to set- Returns:
- the dsl builder
-
debugFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder debugFile(String debugFile)
A debug file that is written during execution. The option will be converted to a <code>java.io.File</code> type. Group: common- Specified by:
debugFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
debugFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
debugFile
- the value to set- Returns:
- the dsl builder
-
document
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder document(String document)
Sets the documentation of the top-level tests suites. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
document
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
document
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
document
- the value to set- Returns:
- the dsl builder
-
dryrun
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder dryrun(boolean dryrun)
Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
dryrun
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
dryrun
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
dryrun
- the value to set- Returns:
- the dsl builder
-
dryrun
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder dryrun(String dryrun)
Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
dryrun
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
dryrun
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
dryrun
- the value to set- Returns:
- the dsl builder
-
excludes
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder excludes(String excludes)
Selects the tests cases by tags. List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
excludes
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
excludes
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
excludes
- the value to set- Returns:
- the dsl builder
-
exitOnFailure
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder exitOnFailure(boolean exitOnFailure)
Sets robot to stop execution immediately if a critical test fails. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
exitOnFailure
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
exitOnFailure
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
exitOnFailure
- the value to set- Returns:
- the dsl builder
-
exitOnFailure
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder exitOnFailure(String exitOnFailure)
Sets robot to stop execution immediately if a critical test fails. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
exitOnFailure
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
exitOnFailure
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
exitOnFailure
- the value to set- Returns:
- the dsl builder
-
includes
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder includes(String includes)
Selects the tests cases by tags. List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
includes
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
includes
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
includes
- the value to set- Returns:
- the dsl builder
-
listener
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder listener(String listener)
Sets a single listener for monitoring tests execution. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
listener
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
listener
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
listener
- the value to set- Returns:
- the dsl builder
-
listeners
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder listeners(String listeners)
Sets multiple listeners for monitoring tests execution. Use the format ListenerWithArgs:arg1:arg2 or simply ListenerWithoutArgs List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
listeners
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
listeners
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
listeners
- the value to set- Returns:
- the dsl builder
-
log
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder log(File log)
Sets the path to the generated log file. The option is a: <code>java.io.File</code> type. Group: common- Specified by:
log
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
log
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
log
- the value to set- Returns:
- the dsl builder
-
log
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder log(String log)
Sets the path to the generated log file. The option will be converted to a <code>java.io.File</code> type. Group: common- Specified by:
log
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
log
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
log
- the value to set- Returns:
- the dsl builder
-
logLevel
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder logLevel(String logLevel)
Sets the threshold level for logging. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
logLevel
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
logLevel
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
logLevel
- the value to set- Returns:
- the dsl builder
-
logTitle
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder logTitle(String logTitle)
Sets a title for the generated tests log. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
logTitle
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
logTitle
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
logTitle
- the value to set- Returns:
- the dsl builder
-
metadata
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder metadata(String metadata)
Sets free metadata for the top level tests suites. comma seperated list of string resulting as List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
metadata
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
metadata
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
metadata
- the value to set- Returns:
- the dsl builder
-
monitorColors
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder monitorColors(String monitorColors)
Using ANSI colors in console. Normally colors work in unixes but not in Windows. Default is 'on'. 'on' - use colors in unixes but not in Windows 'off' - never use colors 'force' - always use colors (also in Windows). The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
monitorColors
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
monitorColors
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
monitorColors
- the value to set- Returns:
- the dsl builder
-
monitorWidth
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder monitorWidth(String monitorWidth)
Width of the monitor output. Default is 78. The option is a: <code>java.lang.String</code> type. Default: 78 Group: common- Specified by:
monitorWidth
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
monitorWidth
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
monitorWidth
- the value to set- Returns:
- the dsl builder
-
name
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder name(String name)
Sets the name of the top-level tests suites. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
name
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
name
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
name
- the value to set- Returns:
- the dsl builder
-
nonCriticalTags
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder nonCriticalTags(String nonCriticalTags)
Tests that have the given tags are not critical. List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
nonCriticalTags
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
nonCriticalTags
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
nonCriticalTags
- the value to set- Returns:
- the dsl builder
-
noStatusReturnCode
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder noStatusReturnCode(boolean noStatusReturnCode)
If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
noStatusReturnCode
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
noStatusReturnCode
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
noStatusReturnCode
- the value to set- Returns:
- the dsl builder
-
noStatusReturnCode
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder noStatusReturnCode(String noStatusReturnCode)
If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
noStatusReturnCode
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
noStatusReturnCode
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
noStatusReturnCode
- the value to set- Returns:
- the dsl builder
-
output
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder output(File output)
Sets the path to the generated output file. The option is a: <code>java.io.File</code> type. Group: common- Specified by:
output
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
output
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
output
- the value to set- Returns:
- the dsl builder
-
output
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder output(String output)
Sets the path to the generated output file. The option will be converted to a <code>java.io.File</code> type. Group: common- Specified by:
output
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
output
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
output
- the value to set- Returns:
- the dsl builder
-
outputDirectory
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder outputDirectory(File outputDirectory)
Configures where generated reports are to be placed. The option is a: <code>java.io.File</code> type. Group: common- Specified by:
outputDirectory
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
outputDirectory
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
outputDirectory
- the value to set- Returns:
- the dsl builder
-
outputDirectory
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder outputDirectory(String outputDirectory)
Configures where generated reports are to be placed. The option will be converted to a <code>java.io.File</code> type. Group: common- Specified by:
outputDirectory
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
outputDirectory
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
outputDirectory
- the value to set- Returns:
- the dsl builder
-
randomize
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder randomize(String randomize)
Sets the test execution order to be randomized. Valid values are all, suite, and test. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
randomize
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
randomize
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
randomize
- the value to set- Returns:
- the dsl builder
-
report
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder report(File report)
Sets the path to the generated report file. The option is a: <code>java.io.File</code> type. Group: common- Specified by:
report
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
report
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
report
- the value to set- Returns:
- the dsl builder
-
report
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder report(String report)
Sets the path to the generated report file. The option will be converted to a <code>java.io.File</code> type. Group: common- Specified by:
report
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
report
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
report
- the value to set- Returns:
- the dsl builder
-
reportBackground
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder reportBackground(String reportBackground)
Sets background colors for the generated report and summary. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
reportBackground
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
reportBackground
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
reportBackground
- the value to set- Returns:
- the dsl builder
-
reportTitle
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder reportTitle(String reportTitle)
Sets a title for the generated tests report. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
reportTitle
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
reportTitle
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
reportTitle
- the value to set- Returns:
- the dsl builder
-
runEmptySuite
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder runEmptySuite(boolean runEmptySuite)
Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
runEmptySuite
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
runEmptySuite
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
runEmptySuite
- the value to set- Returns:
- the dsl builder
-
runEmptySuite
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder runEmptySuite(String runEmptySuite)
Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
runEmptySuite
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
runEmptySuite
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
runEmptySuite
- the value to set- Returns:
- the dsl builder
-
runFailed
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder runFailed(File runFailed)
Re-run failed tests, based on output.xml file. The option is a: <code>java.io.File</code> type. Group: common- Specified by:
runFailed
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
runFailed
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
runFailed
- the value to set- Returns:
- the dsl builder
-
runFailed
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder runFailed(String runFailed)
Re-run failed tests, based on output.xml file. The option will be converted to a <code>java.io.File</code> type. Group: common- Specified by:
runFailed
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
runFailed
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
runFailed
- the value to set- Returns:
- the dsl builder
-
runMode
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder runMode(String runMode)
Sets the execution mode for this tests run. Note that this setting has been deprecated in Robot Framework 2.8. Use separate dryryn, skipTeardownOnExit, exitOnFailure, and randomize settings instead. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
runMode
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
runMode
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
runMode
- the value to set- Returns:
- the dsl builder
-
skipTeardownOnExit
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder skipTeardownOnExit(boolean skipTeardownOnExit)
Sets whether the teardowns are skipped if the test execution is prematurely stopped. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
skipTeardownOnExit
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
skipTeardownOnExit
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
skipTeardownOnExit
- the value to set- Returns:
- the dsl builder
-
skipTeardownOnExit
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder skipTeardownOnExit(String skipTeardownOnExit)
Sets whether the teardowns are skipped if the test execution is prematurely stopped. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
skipTeardownOnExit
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
skipTeardownOnExit
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
skipTeardownOnExit
- the value to set- Returns:
- the dsl builder
-
splitOutputs
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder splitOutputs(String splitOutputs)
Splits output and log files. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
splitOutputs
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
splitOutputs
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
splitOutputs
- the value to set- Returns:
- the dsl builder
-
suites
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder suites(String suites)
Selects the tests suites by name. List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
suites
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
suites
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
suites
- the value to set- Returns:
- the dsl builder
-
suiteStatLevel
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder suiteStatLevel(String suiteStatLevel)
Defines how many levels to show in the Statistics by Suite table in outputs. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
suiteStatLevel
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
suiteStatLevel
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
suiteStatLevel
- the value to set- Returns:
- the dsl builder
-
summaryTitle
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder summaryTitle(String summaryTitle)
Sets a title for the generated summary report. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
summaryTitle
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
summaryTitle
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
summaryTitle
- the value to set- Returns:
- the dsl builder
-
tagDocs
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder tagDocs(String tagDocs)
Adds documentation to the specified tags. List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
tagDocs
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
tagDocs
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
tagDocs
- the value to set- Returns:
- the dsl builder
-
tags
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder tags(String tags)
Sets the tags(s) to all executed tests cases. List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
tags
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
tags
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
tags
- the value to set- Returns:
- the dsl builder
-
tagStatExcludes
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder tagStatExcludes(String tagStatExcludes)
Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs. List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
tagStatExcludes
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
tagStatExcludes
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
tagStatExcludes
- the value to set- Returns:
- the dsl builder
-
tagStatIncludes
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder tagStatIncludes(String tagStatIncludes)
Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs. List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
tagStatIncludes
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
tagStatIncludes
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
tagStatIncludes
- the value to set- Returns:
- the dsl builder
-
tagStatLinks
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder tagStatLinks(String tagStatLinks)
Adds external links to the Statistics by Tag table in outputs. Use the format pattern:link:title List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
tagStatLinks
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
tagStatLinks
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
tagStatLinks
- the value to set- Returns:
- the dsl builder
-
tests
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder tests(String tests)
Selects the tests cases by name. List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
tests
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
tests
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
tests
- the value to set- Returns:
- the dsl builder
-
timestampOutputs
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder timestampOutputs(boolean timestampOutputs)
Adds a timestamp to all output files. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
timestampOutputs
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
timestampOutputs
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
timestampOutputs
- the value to set- Returns:
- the dsl builder
-
timestampOutputs
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder timestampOutputs(String timestampOutputs)
Adds a timestamp to all output files. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
timestampOutputs
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
timestampOutputs
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
timestampOutputs
- the value to set- Returns:
- the dsl builder
-
variableFiles
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder variableFiles(String variableFiles)
Sets variables using variables files. Use the format path:args List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
variableFiles
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
variableFiles
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
variableFiles
- the value to set- Returns:
- the dsl builder
-
variables
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder variables(String variables)
Sets individual variables. Use the format name:value List. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
variables
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
variables
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
variables
- the value to set- Returns:
- the dsl builder
-
warnOnSkippedFiles
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder warnOnSkippedFiles(boolean warnOnSkippedFiles)
Show a warning when an invalid file is skipped. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
warnOnSkippedFiles
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
warnOnSkippedFiles
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
warnOnSkippedFiles
- the value to set- Returns:
- the dsl builder
-
warnOnSkippedFiles
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder warnOnSkippedFiles(String warnOnSkippedFiles)
Show a warning when an invalid file is skipped. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
warnOnSkippedFiles
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
warnOnSkippedFiles
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
warnOnSkippedFiles
- the value to set- Returns:
- the dsl builder
-
xunitFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder xunitFile(File xunitFile)
Sets the path to the generated XUnit compatible result file, relative to outputDirectory. The file is in xml format. By default, the file name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores. The option is a: <code>java.io.File</code> type. Group: common- Specified by:
xunitFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
xunitFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
xunitFile
- the value to set- Returns:
- the dsl builder
-
xunitFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder xunitFile(String xunitFile)
Sets the path to the generated XUnit compatible result file, relative to outputDirectory. The file is in xml format. By default, the file name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores. The option will be converted to a <code>java.io.File</code> type. Group: common- Specified by:
xunitFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
- Specified by:
xunitFile
in interfaceRobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
- Parameters:
xunitFile
- the value to set- Returns:
- the dsl builder
-
-