Contents

#--
# Copyright 2011-2013 Splunk, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"): you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#++

require_relative '../entity'

module Splunk
  ##
  # 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.
  #
  class ModularInputKind < ReadOnlyEntity
    ##
    # 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"+.
    #
    def arguments
      @state["content"]["endpoint"]["args"]
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
splunk-sdk-ruby-1.0.5	lib/splunk-sdk-ruby/entity/modular_input_kind.rb
splunk-sdk-ruby-1.0.4	lib/splunk-sdk-ruby/entity/modular_input_kind.rb
splunk-sdk-ruby-1.0.3	lib/splunk-sdk-ruby/entity/modular_input_kind.rb
splunk-sdk-ruby-1.0.2	lib/splunk-sdk-ruby/entity/modular_input_kind.rb
splunk-sdk-ruby-1.0.1	lib/splunk-sdk-ruby/entity/modular_input_kind.rb
splunk-sdk-ruby-1.0.0	lib/splunk-sdk-ruby/entity/modular_input_kind.rb
splunk-sdk-ruby-0.8.1	lib/splunk-sdk-ruby/entity/modular_input_kind.rb