ParallelTaskBuilder (io.parallec:parallec-core 0.10.0 API)

java.lang.Object
- io.parallec.core.ParallelTaskBuilder

```
public class ParallelTaskBuilder
extends Object
```
This class stores all the metadata to build the ParallelTask. It is a Parallec key class. Build the parallel task and then execute it after a validation. During the validation, certain missing parameters will use the default values. execute() is the key function

Author:

Yuanteng (Jeff) Pei

Field Summary

Fields
Modifier and Type Field and Description

TaskRunMode mode
The mode.

Fields
Modifier and Type	Field and Description
`TaskRunMode`	`mode` The mode.

Constructor Summary

Constructors
Constructor and Description

ParallelTaskBuilder()
Instantiates a new parallel task builder.

Constructors
Constructor and Description
`ParallelTaskBuilder()` Instantiates a new parallel task builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ParallelTaskBuilder`	`async()` Execute the task asynchronously.
`ParallelTask`	`execute(ParallecResponseHandler handler)` key function.
`com.ning.http.client.AsyncHttpClient`	`getAsyncHttpClient()` Gets the async http client.
`int`	`getConcurrency()` Gets the concurrency.
`ParallelTaskConfig`	`getConfig()` Gets the config.
`HttpMeta`	`getHttpMeta()` Gets the HttpMeta.
`TaskRunMode`	`getMode()` Gets the mode of either sync or async.
`Map<String,String>`	`getReplacementVarMap()` Gets the replacement var map.
`Map<String,StrStrMap>`	`getReplacementVarMapNodeSpecific()` Gets the replacement var map node specific.
`RequestProtocol`	`getRequestProtocol()` Gets the request protocol.
`RequestReplacementType`	`getRequestReplacementType()` Gets the request replacement type.
`Map<String,Object>`	`getResponseContext()` Gets the response context.
`ITargetHostsBuilder`	`getTargetHostBuilder()` Gets the TargetHostsBuilder.
`TargetHostMeta`	`getTargetHostMeta()` Gets the target host meta.
`List<String>`	`getTargetHosts()` Gets the target hosts.
`TcpMeta`	`getTcpMeta()` Gets the tcp meta.
`UdpMeta`	`getUdpMeta()`
`ParallelTaskBuilder`	`handleInManager()` Call response handler in manager (in a sequence after aggregation) Default mode.
`ParallelTaskBuilder`	`handleInWorker()` Call response handler in operation worker (in parallel before aggregation).
`ParallelTaskBuilder`	`setAsyncHttpClient(com.ning.http.client.AsyncHttpClient asyncHttpClient)` Sets the async http client.
`ParallelTaskBuilder`	`setAutoSaveLogToLocal(boolean autoSaveLogToLocal)` Sets the auto save log to local.
`ParallelTaskBuilder`	`setConcurrency(int concurrency)` Sets the max concurrency.
`ParallelTaskBuilder`	`setConfig(ParallelTaskConfig config)` Sets the config.
`ParallelTaskBuilder`	`setEnableCapacityAwareTaskScheduler(boolean enableCapacityAwareTaskScheduler)` Sets the enable capacity aware task scheduler.
`ParallelTaskBuilder`	`setHttpEntityBody(String body)` Sets the body.
`ParallelTaskBuilder`	`setHttpHeaders(ParallecHeader pheader)` this will create the adhoc header.
`void`	`setHttpMeta(HttpMeta httpMeta)` Sets the HttpMeta.
`ParallelTaskBuilder`	`setHttpPollable(boolean isPollable)` Sets the HTTP pollable.
`ParallelTaskBuilder`	`setHttpPollerProcessor(HttpPollerProcessor httpPollerProcessor)` Sets the HTTP poller processor to handle Async API.
`ParallelTaskBuilder`	`setHttpPort(int port)` Sets the port.
`ParallelTaskBuilder`	`setHttpPortReplaceable(String portVar)` Sets the port variable name such as $PORT
`void`	`setMode(TaskRunMode mode)` Sets the mode.
`ParallelTaskBuilder`	`setPingMode(PingMode mode)` Sets the ping mode.
`ParallelTaskBuilder`	`setPingNumRetries(int numRetries)` Sets the ping num retries.
`ParallelTaskBuilder`	`setPingTimeoutMillis(int pingTimeoutMillis)` Sets the ping timeout millis.
`ParallelTaskBuilder`	`setProtocol(RequestProtocol protocol)` Sets the protocol.
`ParallelTaskBuilder`	`setReplacementVarMap(Map<String,String> replacementVarMap)` Sets the replacement var map.
`ParallelTaskBuilder`	`setReplacementVarMapNodeSpecific(Map<String,StrStrMap> replacementVarMapNodeSpecific)` Sets the replacement var map node specific.
`ParallelTaskBuilder`	`setReplaceVarMapToSingleTarget(List<StrStrMap> replacementVarMapList, String uniformTargetHost)` Sets the replace var map to single target.
`ParallelTaskBuilder`	`setReplaceVarMapToSingleTargetFromMap(Map<String,StrStrMap> replacementVarMapNodeSpecific, String uniformTargetHost)` Sets the replace var map to single target from map.
`ParallelTaskBuilder`	`setReplaceVarMapToSingleTargetSingleVar(String variable, List<String> replaceList, String uniformTargetHost)` Sets the replace var map to single target single var.
`ParallelTaskBuilder`	`setRequestReplacementType(RequestReplacementType requestReplacementType)` Sets the request replacement type.
`ParallelTaskBuilder`	`setResponseContext(Map<String,Object> responseContext)` Sets the response context.
`ParallelTaskBuilder`	`setRunAsSuperUser(Boolean runAsSuperUser)` Sets the ssh runAsSuperUser
`ParallelTaskBuilder`	`setSaveResponseToTask(boolean saveResponseToTask)` Sets the save response to task.
`ParallelTaskBuilder`	`setSshCommandLine(String commandLine)` Sets the ssh command line.
`ParallelTaskBuilder`	`setSshConnectionTimeoutMillis(int sshConnectionTimeoutMillis)` Sets the ssh connection timeout millis.
`ParallelTaskBuilder`	`setSshLoginType(SshLoginType sshLoginType)` Sets the ssh login type.
`ParallelTaskBuilder`	`setSshPassword(String password)` Sets the ssh password.
`ParallelTaskBuilder`	`setSshPort(int sshPort)` Sets the ssh port.
`ParallelTaskBuilder`	`setSshPrivKeyRelativePath(String privKeyRelativePath)` Sets the ssh priv key relative path.
`ParallelTaskBuilder`	`setSshPrivKeyRelativePathWtihPassphrase(String privKeyRelativePath, String passphrase)` Sets the ssh priv key relative path wtih passphrase.
`ParallelTaskBuilder`	`setSshUserName(String userName)` Sets the ssh user name.
`void`	`setTargetHostBuilder(ITargetHostsBuilder thb)` Sets the TargetHostsBuilder.
`void`	`setTargetHostMeta(TargetHostMeta targetHostMeta)` Sets the target host meta.
`ParallelTaskBuilder`	`setTargetHostsFromCmsQueryUrl(String cmsQueryUrl)` Sets the target hosts from cms query url.
`ParallelTaskBuilder`	`setTargetHostsFromCmsQueryUrl(String cmsQueryUrl, String projection)` CMS: configuration-management-service.
`ParallelTaskBuilder`	`setTargetHostsFromJsonPath(String jsonPath, String sourcePath, HostsSourceType sourceType)` Sets the target hosts from json path.
`ParallelTaskBuilder`	`setTargetHostsFromLineByLineText(String sourcePath, HostsSourceType sourceType)` Sets the target hosts from line by line text.
`ParallelTaskBuilder`	`setTargetHostsFromList(List<String> targetHosts)` Sets the target hosts from list.
`ParallelTaskBuilder`	`setTargetHostsFromString(String targetHostsStr)` Sets the target hosts from string.
`ParallelTaskBuilder`	`setTcpChannelFactory(org.jboss.netty.channel.ChannelFactory channelFactory)` Sets the tcp channel factory.
`ParallelTaskBuilder`	`setTcpConnectTimeoutMillis(int tcpConnectTimeoutMillis)` Sets the tcp connect timeout millis.
`ParallelTaskBuilder`	`setTcpIdleTimeoutSec(int tcpIdleTimeoutSec)` Sets the tcp idle timeout sec.
`void`	`setTcpMeta(TcpMeta tcpMeta)` Sets the tcp meta.
`ParallelTaskBuilder`	`setTcpPort(int tcpPort)` Sets the tcp port.
`ParallelTaskBuilder`	`setUdpIdleTimeoutSec(int udpIdleTimeoutSec)` Sets the udp read(idle) timeout millis.
`void`	`setUdpMeta(UdpMeta udpMeta)`
`ParallelTaskBuilder`	`setUdpPort(int udpPort)` Sets the udp port.
`ParallelTaskBuilder`	`sync()` Execute the task synchronously (the default run mode).
`String`	`toString()`
`boolean`	`validation()` add some validation to see if this miss anything.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - mode
```
public TaskRunMode mode
```
    The mode.
- Constructor Detail
  - ParallelTaskBuilder
```
public ParallelTaskBuilder()
```
    Instantiates a new parallel task builder.
- Method Detail
  - getResponseContext
```
public Map<String,Object> getResponseContext()
```
    Gets the response context.
    
    Returns:
    
    the response context
  - setResponseContext
```
public ParallelTaskBuilder setResponseContext(Map<String,Object> responseContext)
```
    Sets the response context.
    
    Parameters:
    
    responseContext - the response context
    
    Returns:
    
    the parallel task builder
  - handleInWorker
```
public ParallelTaskBuilder handleInWorker()
```
    Call response handler in operation worker (in parallel before aggregation). Handle the user defined onComplete() function in worker before aggregation (handle in parallel). Be cautious on concurrency control if save the response to a common data store Also when you definte the concurrency control, take into account of the time needed to hander the response.
    
    Returns:
    
    the parallel task builder
  - handleInManager
```
public ParallelTaskBuilder handleInManager()
```
    Call response handler in manager (in a sequence after aggregation) Default mode. In this mode, will trigger the user defined response hander after response is passed back from worker to manager. This is the default mode. Be cautious on using long blocking operation in the handler onComplete() function Since it is handled in manager, a long sync operation may block the whole flow because each response will need to go through here.
    
    Returns:
    
    the parallel task builder
  - async
```
public ParallelTaskBuilder async()
```
    Execute the task asynchronously.
    
    Returns:
    
    the parallel task builder
  - sync
```
public ParallelTaskBuilder sync()
```
    Execute the task synchronously (the default run mode).
    
    Returns:
    
    the parallel task builder
  - setMode
```
public void setMode(TaskRunMode mode)
```
    Sets the mode.
    
    Parameters:
    
    mode - the new mode
  - execute
```
public ParallelTask execute(ParallecResponseHandler handler)
```
    key function. first validate if the ACM has adequate data; then execute it after the validation. the new ParallelTask task guareetee to have the targethost meta and command meta not null
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the parallel task
  - validation
```
public boolean validation()
                   throws ParallelTaskInvalidException
