Package org.zaproxy.clientapi.gen

Class Automation

java.lang.Object

org.zaproxy.clientapi.gen.Automation

public class Automation
extends Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Automation(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	endDelayJob()	Ends the currently running delay job, if any
ApiResponse	planProgress(String planid)	Returns the progress details for the specified planId
ApiResponse	runPlan(String filepath)	Loads and asynchronously runs the plan in the specified file, returning a planId
ApiResponse	stopPlan(String planid)	Stops the running plan identified by the planId

Methods inherited from class java.lang.Object

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

Constructor Details

Automation

public Automation(ClientApi api)

Method Details

planProgress

public ApiResponse planProgress(String planid)
                         throws ClientApiException

Returns the progress details for the specified planId

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

runPlan

public ApiResponse runPlan(String filepath)
                    throws ClientApiException

Loads and asynchronously runs the plan in the specified file, returning a planId

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

stopPlan

public ApiResponse stopPlan(String planid)
                     throws ClientApiException

Stops the running plan identified by the planId

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

endDelayJob

public ApiResponse endDelayJob()
                        throws ClientApiException

Ends the currently running delay job, if any

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException