com.splunk

Class InputCollection

java.lang.Object

com.splunk.Resource

com.splunk.ResourceCollection<T>

com.splunk.EntityCollection<Input>

com.splunk.InputCollection

All Implemented Interfaces:

Map<String,Input>

public class InputCollection
extends EntityCollection<Input>

The InputCollection class represents a collection of inputs. The collection is heterogeneous and each member contains an InputKind value that indicates the specific type of input.

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 Set<InputKind>	inputKinds

Fields inherited from class com.splunk.ResourceCollection

itemClass, items

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title, updated

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(Object key)
Input	create(String name) Creates a stub for a new data input.
<T extends Input> T	create(String name, InputKind kind) Creates a new data input based on the input kind.
<T extends Input> T	create(String name, InputKind kind, Map<String,Object> args) Creates a new data input based on the input kind and additional arguments.
Input	create(String name, Map args) Creates a stub for a new data input based on additional arguments.
protected Input	createItem(AtomEntry entry) Creates a new data input based on an Atom entry.
Input	get(Object key) Gets the value of a given key, if it exists within this collection.
Input	get(Object key, Args namespace) Returns the value of a scoped, namespace-constrained key, if it exists within this collection.
Set<InputKind>	getInputKinds() Return a set of all the input kinds recognized by the Splunk server.
protected InputKind	itemKind(String path) Returns the input kind for a given path.
protected static boolean	matchesInputName(InputKind kind, String searchFor, String searchIn) Indicates whether a given string matches the input name (string equality).
InputCollection	refresh() Refreshes this input collection.
Input	remove(String key) Removes an entity from this collection.
Input	remove(String key, Args namespace) Removes an entity from this collection, with a namespace restriction.

Methods inherited from class com.splunk.ResourceCollection

clear, containsKey, containsValue, createItem, entrySet, equals, hashCode, isEmpty, itemKey, itemPath, keySet, list, put, putAll, remove, size, validate, values, valueSize

Methods inherited from class com.splunk.Resource

getName, getPath, getService, getTitle, getUpdated, invalidate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Field Detail

inputKinds

protected Set<InputKind> inputKinds

Method Detail

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Input>

Overrides:

containsKey in class ResourceCollection<Input>

create

public Input create(String name)

Creates a stub for a new data input.

Overrides:

create in class EntityCollection<Input>

Parameters:

name - Depending on the type of input, a string that contains:

• The filename or directory and path (for monitor and oneshot inputs)
• The script name (for script inputs)
• The port number (for TCP and UDP inputs)
• The collection name (for Windows Perfmon and WMI inputs)
• The stanza (for Windows Registry inputs)
• The name of the configuration (for Windows AD inputs)

Returns:

No return value.

Throws:

UnsupportedOperationException - The UnsupportedOperationException instance

create

public Input create(String name,
                    Map args)

Creates a stub for a new data input based on additional arguments.

Overrides:

create in class EntityCollection<Input>

Parameters:

name - Depending on the type of data input, a string that contains:

• The filename or directory and path (for monitor and oneshot inputs)
• The script name (for script inputs)
• The port number (for TCP and UDP inputs)
• The collection name (for Windows Perfmon and WMI inputs)
• The stanza (for Windows Registry inputs)
• The name of the configuration (for Windows AD inputs)

args - Optional arguments to define the data input. For a list of the available parameters, see Input parameters on dev.splunk.com.

Returns:

No return value.

Throws:

UnsupportedOperationException - The UnsupportedOperationException instance

create

public <T extends Input> T create(String name,
                                  InputKind kind)

Creates a new data input based on the input kind.

Type Parameters:

T - The implicit type of the input.

Parameters:

name - Depending on the type of data input, a string that contains:

• The filename or directory and path (for monitor and oneshot inputs)
• The script name (for script inputs)
• The port number (for TCP and UDP inputs)
• The collection name (for Windows Perfmon and WMI inputs)
• The stanza (for Windows Registry inputs)
• The name of the configuration (for Windows AD inputs)

kind - A member of InputKind, indicating the type of input.

Returns:

The Input that was created.

create

public <T extends Input> T create(String name,
                                  InputKind kind,
                                  Map<String,Object> args)

Creates a new data input based on the input kind and additional arguments.

Type Parameters:

T - The implicit type of the input.

Parameters:

name - Depending on the type of data input, a string that contains:

• The filename or directory and path (for monitor and oneshot inputs)
• The script name (for script inputs)
• The port number (for TCP and UDP inputs)
• The collection name (for Windows Perfmon and WMI inputs)
• The stanza (for Windows Registry inputs)
• The name of the configuration (for Windows AD inputs)

kind - A member of InputKind, indicating the type of input.

args - Optional arguments to define the data input. For a list of the available parameters, see Input parameters on dev.splunk.com.

Returns:

The Input that was created.

createItem

protected Input createItem(AtomEntry entry)

Creates a new data input based on an Atom entry.

Overrides:

createItem in class ResourceCollection<Input>

Parameters:

entry - The AtomEntry object describing the entry.

Returns:

The Input that was created.

get

public Input get(Object key)

Gets the value of a given key, if it exists within this collection.

Specified by:

get in interface Map<String,Input>

Overrides:

get in class ResourceCollection<Input>

Parameters:

key - The key to look up.

Returns:

The value indexed by the key, or null if it doesn't exist.

get

public Input get(Object key,
                 Args namespace)

Returns the value of a scoped, namespace-constrained key, if it exists within this collection.

Overrides:

get in class ResourceCollection<Input>

Parameters:

key - The key to look up.

namespace - The namespace to constrain the search to.

Returns:

The value indexed by the key, or null if it doesn't exist.

itemKind

protected InputKind itemKind(String path)

Returns the input kind for a given path.

Parameters:

path - The relative endpoint path (the path that follows data/inputs).

Returns:

A member of InputKind, indicating the type of input.

getInputKinds

public Set<InputKind> getInputKinds()

Return a set of all the input kinds recognized by the Splunk server.

Returns:

A set of InputKinds.

matchesInputName

protected static boolean matchesInputName(InputKind kind,
                                          String searchFor,
                                          String searchIn)

Indicates whether a given string matches the input name (string equality). For scripted inputs, which are listed by their full path, this method compares only the final component of the filename for a match.

Parameters:

kind - A member of InputKind, indicating the type of input.

searchFor - A string to search for.

searchIn - The string that contains the input name.

Returns:

true if the string matches the input name, false if not.

refresh

public InputCollection refresh()

Refreshes this input collection.

Overrides:

refresh in class ResourceCollection<Input>

Returns:

The refreshed InputCollection.

remove

public Input remove(String key)

Removes an entity from this collection.

Overrides:

remove in class EntityCollection<Input>

Parameters:

key - The name of the entity to remove.

Returns:

The collection.

remove

public Input remove(String key,
                    Args namespace)

Removes an entity from this collection, with a namespace restriction.

Overrides:

remove in class EntityCollection<Input>

Parameters:

key - The name of the entity to remove.

namespace - The namespace restriction within the collection.

Returns:

This collection.