```
    add some validation to see if this miss anything.
    
    Returns:
    
    true, if successful
    
    Throws:
    
    ParallelTaskInvalidException - the parallel task invalid exception
  - setProtocol
```
public ParallelTaskBuilder setProtocol(RequestProtocol protocol)
```
    Sets the protocol.
    
    Parameters:
    
    protocol - the protocol
    
    Returns:
    
    the parallel task builder
  - setConcurrency
```
public ParallelTaskBuilder setConcurrency(int concurrency)
```
    Sets the max concurrency.
    
    Parameters:
    
    concurrency - the concurrency
    
    Returns:
    
    the parallel task builder
  - setHttpEntityBody
```
public ParallelTaskBuilder setHttpEntityBody(String body)
```
    Sets the body.
    
    Parameters:
    
    body - the body
    
    Returns:
    
    the parallel task builder
  - setHttpHeaders
```
public ParallelTaskBuilder setHttpHeaders(ParallecHeader pheader)
```
    this will create the adhoc header.
    
    Parameters:
    
    pheader - the pheader
    
    Returns:
    
    the parallel task builder
  - setHttpPort
```
public ParallelTaskBuilder setHttpPort(int port)
```
    Sets the port.
    
    Parameters:
    
    port - the port
    
    Returns:
    
    the parallel task builder
  - setHttpPortReplaceable
```
public ParallelTaskBuilder setHttpPortReplaceable(String portVar)
```
    Sets the port variable name such as $PORT
    
    Parameters:
    
    portVar - the port
    
    Returns:
    
    the parallel task builder
  - setAsyncHttpClient
```
public ParallelTaskBuilder setAsyncHttpClient(com.ning.http.client.AsyncHttpClient asyncHttpClient)
```
    Sets the async http client.
    
    Parameters:
    
    asyncHttpClient - the async http client
    
    Returns:
    
    the parallel task builder
  - getHttpMeta
```
public HttpMeta getHttpMeta()
```
    Gets the HttpMeta.
    
    Returns:
    
    the httpMeta
  - setHttpMeta
```
public void setHttpMeta(HttpMeta httpMeta)
```
    Sets the HttpMeta.
    
    Parameters:
    
    httpMeta - the new httpMeta
  - getAsyncHttpClient
```
public com.ning.http.client.AsyncHttpClient getAsyncHttpClient()
```
    Gets the async http client.
    
    Returns:
    
    the async http client
  - getTargetHosts
```
public List<String> getTargetHosts()
```
    Gets the target hosts.
    
    Returns:
    
    the target hosts
  - setTargetHostsFromList
```
public ParallelTaskBuilder setTargetHostsFromList(List<String> targetHosts)
```
    Sets the target hosts from list.
    
    Parameters:
    
    targetHosts - the target hosts
    
    Returns:
    
    the parallel task builder
  - setTargetHostsFromString
```
public ParallelTaskBuilder setTargetHostsFromString(String targetHostsStr)
```
    Sets the target hosts from string.
    
    Parameters:
    
    targetHostsStr - the target hosts str
    
    Returns:
    
    the parallel task builder
  - setTargetHostsFromJsonPath
```
public ParallelTaskBuilder setTargetHostsFromJsonPath(String jsonPath,
                                                      String sourcePath,
                                                      HostsSourceType sourceType)
                                               throws TargetHostsLoadException
