Class: Splunk::ModularInputKind

Inherits:

ReadOnlyEntity

• Object
• ReadOnlyEntity
• Splunk::ModularInputKind

Defined in:

lib/splunk-sdk-ruby/entity/modular_input_kind.rb

Overview

Class representing a family of user defined inputs on the server.

Modular input kinds define new, first-class input kinds on the server. This endpoint provides access to a list of the arguments and parameters of the various kinds defined. The actual inputs of these kinds can be accessed via the Serve#inputs method.

Modular input kinds are read only, so there is no update or delete method on this class.

Instance Attribute Summary

Attributes inherited from ReadOnlyEntity

#name, #namespace, #resource, #service

Instance Method Summary

• #arguments ⇒ Object

  Return a Hash of all the arguments support by this modular input kind.

Methods inherited from ReadOnlyEntity

#[], #fetch, #initialize, #links, #read, #readmeta, #refresh

Constructor Details

This class inherits a constructor from Splunk::ReadOnlyEntity

Instance Method Details

#arguments ⇒ Object

Return a Hash of all the arguments support by this modular input kind.

The keys in the Hash are the names of the arguments. The values are additional Hashes giving the metadata about each argument. The possible keys in those Hashes are “title”, “description”, “required_on_create“, ”required_on_edit“, ”data_type“. Each value is a string. It should be one of ”true“ or ”false“ for ”required_on_create“ and ”required_on_edit“, and one of ”boolean“, ”string“, or ”number“ for ”data_type“.

# File 'lib/splunk-sdk-ruby/entity/modular_input_kind.rb', line 43

def arguments
  @state["content"]["endpoint"]["args"]
end