com.splunk.modularinput

Class Argument

java.lang.Object

com.splunk.modularinput.Argument

public class Argument
extends Object

The Argument class represents an argument to a modular input kind. Argument is meant to be used with Scheme to generate an XML definition of the modular input kind that Splunk understands.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Argument.DataType

Field Summary

Fields

Modifier and Type	Field and Description
protected Argument.DataType	dataType
protected String	description
protected String	name
protected boolean	requiredOnCreate
protected boolean	requiredOnEdit
protected String	validation

Constructor Summary

Constructors

Constructor and Description
Argument(String name)

Method Summary

Modifier and Type	Method and Description
void	addToDocument(Document doc, Node parent) Returns an Element object representing this argument that can be added to another XML document for the Scheme.
Argument.DataType	getDataType() Gets the data type of this argument.
String	getDescription() Gets the human readable description of this argument.
String	getName() Gets the name that Splunk uses to represent this argument.
String	getValidation() Gets the validation to be used on this argument, if using internal validation.
boolean	isRequiredOnCreate() Returns whether a value for this argument must be specified when creating a modular input of this kind.
boolean	isRequiredOnEdit() Returns whether a value for this argument must be specified when editing an existing modular input of this kind.
void	setDataType(Argument.DataType dataType) Sets the data type of this argument.
void	setDescription(String description) Sets the human readable description of this argument.
void	setName(String name) Sets the name that Splunk will use to represent this argument.
void	setRequiredOnCreate(boolean requiredOnCreate) Sets whether a value for this argument must be specified when creating a modular input of this kind.
void	setRequiredOnEdit(boolean requiredOnEdit) Sets whether a value for this argument must be specified when editing an existing modular input of this kind.
void	setValidation(String validation) Sets the validation string that internal validation should use on this argument.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

description

protected String description

validation

protected String validation

dataType

protected Argument.DataType dataType

requiredOnEdit

protected boolean requiredOnEdit

requiredOnCreate

protected boolean requiredOnCreate

Constructor Detail

Argument

public Argument(String name)

Method Detail

getName

public String getName()

Gets the name that Splunk uses to represent this argument.

Returns:

The argument's name.

setName

public void setName(String name)

Sets the name that Splunk will use to represent this argument.

Parameters:

name - The name that Splunk will use to represent this argument.

getDescription

public String getDescription()

Gets the human readable description of this argument.

Returns:

The argument's description.

setDescription

public void setDescription(String description)

Sets the human readable description of this argument.

Parameters:

description - The human readable description of this argument.

getValidation

public String getValidation()

Gets the validation to be used on this argument, if using internal validation.

Returns:

The validation used on the argument.

setValidation

public void setValidation(String validation)

Sets the validation string that internal validation should use on this argument.

Parameters:

validation - The validation string that internal validation should use on this argument.

getDataType

public Argument.DataType getDataType()

Gets the data type of this argument.

Returns:

The data type of the argument.

setDataType

public void setDataType(Argument.DataType dataType)

Sets the data type of this argument.

Parameters:

dataType - The data type of this argument.

isRequiredOnEdit

public boolean isRequiredOnEdit()

Returns whether a value for this argument must be specified when editing an existing modular input of this kind.

Returns:

true if a value for this argument must be specified when editing an existing modular input of this kind, false if not.

setRequiredOnEdit

public void setRequiredOnEdit(boolean requiredOnEdit)

Sets whether a value for this argument must be specified when editing an existing modular input of this kind.

Parameters:

requiredOnEdit - true if a value for this argument must be specified when editing an existing modular input of this kind, false if not.

isRequiredOnCreate

public boolean isRequiredOnCreate()

Returns whether a value for this argument must be specified when creating a modular input of this kind.

Returns:

true if a value for this argument must be specified when creating a modular input of this kind, false if not.

setRequiredOnCreate

public void setRequiredOnCreate(boolean requiredOnCreate)

Sets whether a value for this argument must be specified when creating a modular input of this kind.

Parameters:

requiredOnCreate - true if a value for this argument must be specified when creating a modular input of this kind, false if not.

addToDocument

public void addToDocument(Document doc,
                          Node parent)

Returns an Element object representing this argument that can be added to another XML document for the Scheme.

Parameters:

doc - The XML document.

parent - The parent object.