```
    Sets the target hosts from json path.
    
    Parameters:
    
    jsonPath - the json path
    
    sourcePath - the source path
    
    sourceType - the source type
    
    Returns:
    
    the parallel task builder
    
    Throws:
    
    TargetHostsLoadException - the target hosts load exception
  - setTargetHostsFromLineByLineText
```
public ParallelTaskBuilder setTargetHostsFromLineByLineText(String sourcePath,
                                                            HostsSourceType sourceType)
                                                     throws TargetHostsLoadException
```
    Sets the target hosts from line by line text.
    
    Parameters:
    
    sourcePath - the source path
    
    sourceType - the source type
    
    Returns:
    
    the parallel task builder
    
    Throws:
    
    TargetHostsLoadException - the target hosts load exception
  - setTargetHostsFromCmsQueryUrl
```
public ParallelTaskBuilder setTargetHostsFromCmsQueryUrl(String cmsQueryUrl)
                                                  throws TargetHostsLoadException
```
    Sets the target hosts from cms query url.
    
    Parameters:
    
    cmsQueryUrl - the cms query url
    
    Returns:
    
    the parallel task builder
    
    Throws:
    
    TargetHostsLoadException - the target hosts load exception
  - setTargetHostsFromCmsQueryUrl
```
public ParallelTaskBuilder setTargetHostsFromCmsQueryUrl(String cmsQueryUrl,
                                                         String projection)
                                                  throws TargetHostsLoadException
