org.zaproxy.zap.extension.api

Class ApiParameter

java.lang.Object

org.zaproxy.zap.extension.api.ApiParameter

public class ApiParameter
extends Object

A parameter of an ApiElement.

Since:

2.9.0

Method Summary

Modifier and Type	Method and Description
String	getDescriptionKey() Gets the resource key of the description.
String	getName() Gets the name.
boolean	isRequired() Tells whether or not the parameter is required.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Gets the name.

Returns:

the name, never null.

getDescriptionKey

public String getDescriptionKey()

Gets the resource key of the description.

Returns:

the key of the description, never null.

See Also:

I18N.getString(String)

isRequired

public boolean isRequired()

Tells whether or not the parameter is required.

Returns:

true if the parameter is required, false otherwise.