Uses of Class
com.splunk.Args

Packages that use Args

Package	Description
com.splunk

Uses of Args in com.splunk

Subclasses of Args in com.splunk

Modifier and Type	Class and Description
class	CollectionArgs The CollectionArgs class contains arguments for retrieving and listing entities from a collection, such as the number of entities to return and how to sort them.
class	DataModelArgs Class representing arguments to creating a data model.
class	IndexCollectionArgs The IndexCollectionArgs class contains arguments for retrieving indexes from a collection (see Service.getIndexes()).
class	JobArgs The JobArgs class contains arguments for creating a Job.
class	JobEventsArgs The JobEventsArgs class contains arguments for getting events using the Job.getEvents() method.
class	JobExportArgs The JobExportArgs class contains arguments for exporting events using the Service.export(java.lang.String) method.
class	JobResultsArgs The JobResultsArgs class contains arguments for getting job results using the Job.getResults() method.
class	JobResultsPreviewArgs The JobResultsPreviewArgs class contains arguments for getting job results previews using the Job.getResultsPreview() method.
class	JobSummaryArgs The JobSummaryArgs class contains arguments for getting a job summary using the Job.getSummary() method.
class	SavedSearchCollectionArgs The SavedSearchCollectionArgs class contains arguments getting a collection of saved searches.
class	SavedSearchDispatchArgs The SavedSearchDispatchArgs class contains arguments for dispatching a saved search using the SavedSearch.dispatch() method.
class	ServiceArgs The ServiceArgs class contains a collection of arguments that are used to initialize a Splunk Service instance.

Fields in com.splunk declared as Args

Modifier and Type	Field and Description
protected Args	Resource.refreshArgs

Methods in com.splunk that return Args

Modifier and Type	Method and Description
Args	Args.add(String key, Object value) Adds an argument to an Args object.
static Args	Args.create() Creates a new empty instance of Args.
static Args	Args.create(Map<String,Object> values) Creates a new Args instance and initializes it with a pre-existing hash map.
static Args	Args.create(String key, Object value) Creates a new Args instance and initializes it with a single key-value pair.

Methods in com.splunk with parameters of type Args

Modifier and Type	Method and Description
Socket	Index.attach(Args args) Creates a writable socket to this index.
Socket	Receiver.attach(Args args) Creates a writable socket to this index.
Socket	Receiver.attach(String indexName, Args args) Creates a writable socket to this index.
boolean	ResourceCollection.containsKey(Object key, Args namespace) Determines whether a scoped, namespace-constrained key exists within this collection.
protected T	ResourceCollection.createItem(Class itemClass, String path, Args namespace) Creates a collection member.
String	Service.fullpath(String path, Args namespace) Ensures that a given path is fully qualified, prepending a path prefix if necessary.
T	ResourceCollection.get(Object key, Args namespace) Gets a the value of a scoped, namespace-constrained key, if it exists within this collection.
Input	InputCollection.get(Object key, Args namespace) Returns the value of a scoped, namespace-constrained key, if it exists within this collection.
ConfCollection	Service.getConfs(Args args) Returns the collection of configurations.
EntityCollection<DeploymentServerClass>	Service.getDeploymentServerClasses(Args args) Returns a collection of class configurations for a deployment server.
EntityCollection<DeploymentServer>	Service.getDeploymentServers(Args args) Returns the collection of deployment servers.
EntityCollection<DeploymentTenant>	Service.getDeploymentTenants(Args args) Returns a collection of multi-tenant configurations.
EntityCollection<DistributedPeer>	Service.getDistributedPeers(Args args) Returns a collection of distributed search peers.
EventTypeCollection	Service.getEventTypes(Args args) Returns a collection of saved event types.
FiredAlertGroupCollection	Service.getFiredAlertsGroups(Args args) Returns a collection of alerts that have been fired by the service.
IndexCollection	Service.getIndexes(Args args) Returns a collection of Splunk indexes.
InputCollection	Service.getInputs(Args args) Returns a collection of configured inputs.
JobCollection	Service.getJobs(Args args) Returns a collection of current search jobs.
EntityCollection<LicenseGroup>	Service.getLicenseGroups(Args args) Returns a collection of license group configurations.
EntityCollection<LicenseMessage>	Service.getLicenseMessages(Args args) Returns a collection of messages from the licenser.
LicensePoolCollection	Service.getLicensePools(Args args) Returns a collection of licenser pool configurations.
EntityCollection<License>	Service.getLicenses(Args args) Returns a collection of licenses for this service.
EntityCollection<LicenseSlave>	Service.getLicenseSlaves(Args args) Returns a collection of slaves reporting to this license master.
EntityCollection<LicenseStack>	Service.getLicenseStacks(Args args) Returns a collection of license stack configurations.
EntityCollection<Logger>	Service.getLoggers(Args args) Returns a collection of service logging categories and their status.
MessageCollection	Service.getMessages(Args args) Returns a collection of system messages.
ResourceCollection<ModularInputKind>	Service.getModularInputKinds(Args args) Returns a collection of modular inputs.
EntityCollection<OutputGroup>	Service.getOutputGroups(Args args) Returns a collection of output group configurations.
EntityCollection<OutputServer>	Service.getOutputServers(Args args) Returns a collection of data-forwarding configurations.
EntityCollection<OutputSyslog>	Service.getOutputSyslogs(Args args) Returns a collection of configurations for forwarding data in standard syslog format.
PasswordCollection	Service.getPasswords(Args args) Returns a collection of passwords.
EntityCollection<Role>	Service.getRoles(Args args) Returns a collection of Splunk user roles.
SavedSearchCollection	Service.getSavedSearches(Args args) Returns a collection of saved searches.
EntityCollection<Upload>	Service.getUploads(Args namespace) Returns a collection of in-progress oneshot uploads.
UserCollection	Service.getUsers(Args args) Returns a collection of Splunk users.
void	Receiver.log(Args args, String data) Submits an event to this index through HTTP POST.
void	Receiver.log(String indexName, Args args, String data) Logs an event to this index through HTTP POST.
InputStream	Service.oneshotSearch(String query, Args args) Creates a oneshot synchronous search using search arguments.
Input	InputCollection.remove(String key, Args namespace) Removes an entity from this collection, with a namespace restriction.
T	EntityCollection.remove(String key, Args namespace) Removes an entity from this collection, with a namespace restriction.
void	Index.submit(Args args, String data) Submits an event to this index through an HTTP POST request.
void	Receiver.submit(Args args, String data) Submits an event to this index through HTTP POST.
void	Receiver.submit(String indexName, Args args, String data) Logs an event to this index through HTTP POST.
void	Index.upload(String filename, Args args) Uploads a file to this index as an event stream.

Constructors in com.splunk with parameters of type Args

Constructor and Description
EntityCollection(Service service, String path, Class itemClass, Args args) Class constructor.