Table of Contents - Splunk SDK for Ruby

Pages

CHANGELOG
- Splunk SDK for Ruby Changelog
- Version 1.0.5
- Version 1.0.4
- Version 1.0.3
- Version 1.0.2
- Version 1.0.1
- Version 1.0
- Version 0.8.1 (beta)
- Bugs fixed
- Version 0.8.0 (beta)
- Breaking changes
- New features
- Bugs fixed
- Version 0.1.0 (preview)
- Breaking changes
- New features and APIs
- Architectural changes
CONTRIBUTING
- Contributing Guidelines
- How to contribute
- Issues & Bug Reports
- Pull requests
- Contact us
Gemfile
Gemfile.lock
LICENSE
README
- The Splunk Software Development Kit for Ruby
- Version 1.0.5
- Getting started with the Splunk SDK for Ruby
- Requirements
- Splunk
- Ruby
- Splunk SDK for Ruby
- Installing the Splunk SDK for Ruby
- Examples
- Prepare for the unit tests
- Run the unit tests
- Repository
- Changelog
- Branches
- Documentation and resources
- Community
- How to contribute
- Support
- Contact Us
- License
Rakefile
created.rid
splunk-sdk-ruby.gemspec
atom_feed_with_message.xml
atom_with_feed.xml
atom_with_several_entries.xml
atom_with_simple_entries.xml
atom_without_feed.xml
atom_test_data.json
export_results.xml
export_results.xml
export_results.xml
nonreporting.xml
export_test_data.json
results-empty.xml
results-preview.xml
results.xml
results-empty.xml
results-preview.xml
results.xml
results-empty.xml
results-empty_preview.xml
results-preview.xml
results.xml
resultsreader_test_data.json
services.server.info.xml
services.xml
testfile

Classes/Modules

Methods