```
    CMS: configuration-management-service. A.k.a. YiDB: http://www.yidb.org/ Parallec supports CMS query http://ccoetech.ebay.com/cms-configuration-management-service-based- mongodb
    
    Parameters:
    
    cmsQueryUrl - the cms query url
    
    projection - the projection
    
    Returns:
    
    the parallel task builder
    
    Throws:
    
    TargetHostsLoadException - the target hosts load exception
  - getTargetHostBuilder
```
public ITargetHostsBuilder getTargetHostBuilder()
```
    Gets the TargetHostsBuilder.
    
    Returns:
    
    the thb
  - setTargetHostBuilder
```
public void setTargetHostBuilder(ITargetHostsBuilder thb)
```
    Sets the TargetHostsBuilder.
    
    Parameters:
    
    thb - the new thb
  - getMode
```
public TaskRunMode getMode()
```
    Gets the mode of either sync or async.
    
    Returns:
    
    the mode
  - getTargetHostMeta
```
public TargetHostMeta getTargetHostMeta()
```
    Gets the target host meta.
    
    Returns:
    
    the target host meta
  - setTargetHostMeta
```
public void setTargetHostMeta(TargetHostMeta targetHostMeta)
```
    Sets the target host meta.
    
    Parameters:
    
    targetHostMeta - the new target host meta
  - getReplacementVarMapNodeSpecific
```
public Map<String,StrStrMap> getReplacementVarMapNodeSpecific()
```
    Gets the replacement var map node specific.
    
    Returns:
    
    the replacement var map node specific
  - setReplacementVarMapNodeSpecific
```
public ParallelTaskBuilder setReplacementVarMapNodeSpecific(Map<String,StrStrMap> replacementVarMapNodeSpecific)
```
    Sets the replacement var map node specific.
    
    Parameters:
    
    replacementVarMapNodeSpecific - the replacement var map node specific
    
    Returns:
    
    the parallel task builder
  - setReplaceVarMapToSingleTargetFromMap
```
public ParallelTaskBuilder setReplaceVarMapToSingleTargetFromMap(Map<String,StrStrMap> replacementVarMapNodeSpecific,
                                                                 String uniformTargetHost)
