com.splunk.modularinput

Class Scheme

java.lang.Object

com.splunk.modularinput.Scheme

public class Scheme
extends Object

The Scheme class represents the metadata for a modular input kind. A Scheme specifies a title, description, several options of how Splunk should run modular inputs of this kind, and a set of arguments which define a particular modular input's properties. The primary use of Scheme is to abstract away the construction of XML to feed to Splunk.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scheme.StreamingMode

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Argument>	arguments
protected String	description
protected Scheme.StreamingMode	streamingMode
protected String	title
protected boolean	useExternalValidation
protected boolean	useSingleInstance

Constructor Summary

Constructors

Constructor and Description
Scheme(String title)

Method Summary

Modifier and Type	Method and Description
void	addArgument(Argument argument) Appends an argument to the arguments that this modular input kind takes.
List<Argument>	getArguments() Returns all the arguments to this modular input kind.
String	getDescription() Gets the human readable description of this modular input kind.
Scheme.StreamingMode	getStreamingMode() Returns whether this modular input kind will send events to Splunk as XML (the default and preferred value) or plain text.
String	getTitle() Gets the title of this modular input kind.
boolean	isUseExternalValidation() Returns whether Splunk should use the modular input kind script to validate the arguments of a particular modular input or use the validation predicates specified by the arguments.
boolean	isUseSingleInstance() Returns whether Splunk should run all modular inputs of this kind via one instance of the script or start an instance for each modular input.
void	setArguments(List<Argument> arguments) Replaces the current list of arguments with the specified one.
void	setDescription(String description) Sets the human readable description of this modular input kind.
void	setStreamingMode(Scheme.StreamingMode streamingMode) Specifies whether this modular input kind will send events to Splunk as XML (the default and preferred value) or plain text.
void	setTitle(String title) Sets the title of this modular input kind.
void	setUseExternalValidation(boolean useExternalValidation) Specifies whether Splunk should use the modular input kind script to validate the arguments of a particular modular input (true) or use the validation predicates specified by the arguments (false).
void	setUseSingleInstance(boolean useSingleInstance) Specifies whether Splunk should run all modular inputs of this kind via one instance of the script or start an instance for each modular input.

Methods inherited from class java.lang.Object

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

Field Detail

title

protected String title

description

protected String description

useExternalValidation

protected boolean useExternalValidation

useSingleInstance

protected boolean useSingleInstance

streamingMode

protected Scheme.StreamingMode streamingMode

arguments

protected List<Argument> arguments

Constructor Detail

Scheme

public Scheme(String title)

Method Detail

getTitle

public String getTitle()

Gets the title of this modular input kind.

Returns:

The title of this modular input kind.

setTitle

public void setTitle(String title)

Sets the title of this modular input kind.

Parameters:

title - The title of this modular input kind.

getDescription

public String getDescription()

Gets the human readable description of this modular input kind.

Returns:

The human readable description of this modular input kind.

setDescription

public void setDescription(String description)

Sets the human readable description of this modular input kind.

Parameters:

description - The human readable description of this modular input kind.

isUseExternalValidation

public boolean isUseExternalValidation()

Returns whether Splunk should use the modular input kind script to validate the arguments of a particular modular input or use the validation predicates specified by the arguments.

Returns:

true if Splunk should use the modular input kind script to validate the arguments of a particular modular input, false if it should use the validation predicates specified by the arguments.

setUseExternalValidation

public void setUseExternalValidation(boolean useExternalValidation)

Specifies whether Splunk should use the modular input kind script to validate the arguments of a particular modular input (true) or use the validation predicates specified by the arguments (false).

Parameters:

useExternalValidation - true if Splunk should use the modular input kind script to validate the arguments of a particular modular input, false if it should use the validation predicates specified by the arguments.

isUseSingleInstance

public boolean isUseSingleInstance()

Returns whether Splunk should run all modular inputs of this kind via one instance of the script or start an instance for each modular input.

Returns:

true if Splunk should run all modular inputs of this kind via one instance of the script, false if it should start an instance for each modular input.

setUseSingleInstance

public void setUseSingleInstance(boolean useSingleInstance)

Specifies whether Splunk should run all modular inputs of this kind via one instance of the script or start an instance for each modular input.

Parameters:

useSingleInstance - true if Splunk should run all modular inputs of this kind via one instance of the script, false if it should start an instance for each modular input.

getStreamingMode

public Scheme.StreamingMode getStreamingMode()

Returns whether this modular input kind will send events to Splunk as XML (the default and preferred value) or plain text.

Returns:

The streaming mode.

setStreamingMode

public void setStreamingMode(Scheme.StreamingMode streamingMode)

Specifies whether this modular input kind will send events to Splunk as XML (the default and preferred value) or plain text.

Parameters:

streamingMode - The streaming mode.

getArguments

public List<Argument> getArguments()

Returns all the arguments to this modular input kind.

Returns:

A list of all the arguments to this modular input kind.

setArguments

public void setArguments(List<Argument> arguments)

Replaces the current list of arguments with the specified one.

Parameters:

arguments - The list of arguments with which to replace the current list of arguments.

addArgument

public void addArgument(Argument argument)

Appends an argument to the arguments that this modular input kind takes.

Parameters:

argument - The argument to append to the arguments.