::connect — Splunk
::eai_acl_to_namespace — Splunk
::namespace — Splunk
::new — Splunk::AtomFeed
::new — MockResponse
::new — Splunk::ConcatenatedStream
::new — Splunk::PuppetResultsReader
::new — Splunk::SplunkHTTPError
::new — Splunk::MultiResultsReader
::new — Splunk::Job
::new — Splunk::ReadOnlyCollection
::new — Splunk::XMLDTDFilter
::new — Splunk::Context
::new — Splunk::ExportStream
::new — Splunk::Jobs
::new — Splunk::Inputs
::new — Splunk::CaseInsensitiveCollection
::new — Splunk::Apps
::new — Splunk::ResultsReader
#../collection — Object
#../entity — Object
#== — URI::Generic
#== — URI::HTTP
#== — URI::HTTPS
#[] — Splunk::ReadOnlyEntity
#[]= — Splunk::Entity
#__getobj__ — Splunk::ExportStream
#__setobj__ — Splunk::ExportStream
#ambiguous_entity_reference — Object
#apps — Splunk::Service
#arguments — Splunk::ModularInputKind
#assert_eventually_true — TestCaseWithSplunkConnection
#assert_logged_in — TestCaseWithSplunkConnection
#assert_not_logged_in — TestCaseWithSplunkConnection
#assert_results_reader_equals — TestResultsReader
#assoc — Splunk::ReadOnlyCollection
#atom_entry_to_entity — Splunk::ReadOnlyCollection
#attach — Splunk::Index
#cancel — Splunk::Job
#capabilities — Splunk::Service
#check_saved_search — SavedSearchesTestCase
#checked_restart — TestCaseWithSplunkConnection
#clean — Splunk::Index
#clear_restart_message — TestCaseWithSplunkConnection
#close — Splunk::ConcatenatedStream
#close — Splunk::XMLDTDFilter
#confs — Splunk::Service
#connect — Splunk::Context
#create — Splunk::Jobs
#create — Splunk::Collection
#create — Splunk::Inputs
#create_export — Splunk::Jobs
#create_oneshot — Splunk::Jobs
#create_oneshot — Splunk::Service
#create_search — Splunk::Service
#create_stream — Splunk::Service
#delete — Splunk::Entity
#delete — Splunk::Collection
#delete_if — Splunk::Collection
#disable — Splunk::Entity
#dispatch — Splunk::SavedSearch
#each — Splunk::ReadOnlyCollection
#each — Splunk::PuppetResultsReader
#each — Splunk::MultiResultsReader
#each — MockResponse
#each — Splunk::ResultsReader
#each_key — Splunk::ReadOnlyCollection
#each_pair — Splunk::ReadOnlyCollection
#each_value — Splunk::ReadOnlyCollection
#empty? — Splunk::ReadOnlyCollection
#enable — Splunk::Entity
#enable_preview — Splunk::Job
#eval_stdout — Kernel
#events — Splunk::Job
#fetch — Splunk::ReadOnlyCollection
#fetch — Splunk::InputKinds
#fetch — Splunk::ReadOnlyEntity
#final_results — Splunk::MultiResultsReader
#finalize — Splunk::Job
#get_free_port — InputsTest
#has_key? — Splunk::ReadOnlyCollection
#has_test_data? — TestCaseWithSplunkConnection
#history — Splunk::SavedSearch
#indexes — Splunk::Service
#info — Splunk::Service
#inputs — Splunk::Service
#install_app_from_collection — TestCaseWithSplunkConnection
#invalidate — Splunk::PuppetResultsReader
#is_done? — Splunk::Job
#is_exact? — Splunk::Namespace
#is_preview? — Splunk::ResultsReader
#is_ready? — Splunk::Job
#jobs — Splunk::Service
#keys — Splunk::ReadOnlyCollection
#length — Splunk::Stanza
#length — Splunk::ReadOnlyCollection
#links — Splunk::ReadOnlyEntity
#loggers — Splunk::Service
#login — Splunk::Context
#logout — Splunk::Context
#main — Object
#messages — Splunk::Service
#modular_input_kinds — Splunk::Service
#nokogiri_available? — Object
#path_in_app — TestCaseWithSplunkConnection
#pause — Splunk::Job
#preview — Splunk::Job
#read — Splunk::ReadOnlyEntity
#read — Splunk::XMLDTDFilter
#read — Splunk::ConcatenatedStream
#read_splunkrc — Object
#readmeta — Splunk::ReadOnlyEntity
#refresh — Splunk::ReadOnlyEntity
#request — Splunk::Context
#request_by_url — Splunk::Context
#restart — Splunk::Context
#results — Splunk::Job
#roles — Splunk::Service
#roll_hot_buckets — Splunk::Index
#run_example — Object
#saved_searches — Splunk::Service
#searchlog — Splunk::Job
#segmented_raw — Splunk::Event
#server_accepting_connections? — Splunk::Context
#server_requires_restart? — Splunk::Context
#set_priority — Splunk::Job
#set_restart_message — TestCaseWithSplunkConnection
#set_ttl — Splunk::Job
#settings — Splunk::Service
#setup — LongJobTestCase
#setup — EntityTestCase
#setup — TestCaseWithSplunkConnection
#setup — IndexTestCase
#setup — ModularInputKindsTestCase
#setup — RealTimeJobTestCase
#setup — ConfigurationFileTestCase
#setup — InputsTest
#skip_remaining_results — Splunk::ResultsReader
#splunk_version — Splunk::Service
#submit — Splunk::Index
#teardown — ConfigurationFileTestCase
#teardown — TestCaseWithSplunkConnection
#teardown — TestCollection
#teardown — EntityTestCase
#teardown — UserTestCase
#teardown — RealTimeJobTestCase
#teardown — SavedSearchesTestCase
#teardown — LongJobTestCase
#teardown — RoleTestCase
#teardown — InputsTest
#teardown — IndexTestCase
#temporary_name — Object
#test_assoc — TestCollection
#test_asynchronous_job_has_no_segmentation_by_default — JobsTestCase
#test_asynchronous_job_has_segmentation_when_forced — JobsTestCase
#test_authenticate_with_basic — TestContext
#test_authenticate_with_token — TestContext
#test_capabilities — ServiceTestCase
#test_case_insensitive — RoleTestCase
#test_case_insensitive — UserTestCase
#test_connect — TestContext
#test_connect — ServiceTestCase
#test_constructor — TestCollection
#test_constructor_with_entity_class — TestCollection
#test_create_and_delete — ConfigurationFileTestCase
#test_create_and_delete — SavedSearchesTestCase
#test_create_and_delete — RoleTestCase
#test_create_and_delete — UserTestCase
#test_create_and_delete — TestCollection
#test_create_and_delete_stanzas — ConfigurationFileTestCase
#test_create_and_delete_tcp_raw — InputsTest
#test_create_and_delete_tcp_raw_with_restrictToHost — InputsTest
#test_create_and_delete_udp — InputsTest
#test_create_and_idempotent_cancel — JobsTestCase
#test_create_twice — TestCollection
#test_create_with_exec_mode_fails — JobsTestCase
#test_create_with_garbage_fails — JobsTestCase
#test_delete — IndexTestCase
#test_delete_if — TestCollection
#test_disable_enable — EntityTestCase
#test_disable_enable — IndexTestCase
#test_dispatch — SavedSearchesTestCase
#test_each — ConfigurationFileTestCase
#test_each_and_values — JobsTestCase
#test_each_and_values — ConfigurationFileTestCase
#test_each_equivales_values — TestCollection
#test_each_key — TestCollection
#test_each_pair — TestCollection
#test_each_value — TestCollection
#test_each_with_offset_and_count — TestCollection
#test_each_with_pagination — TestCollection
#test_each_without_pagination — TestCollection
#test_eai_acl_to_namespace — TestNamespaces
#test_empty — TestCollection
#test_enable_preview — JobsTestCase
#test_equality — TestNamespaces
#test_error_from_fetch — ConfigurationFileTestCase
#test_error_with_empty_message — TestHTTPError
#test_error_with_message — TestHTTPError
#test_escape_string_with_nokogiri — TestXMLShim
#test_escape_string_with_rexml — TestXMLShim
#test_export — JobsTestCase
#test_export_has_forced_segmentation — JobsTestCase
#test_export_has_no_segmentation_by_default — JobsTestCase
#test_export_on_reporting_search — JobsTestCase
#test_export_on_service — JobsTestCase
#test_export_with_garbage_fails — JobsTestCase
#test_failed_login — TestContext
#test_fetch — EntityTestCase
#test_fetch — ConfigurationFileTestCase
#test_fetch_nonexistant — TestCollection
#test_fetch_nonexistent — ConfigurationFileTestCase
#test_fetch_nonexistent_input_kind — InputsTest
#test_fetch_with_default — EntityTestCase
#test_fetch_with_namespaces — InputsTest
#test_fetch_with_server_error — InputsTest
#test_get_preview — RealTimeJobTestCase
#test_has_key — TestCollection
#test_incorrect_constructors — TestNamespaces
#test_inequality — TestNamespaces
#test_info — TestContext
#test_info — ServiceTestCase
#test_info_with_namespace — ServiceTestCase
#test_keys — TestCollection
#test_length — TestCollection
#test_list_arguments — ModularInputKindsTestCase
#test_list_modular_inputs_and_headers — ModularInputKindsTestCase
#test_loggers — ServiceTestCase
#test_login — TestContext
#test_login_with_encodings — TestContext
#test_logout — TestContext
#test_matches_with_nokogiri — TestXMLShim
#test_matches_with_rexml — TestXMLShim
#test_message — MessagesTestCase
#test_multiple_logins_are_nops — TestContext
#test_name_collisions — TestCollection
#test_no_matches_with_nokogiri — TestXMLShim
#test_no_matches_with_rexml — TestXMLShim
#test_oneshot — JobsTestCase
#test_oneshot_has_forced_segmentation — JobsTestCase
#test_oneshot_has_no_segmentation_by_default — JobsTestCase
#test_oneshot_input — InputsTest
#test_oneshot_on_nonexistant_file — InputsTest
#test_oneshot_on_service — JobsTestCase
#test_oneshot_with_garbage_fails — JobsTestCase
#test_path_segments — TestNamespaces
#test_pause_unpause_finalize — RealTimeJobTestCase
#test_preview_and_events — JobsTestCase
#test_propriety — TestNamespaces
#test_read — EntityTestCase
#test_reject — TestCollection
#test_restart_with_long_timeout — TestRestarts
#test_restart_with_no_timeout — TestRestarts
#test_restart_with_short_timeout — TestRestarts
#test_roles — UserTestCase
#test_search_with_many_results — JobsTestCase
#test_searchlog — RealTimeJobTestCase
#test_select — TestCollection
#test_server_accepting_connections? — TestContext
#test_service_create_and_idempotent_cancel — JobsTestCase
#test_set_and_clear_restart_messages — TestHelpers
#test_set_priority — RealTimeJobTestCase
#test_settings — ServiceTestCase
#test_setttl — LongJobTestCase
#test_splunk_version — TestContext
#test_state_with_field_list — EntityTestCase
#test_submit_and_clean — IndexTestCase
#test_submit_to_stanza — ConfigurationFileTestCase
#test_submit_via_attach — IndexTestCase
#test_temporary_name — TestHelpers
#test_throws_without_enough_information — TestNamespaces
#test_timeline — JobsTestCase
#test_types — TestNamespaces
#test_update — SavedSearchesTestCase
#test_update_and_refresh — EntityTestCase
#test_update_on_restrictToHost_does_not_clear — InputsTest
#test_update_search — SavedSearchesTestCase
#test_upload — IndexTestCase
#test_url_encoding_of_characters_in_usernames — TestContext
#test_values — TestCollection
#timeline — Splunk::Job
#to_path_fragment — Splunk::Namespace
#touch — Splunk::Job
#unchecked_restart — TestCaseWithSplunkConnection
#unpause — Splunk::Job
#update — Splunk::Entity
#upload — Splunk::Index
#users — Splunk::Service
#value — Splunk::Message
#values — Splunk::ReadOnlyCollection
#xml_shim — Object

Generated by RDoc 4.0.0.

Generated with the Darkfish Rdoc Generator 3.