Package org.zaproxy.clientapi.gen

Class Stats

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.StatsDeprecated

org.zaproxy.clientapi.gen.Stats

public class Stats
extends StatsDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Stats(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	allSitesStats(String keyprefix)	Gets all of the site based statistics, optionally filtered by a key prefix
ApiResponse	clearStats(String keyprefix)	Clears all of the statistics
ApiResponse	optionInMemoryEnabled()	Returns 'true' if in memory statistics are enabled, otherwise returns 'false'
ApiResponse	optionStatsdEnabled()	Returns 'true' if a Statsd server has been correctly configured, otherwise returns 'false'
ApiResponse	optionStatsdHost()	Gets the Statsd service hostname
ApiResponse	optionStatsdPort()	Gets the Statsd service port
ApiResponse	optionStatsdPrefix()	Gets the prefix to be applied to all stats sent to the configured Statsd service
ApiResponse	setOptionInMemoryEnabled(boolean bool)	Sets whether in memory statistics are enabled
ApiResponse	setOptionStatsdHost(String string)	Sets the Statsd service hostname, supply an empty string to stop using a Statsd service
ApiResponse	setOptionStatsdPort(int i)	Sets the Statsd service port
ApiResponse	setOptionStatsdPrefix(String string)	Sets the prefix to be applied to all stats sent to the configured Statsd service
ApiResponse	siteStats(String site, String keyprefix)	Gets all of the global statistics, optionally filtered by a key prefix
ApiResponse	stats(String keyprefix)	Statistics

Methods inherited from class org.zaproxy.clientapi.gen.deprecated.StatsDeprecated

clearStats, setOptionInMemoryEnabled, setOptionStatsdHost, setOptionStatsdPort, setOptionStatsdPrefix

Methods inherited from class java.lang.Object

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

Constructor Details

Stats

public Stats(ClientApi api)

Method Details

stats

public ApiResponse stats(String keyprefix)
                  throws ClientApiException

Statistics

Throws:

ClientApiException

allSitesStats

public ApiResponse allSitesStats(String keyprefix)
                          throws ClientApiException

Gets all of the site based statistics, optionally filtered by a key prefix

Throws:

ClientApiException

siteStats

public ApiResponse siteStats(String site,
 String keyprefix)
                      throws ClientApiException

Gets all of the global statistics, optionally filtered by a key prefix

Throws:

ClientApiException

optionStatsdHost

public ApiResponse optionStatsdHost()
                             throws ClientApiException

Gets the Statsd service hostname

Throws:

ClientApiException

optionStatsdPort

public ApiResponse optionStatsdPort()
                             throws ClientApiException

Gets the Statsd service port

Throws:

ClientApiException

optionStatsdPrefix

public ApiResponse optionStatsdPrefix()
                               throws ClientApiException

Gets the prefix to be applied to all stats sent to the configured Statsd service

Throws:

ClientApiException

optionInMemoryEnabled

public ApiResponse optionInMemoryEnabled()
                                  throws ClientApiException

Returns 'true' if in memory statistics are enabled, otherwise returns 'false'

Throws:

ClientApiException

optionStatsdEnabled

public ApiResponse optionStatsdEnabled()
                                throws ClientApiException

Returns 'true' if a Statsd server has been correctly configured, otherwise returns 'false'

Throws:

ClientApiException

clearStats

public ApiResponse clearStats(String keyprefix)
                       throws ClientApiException

Clears all of the statistics

Throws:

ClientApiException

setOptionStatsdHost

public ApiResponse setOptionStatsdHost(String string)
                                throws ClientApiException

Sets the Statsd service hostname, supply an empty string to stop using a Statsd service

Throws:

ClientApiException

setOptionStatsdPrefix

public ApiResponse setOptionStatsdPrefix(String string)
                                  throws ClientApiException

Sets the prefix to be applied to all stats sent to the configured Statsd service

Throws:

ClientApiException

setOptionInMemoryEnabled

public ApiResponse setOptionInMemoryEnabled(boolean bool)
                                     throws ClientApiException

Sets whether in memory statistics are enabled

Throws:

ClientApiException

setOptionStatsdPort

public ApiResponse setOptionStatsdPort(int i)
                                throws ClientApiException

Sets the Statsd service port

Throws:

ClientApiException