```
    Sets the replace var map to single target from map.
    
    Parameters:
    
    replacementVarMapNodeSpecific - the replacement var map node specific
    
    uniformTargetHost - the uniform target host
    
    Returns:
    
    the parallel task builder
  - setReplaceVarMapToSingleTargetSingleVar
```
public ParallelTaskBuilder setReplaceVarMapToSingleTargetSingleVar(String variable,
                                                                   List<String> replaceList,
                                                                   String uniformTargetHost)
```
    Sets the replace var map to single target single var.
    
    Parameters:
    
    variable - the variable
    
    replaceList - : the list of strings that will replace the variable
    
    uniformTargetHost - the uniform target host
    
    Returns:
    
    the parallel task builder
  - setReplaceVarMapToSingleTarget
```
public ParallelTaskBuilder setReplaceVarMapToSingleTarget(List<StrStrMap> replacementVarMapList,
                                                          String uniformTargetHost)
```
    Sets the replace var map to single target.
    
    Parameters:
    
    replacementVarMapList - the replacement var map list
    
    uniformTargetHost - the uniform target host
    
    Returns:
    
    the parallel task builder
  - getReplacementVarMap
```
public Map<String,String> getReplacementVarMap()
```
    Gets the replacement var map.
    
    Returns:
    
    the replacement var map
  - setReplacementVarMap
```
public ParallelTaskBuilder setReplacementVarMap(Map<String,String> replacementVarMap)
```
    Sets the replacement var map.
    
    Parameters:
    
    replacementVarMap - the replacement var map
    
    Returns:
    
    the parallel task builder
  - getRequestReplacementType
```
public RequestReplacementType getRequestReplacementType()
```
    Gets the request replacement type.
    
    Returns:
    
    the request replacement type
  - setRequestReplacementType
```
public ParallelTaskBuilder setRequestReplacementType(RequestReplacementType requestReplacementType)
```
    Sets the request replacement type.
    
    Parameters:
    
    requestReplacementType - the new request replacement type
    
    Returns:
    
    the parallel task builder
  - setHttpPollable
```
public ParallelTaskBuilder setHttpPollable(boolean isPollable)
```
    Sets the HTTP pollable. if the task is for an async API that needs to poll progress.
    
    Parameters:
    
    isPollable - the is pollable
    
    Returns:
    
    the parallel task builder
  - setHttpPollerProcessor
```
public ParallelTaskBuilder setHttpPollerProcessor(HttpPollerProcessor httpPollerProcessor)
```
    Sets the HTTP poller processor to handle Async API. Will auto enable the pollable mode with this call
    
    Parameters:
    
    httpPollerProcessor - the http poller processor
    
    Returns:
    
    the parallel task builder
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setSshCommandLine
```
public ParallelTaskBuilder setSshCommandLine(String commandLine)
```
    Sets the ssh command line.
    
    Parameters:
    
    commandLine - the command line
    
    Returns:
    
    the parallel task builder
  - setRunAsSuperUser
```
public ParallelTaskBuilder setRunAsSuperUser(Boolean runAsSuperUser)
```
    Sets the ssh runAsSuperUser
    
    Parameters:
    
    runAsSuperUser - the runAsSuperUser
    
    Returns:
    
    the parallel task builder
  - setSshPort
```
public ParallelTaskBuilder setSshPort(int sshPort)
```
    Sets the ssh port.
    
    Parameters:
    
    sshPort - the ssh port
    
    Returns:
    
    the parallel task builder
  - setSshUserName
```
public ParallelTaskBuilder setSshUserName(String userName)
```
    Sets the ssh user name.
    
    Parameters:
    
    userName - the user name
    
    Returns:
    
    the parallel task builder
  - setSshPassword
```
public ParallelTaskBuilder setSshPassword(String password)
```
    Sets the ssh password.
    
    Parameters:
    
    password - the password
    
    Returns:
    
    the parallel task builder
  - setSshLoginType
```
public ParallelTaskBuilder setSshLoginType(SshLoginType sshLoginType)
```
    Sets the ssh login type.
    
    Parameters:
    
    sshLoginType - the ssh login type
    
    Returns:
    
    the parallel task builder
  - setSshPrivKeyRelativePath
```
public ParallelTaskBuilder setSshPrivKeyRelativePath(String privKeyRelativePath)
```
    Sets the ssh priv key relative path. Note that must be relative path for now. This default to no need of passphrase for the private key. Will also auto set the login type to key based.
    
    Parameters:
    
    privKeyRelativePath - the priv key relative path
    
    Returns:
    
    the parallel task builder
  - setSshPrivKeyRelativePathWtihPassphrase
```
public ParallelTaskBuilder setSshPrivKeyRelativePathWtihPassphrase(String privKeyRelativePath,
                                                                   String passphrase)
