com.splunk
Class ModularInputKindArgument

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<java.lang.String,java.lang.String>
          com.splunk.ModularInputKindArgument

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.String>

public class ModularInputKindArgument
extends java.util.HashMap<java.lang.String,java.lang.String>

The ModularInputKindArgument class is a map-like object that is specialized to represent arguments for modular input kinds.

See Also:

Serialized Form

Nested Class Summary

static class

ModularInputKindArgument.Type

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Method Summary

java.lang.String	getDescription() Returns the description of this field.
boolean	getRequiredOnCreate() Indicates whether this argument is required when creating a modular input of this kind.
boolean	getRequiredOnEdit() Indicates whether this argument is required when editing a modular input of this kind.
ModularInputKindArgument.Type	getType() Returns the type of this argument to the modular input.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description of this field.

Returns:

The description.

getRequiredOnCreate

public boolean getRequiredOnCreate()

Indicates whether this argument is required when creating a modular input of this kind.

Returns:

true if this argument is required for creating an input, false if not.

getRequiredOnEdit

public boolean getRequiredOnEdit()

Indicates whether this argument is required when editing a modular input of this kind.

Returns:

true if this argument is required for editing, false if not.

getType

public ModularInputKindArgument.Type getType()

Returns the type of this argument to the modular input.

Returns:

A member of the ModularInputKindArgumentType enumeration (Number, Boolean, or String).