com.splunk
Class InputCollection

java.lang.Object
  com.splunk.Resource
      com.splunk.ResourceCollection<T>
          com.splunk.EntityCollection<Input>
              com.splunk.InputCollection

All Implemented Interfaces:

java.util.Map<java.lang.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 property that indicates the specific type of input (input kind).

Nested Class Summary

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

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.splunk.ResourceCollection

itemClass, items

Fields inherited from class com.splunk.Resource

actions, path, service, title

Method Summary

Input	create(java.lang.String name) Creates a stub.
<T extends Input> T	create(java.lang.String name, InputKind kind) Creates a specific kind of input.
<T extends Input> T	create(java.lang.String name, InputKind kind, java.util.Map<java.lang.String,java.lang.Object> args) Creates a specific kind of input by providing arguments.
Input	create(java.lang.String name, java.util.Map args) Creates a stub by providing additional arguments.
protected Input	createItem(AtomEntry entry) Creates an Input resource item.
protected InputKind	itemKind(java.lang.String path) Returns the path's InputKind value.
InputCollection	refresh() Refreshes this input collection.

Methods inherited from class com.splunk.EntityCollection

remove

Methods inherited from class com.splunk.ResourceCollection

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

Methods inherited from class com.splunk.Resource

getActions, getName, getPath, getService, getTitle, invalidate

Methods inherited from class java.lang.Object

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

Method Detail

create

public Input create(java.lang.String name)

Creates a stub.

Overrides:

create in class EntityCollection<Input>

Parameters:

name - The name of the input.

Returns:

No return value.

Throws:

java.lang.UnsupportedOperationException

create

public Input create(java.lang.String name,
                    java.util.Map args)

Creates a stub by providing additional arguments.

Overrides:

create in class EntityCollection<Input>

Parameters:

name - The name of the input.

args - Optional arguments.

Returns:

No return value.

Throws:

java.lang.UnsupportedOperationException

See Also:

For valid arguments, see the POST requests for the /data/inputs/ endpoints in the Splunk REST API documentation.

create

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

Creates a specific kind of input.

Type Parameters:

T - The implicit type of the input.

Parameters:

name - The name of the input.

kind - The specific kind of input.

Returns:

The input that was created.

create

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

Creates a specific kind of input by providing arguments.

Type Parameters:

T - The implicit type of the input.

Parameters:

name - The name of the input.

kind - The specific kind of input.

args - Optional arguments.

Returns:

The input that was created.

See Also:

For valid arguments, see the POST requests for the /data/inputs/ endpoints in the Splunk REST API documentation.

createItem

protected Input createItem(AtomEntry entry)

Creates an Input resource item.

Overrides:

createItem in class ResourceCollection<Input>

Parameters:

entry - The AtomEntry object describing the entry.

Returns:

The input that was created.

itemKind

protected InputKind itemKind(java.lang.String path)

Returns the path's InputKind value.

Parameters:

path - The input path.

Returns:

The kind of input.

refresh

public InputCollection refresh()

Refreshes this input collection.

Overrides:

refresh in class ResourceCollection<Input>

Returns:

The refreshed input collection.