```
    Sets the ssh priv key relative path wtih passphrase.
    
    Parameters:
    
    privKeyRelativePath - the priv key relative path
    
    passphrase - the passphrase
    
    Returns:
    
    the parallel task builder
  - setSshConnectionTimeoutMillis
```
public ParallelTaskBuilder setSshConnectionTimeoutMillis(int sshConnectionTimeoutMillis)
```
    Sets the ssh connection timeout millis.
    
    Parameters:
    
    sshConnectionTimeoutMillis - the ssh connection timeout millis
    
    Returns:
    
    the parallel task builder
  - setTcpPort
```
public ParallelTaskBuilder setTcpPort(int tcpPort)
```
    Sets the tcp port.
    
    Parameters:
    
    tcpPort - the tcp port
    
    Returns:
    
    the parallel task builder
  - setTcpConnectTimeoutMillis
```
public ParallelTaskBuilder setTcpConnectTimeoutMillis(int tcpConnectTimeoutMillis)
```
    Sets the tcp connect timeout millis.
    
    Parameters:
    
    tcpConnectTimeoutMillis - the tcp connect timeout millis
    
    Returns:
    
    the parallel task builder
  - setTcpIdleTimeoutSec
```
public ParallelTaskBuilder setTcpIdleTimeoutSec(int tcpIdleTimeoutSec)
```
    Sets the tcp idle timeout sec.
    
    Parameters:
    
    tcpIdleTimeoutSec - the tcp idle timeout sec
    
    Returns:
    
    the parallel task builder
  - setTcpChannelFactory
```
public ParallelTaskBuilder setTcpChannelFactory(org.jboss.netty.channel.ChannelFactory channelFactory)
```
    Sets the tcp channel factory.
    
    Parameters:
    
    channelFactory - the channel factory
    
    Returns:
    
    the parallel task builder
  - setUdpPort
```
public ParallelTaskBuilder setUdpPort(int udpPort)
```
    Sets the udp port.
    
    Parameters:
    
    udpPort - the udp port
    
    Returns:
    
    the parallel task builder
  - setUdpIdleTimeoutSec
```
public ParallelTaskBuilder setUdpIdleTimeoutSec(int udpIdleTimeoutSec)
```
    Sets the udp read(idle) timeout millis.
    
    Parameters:
    
    udpIdleTimeoutSec - the udp read timeout millis
    
    Returns:
    
    the parallel task builder
  - setConfig
```
public ParallelTaskBuilder setConfig(ParallelTaskConfig config)
```
    Sets the config.
    
    Parameters:
    
    config - the config
    
    Returns:
    
    the parallel task builder
  - getConfig
```
public ParallelTaskConfig getConfig()
```
    Gets the config.
    
    Returns:
    
    the config
  - setSaveResponseToTask
```
public ParallelTaskBuilder setSaveResponseToTask(boolean saveResponseToTask)
```
    Sets the save response to task.
    
    Parameters:
    
    saveResponseToTask - the save response to task
    
    Returns:
    
    the parallel task builder
  - setEnableCapacityAwareTaskScheduler
```
public ParallelTaskBuilder setEnableCapacityAwareTaskScheduler(boolean enableCapacityAwareTaskScheduler)
```
    Sets the enable capacity aware task scheduler. OPTIONAL. DEFAULT: false.
    
    Parameters:
    
    enableCapacityAwareTaskScheduler - the enable capacity aware task scheduler
    
    Returns:
    
    the parallel task builder
  - setAutoSaveLogToLocal
```
public ParallelTaskBuilder setAutoSaveLogToLocal(boolean autoSaveLogToLocal)
```
    Sets the auto save log to local. Will auto save logs to the local file system. The logs by default are written to path "userdata/task/logs" folder. Note that it is user's responsibility to clearn these logs. OPTIONAL. DEFAULT: false.
    
    Parameters:
    
    autoSaveLogToLocal - the auto save log to local
    
    Returns:
    
    the parallel task builder
  - getTcpMeta
```
public TcpMeta getTcpMeta()
```
    Gets the tcp meta.
    
    Returns:
    
    the tcp meta
  - setTcpMeta
```
public void setTcpMeta(TcpMeta tcpMeta)
```
    Sets the tcp meta.
    
    Parameters:
    
    tcpMeta - the new tcp meta
  - getRequestProtocol
```
public RequestProtocol getRequestProtocol()
```
    Gets the request protocol.
    
    Returns:
    
    the request protocol
  - getConcurrency
```
public int getConcurrency()
```
    Gets the concurrency.
    
    Returns:
    
    the concurrency
  - setPingMode
```
public ParallelTaskBuilder setPingMode(PingMode mode)
```
    Sets the ping mode. Process or INET_ADDRESS_REACHABLE based. Default as InetAddress mode. InetAddress requires Root privilege.
    
    Parameters:
    
    mode - the mode
    
    Returns:
    
    the parallel task builder
  - setPingTimeoutMillis
```
public ParallelTaskBuilder setPingTimeoutMillis(int pingTimeoutMillis)
```
    Sets the ping timeout millis.
    
    Parameters:
    
    pingTimeoutMillis - the ping timeout millis
    
    Returns:
    
    the parallel task builder
  - setPingNumRetries
```
public ParallelTaskBuilder setPingNumRetries(int numRetries)
```
    Sets the ping num retries.
    
    Parameters:
    
    numRetries - the num retries
    
    Returns:
    
    the parallel task builder
  - getUdpMeta
```
public UdpMeta getUdpMeta()
```
  - setUdpMeta
```
public void setUdpMeta(UdpMeta udpMeta)
```

Class ParallelTaskBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mode

Constructor Detail

ParallelTaskBuilder

Method Detail

getResponseContext

setResponseContext

handleInWorker

handleInManager

async

sync

setMode

execute

validation

setProtocol

setConcurrency

setHttpEntityBody

setHttpHeaders

setHttpPort

setHttpPortReplaceable

setAsyncHttpClient

getHttpMeta

setHttpMeta

getAsyncHttpClient

getTargetHosts

setTargetHostsFromList

setTargetHostsFromString

setTargetHostsFromJsonPath

setTargetHostsFromLineByLineText

setTargetHostsFromCmsQueryUrl

setTargetHostsFromCmsQueryUrl

getTargetHostBuilder

setTargetHostBuilder

getMode

getTargetHostMeta

setTargetHostMeta

getReplacementVarMapNodeSpecific

setReplacementVarMapNodeSpecific

setReplaceVarMapToSingleTargetFromMap

setReplaceVarMapToSingleTargetSingleVar

setReplaceVarMapToSingleTarget

getReplacementVarMap

setReplacementVarMap

getRequestReplacementType

setRequestReplacementType

setHttpPollable

setHttpPollerProcessor

toString

setSshCommandLine

setRunAsSuperUser

setSshPort

setSshUserName

setSshPassword

setSshLoginType

setSshPrivKeyRelativePath

setSshPrivKeyRelativePathWtihPassphrase

setSshConnectionTimeoutMillis

setTcpPort

setTcpConnectTimeoutMillis

setTcpIdleTimeoutSec

setTcpChannelFactory

setUdpPort

setUdpIdleTimeoutSec

setConfig

getConfig

setSaveResponseToTask

setEnableCapacityAwareTaskScheduler

setAutoSaveLogToLocal

getTcpMeta

setTcpMeta

getRequestProtocol

getConcurrency

setPingMode

setPingTimeoutMillis

setPingNumRetries