com.splunk

Class ModularInputKind

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.ModularInputKind

All Implemented Interfaces:

Map<String,Object>

public class ModularInputKind
extends Entity

The ModularInputKind class represents a particular modular input. The actual inputs of this kind can be accessed from the InputCollection object.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Map<String,String>>	args

Fields inherited from class com.splunk.Entity

content, toUpdate

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title, updated

Method Summary

Modifier and Type	Method and Description
ModularInputKindArgument	getArgument(String argumentName) Returns a map-like object representing a particular argument of this modular input kind.
Map<String,ModularInputKindArgument>	getArguments() Returns an argument map that contains the argument names as keys, and the ModularInputKindArguments as corresponding values.
String	getDescription() Returns the description of this modular input kind.
String	getStreamingMode() Returns the streaming mode of this modular input kind.
String	getTitle() Returns the title of this modular input kind, which is also displayed in Splunk Web (rather than the name used in the REST API).
boolean	hasArgument(String argumentName) Indicates whether this modular input kind has a given argument.

Methods inherited from class com.splunk.Entity

actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, getContent, getMetadata, isDisabled, isEmpty, isNameChangeAllowed, keySet, put, putAll, refresh, remove, remove, size, update, update, validate, values

Methods inherited from class com.splunk.Resource

getName, getPath, getService, getUpdated, invalidate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

args

protected Map<String,Map<String,String>> args

Method Detail

getArguments

public Map<String,ModularInputKindArgument> getArguments()

Returns an argument map that contains the argument names as keys, and the ModularInputKindArguments as corresponding values.

Returns:

A Map containing the argument key-value pairs.

getStreamingMode

public String getStreamingMode()

Returns the streaming mode of this modular input kind.

Returns:

The streaming mode ("xml" or "simple").

getArgument

public ModularInputKindArgument getArgument(String argumentName)

Returns a map-like object representing a particular argument of this modular input kind.

Parameters:

argumentName - The name of the argument to retrieve.

Returns:

A ModularInputKindArgument object representing the given argument, or null if the argument does not exist.

getDescription

public String getDescription()

Returns the description of this modular input kind.

Returns:

A string containing the description.

getTitle

public String getTitle()

Returns the title of this modular input kind, which is also displayed in Splunk Web (rather than the name used in the REST API).

Overrides:

getTitle in class Resource

Returns:

A string containing the title.

hasArgument

public boolean hasArgument(String argumentName)

Indicates whether this modular input kind has a given argument.

Parameters:

argumentName - The argument to look up.

Returns:

true if the argument exists, false if not.