Package com.helixframework.rules.rule.rest

Class RestRule.Builder

java.lang.Object

com.helixframework.rules.rule.rest.RestRule.Builder

Enclosing class:

RestRule

public static final class RestRule.Builder
extends Object

Builds an instance of RestRule.

Method Summary

Modifier and Type	Method	Description
RestRule	build()	Creates an instance of RestRule.
RestRule.Builder	withClassification(String value)	Sets the rule classification.
RestRule.Builder	withDependencies(Set<Rule> value)	Add rule dependencies to the rule.
RestRule.Builder	withDependency(Rule value)	Add a rule dependency to the rule.
RestRule.Builder	withDescription(String value)	Sets the rule description.
RestRule.Builder	withMaxRetries(Integer value)	Adds a custom max retry count to the rule.
RestRule.Builder	withTag(String tagName, String tagValue)	Adds a tag to the rule.
RestRule.Builder	withTags(Map<String,String> value)	Adds tags to the rule.
RestRule.Builder	withTimeout(Duration value)	Adds a custom timeout to the rule.

Methods inherited from class java.lang.Object

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

Method Details

withClassification

public RestRule.Builder withClassification(String value)

Sets the rule classification.

Parameters:

value - classification

Returns:

RestRule.Builder

withDependency

public RestRule.Builder withDependency(Rule value)

Add a rule dependency to the rule.

Parameters:

value - rule dependency

Returns:

RestRule.Builder

withDependencies

public RestRule.Builder withDependencies(Set<Rule> value)

Add rule dependencies to the rule.

Parameters:

value - rule dependencies

Returns:

RestRule.Builder

withDescription

public RestRule.Builder withDescription(String value)

Sets the rule description.

Parameters:

value - description

Returns:

RestRule.Builder

withTag

public RestRule.Builder withTag(String tagName,
 String tagValue)

Adds a tag to the rule.

Parameters:

tagName - tag name

tagValue - tag value

Returns:

RestRule.Builder

withTags

public RestRule.Builder withTags(Map<String,String> value)

Adds tags to the rule.

Parameters:

value - tags

Returns:

RestRule.Builder

withTimeout

public RestRule.Builder withTimeout(Duration value)

Adds a custom timeout to the rule.

Parameters:

value - timeout

Returns:

RestRule.Builder

withMaxRetries

public RestRule.Builder withMaxRetries(Integer value)

Adds a custom max retry count to the rule.

Parameters:

value - max retries

Returns:

RestRule.Builder

build

public RestRule build()

Creates an instance of RestRule.

Returns:

a RestRule