A B C D E F G H I J K L M N O P R S T U V W X

A

acknowledge() - Method in class com.splunk.SavedSearch
Acknowledges the suppression of alerts from this saved search and resumes alerting.
actionPath(String) - Method in class com.splunk.DeploymentClient
Displays the action path.
actionPath(String) - Method in class com.splunk.DistributedConfiguration
Returns the action path.
actionPath(String) - Method in class com.splunk.Entity
Returns the path that corresponds to the requested action.
actionPath(String) - Method in class com.splunk.Job
Returns the action path.
actionPath(String) - Method in class com.splunk.SavedSearch
Returns the path that corresponds to the requested action.
actions - Variable in class com.splunk.Resource
 
add(String, Object) - Method in class com.splunk.Args
Adds an argument to an Args object.
addArgument(Argument) - Method in class com.splunk.modularinput.Scheme
Appends an argument to the arguments that this modular input kind takes.
addCellValue(String, String, StatsFunction) - Method in class com.splunk.PivotSpecification
Add an aggregate to each cell of the pivot.
addColumnSplit(String) - Method in class com.splunk.PivotSpecification
Add a column split on a string or number valued field, producing a column for each distinct value of the field.
addColumnSplit(String, Integer, Integer, Integer, Integer) - Method in class com.splunk.PivotSpecification
Add a column split on a numeric field, splitting the values into ranges.
addColumnSplit(String, String, String) - Method in class com.splunk.PivotSpecification
Add a column split on a boolean valued field.
addColumnSplit(String, TimestampBinning) - Method in class com.splunk.PivotSpecification
Add a column split on a timestamp valued field.
addCommonFields(JsonObject) - Method in class com.splunk.PivotColumnSplit
 
addCommonFields(JsonObject) - Method in class com.splunk.PivotFilter
Called by subclasses to add the fields common to all subclasses to JSON serializations.
addCommonFields(JsonObject) - Method in class com.splunk.PivotRowSplit
Add keys common to all row splits to a JSON serialization.
addFilter(String, BooleanComparison, boolean) - Method in class com.splunk.PivotSpecification
Add a filter on a boolean valued field.
addFilter(String, StringComparison, String) - Method in class com.splunk.PivotSpecification
Add a filter on a string valued field.
addFilter(String, IPv4Comparison, String) - Method in class com.splunk.PivotSpecification
Add a filter on an IPv4 valued field.
addFilter(String, NumberComparison, double) - Method in class com.splunk.PivotSpecification
Add a filter on a numeric field.
addFilter(String, String, SortDirection, int, StatsFunction) - Method in class com.splunk.PivotSpecification
Add a filter that limits the number of values of an aggregated field that will be allowed into the pivot.
addInput(String, Collection<Parameter>) - Method in class com.splunk.modularinput.InputDefinition
Adds an input to the set of inputs on this InputDefinition.
addRowSplit(String, String) - Method in class com.splunk.PivotSpecification
Add a row split on a numeric or string valued field, splitting on each distinct value of the field.
addRowSplit(String, String, Integer, Integer, Integer, Integer) - Method in class com.splunk.PivotSpecification
Add a row split on a numeric field, splitting into numeric ranges.
addRowSplit(String, String, String, String) - Method in class com.splunk.PivotSpecification
Add a row split on a boolean valued field.
addRowSplit(String, String, TimestampBinning) - Method in class com.splunk.PivotSpecification
Add a row split on a timestamp valued field, binned by the specified bucket size.
addToDocument(Document, Node) - Method in class com.splunk.modularinput.Argument
Returns an Element object representing this argument that can be added to another XML document for the Scheme.
allConnections() - Method in class com.splunk.OutputServer
Returns an object that contains all current connections to the output server.
AMBIGUOUS - Static variable in exception com.splunk.SplunkException
 
app - Variable in class com.splunk.Service
The current app context.
app - Variable in class com.splunk.ServiceArgs
Deprecated. Use ServiceArgs.setApp(String) instead.
Application - Class in com.splunk
The Application class represents a locally-installed Splunk app.
ApplicationArchive - Class in com.splunk
The ApplicationArchive class represents an archive of a Splunk app.
ApplicationSetup - Class in com.splunk
The ApplicationSetup class represents the setup information for a Splunk app.
ApplicationUpdate - Class in com.splunk
The ApplicationUpdate class represents information for an update to a locally-installed Splunk app.
archive() - Method in class com.splunk.Application
Archives the app on the server file system.
Args - Class in com.splunk
The Args class is a helper class for working with Splunk REST API arguments.
Args() - Constructor for class com.splunk.Args
Class constructor.
Args(String, Object) - Constructor for class com.splunk.Args
Class constructor.
Args(Map<String, Object>) - Constructor for class com.splunk.Args
Class constructor.
args - Variable in class com.splunk.ModularInputKind
 
Argument - Class in com.splunk.modularinput
The Argument class represents an argument to a modular input kind.
Argument(String) - Constructor for class com.splunk.modularinput.Argument
 
Argument.DataType - Enum in com.splunk.modularinput
 
arguments - Variable in class com.splunk.modularinput.Scheme
 
AtomEntry - Class in com.splunk
The AtomEntry class represents an Atom <entry> element.
AtomEntry() - Constructor for class com.splunk.AtomEntry
 
AtomFeed - Class in com.splunk
The AtomFeed class represents an Atom feed.
AtomFeed() - Constructor for class com.splunk.AtomFeed
 
AtomObject - Class in com.splunk
The AtomObject class represents a generic Atom object.
AtomObject() - Constructor for class com.splunk.AtomObject
 
attach() - Method in class com.splunk.Index
Creates a writable socket to this index.
attach(Args) - Method in class com.splunk.Index
Creates a writable socket to this index.
attach() - Method in class com.splunk.Receiver
Creates a writable socket to this index.
attach(String) - Method in class com.splunk.Receiver
Creates a writable socket to this index.
attach(Args) - Method in class com.splunk.Receiver
Creates a writable socket to this index.
attach(String, Args) - Method in class com.splunk.Receiver
Creates a writable socket to this index.
attach() - Method in class com.splunk.TcpInput
Returns a socket attached to this raw TCP input.
attachWith(ReceiverBehavior) - Method in class com.splunk.Index
Writes events to this index, reusing the connection.
attachWith(ReceiverBehavior) - Method in class com.splunk.TcpInput
Submits events to this raw TCP input, reusing the connection.

B

baseSearch - Variable in class com.splunk.DataModelSearch
 
blockOnQueueFull() - Method in class com.splunk.OutputDefault
Indicates whether this forwarder blocks when the output queue is full.
BooleanComparison - Enum in com.splunk
Comparisons on boolean valued fields.
BooleanPivotColumnSplit - Class in com.splunk
Represents a column split on a boolean valued field in a pivot.
BooleanPivotFilter - Class in com.splunk
Represents a filter on a boolean valued field in a pivot.
BooleanPivotRowSplit - Class in com.splunk
Represents a row split on a boolean valued field in a pivot.

C

cancel() - Method in class com.splunk.Job
Stops the current search and deletes the result cache.
canChangePermissions() - Method in class com.splunk.EntityMetadata
Indicates whether this entity's permission can be changed.
canShareApp() - Method in class com.splunk.EntityMetadata
Indicates whether this entity can be shared via an app.
canShareGlobal() - Method in class com.splunk.EntityMetadata
Indicates whether the entity can be shared globally.
canShareUser() - Method in class com.splunk.EntityMetadata
Indicates whether the entity can be shared to a specific user.
canWrite() - Method in class com.splunk.EntityMetadata
Indicates whether this entity can be modified.
checkError() - Method in class com.splunk.modularinput.EventWriter
Returns whether there was an IOException on this EventWriter.
clean(int) - Method in class com.splunk.Index
Cleans this index, which removes all events from it.
clear() - Method in class com.splunk.Entity
clear() - Method in class com.splunk.Event
 
clear() - Method in class com.splunk.ResourceCollection
clearError() - Method in class com.splunk.modularinput.EventWriter
Clears the error state on this EventWriter.
clone() - Method in class com.splunk.Event
 
close() - Method in class com.splunk.modularinput.EventWriter
Writes the closing </stream> tag to make this XML well formed.
close() - Method in class com.splunk.MultiResultsReader
Closes the reader and releases resources.
close() - Method in class com.splunk.ResultsReader
Closes the reader and returns resources.
close() - Method in class com.splunk.ResultsReaderCsv
Closes the reader and returns resources.
close() - Method in class com.splunk.ResultsReaderJson
Closes the reader and returns resources.
close() - Method in class com.splunk.ResultsReaderXml
Closes the reader and returns resources.
CollectionArgs - Class in com.splunk
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.
CollectionArgs() - Constructor for class com.splunk.CollectionArgs
Class constructor.
CollectionArgs.SortDirection - Enum in com.splunk
Indicates whether to sort entries in ascending or descending order.
CollectionArgs.SortMode - Enum in com.splunk
Indicates the sorting mode for entries.
com.splunk - package com.splunk
 
com.splunk.modularinput - package com.splunk.modularinput
 
ConfCollection - Class in com.splunk
The ConfCollection class represents a collection of configuration files.
connect(Map<String, Object>) - Static method in class com.splunk.Service
Establishes a connection to a Splunk service using a map of arguments.
connections() - Method in class com.splunk.TcpInput
Returns an object that contains the inbound raw TCP connections.
connections() - Method in class com.splunk.TcpSplunkInput
Returns an object that contains the inbound cooked TCP connections.
connections() - Method in class com.splunk.UdpInput
Returns an object that contains the inbound UDP connections.
containsField(String) - Method in class com.splunk.DataModelObject
Checks whether there is a field with the given name in this data model object.
containsGeneratedField(String) - Method in class com.splunk.DataModelCalculation
 
containsKey(Object) - Method in class com.splunk.Entity
containsKey(Object) - Method in class com.splunk.InputCollection
containsKey(Object) - Method in class com.splunk.ResourceCollection
containsKey(Object, Args) - Method in class com.splunk.ResourceCollection
Determines whether a scoped, namespace-constrained key exists within this collection.
containsObject(String) - Method in class com.splunk.DataModel
Returns whether there is an object of the given name in this data model.
containsValue(Object) - Method in class com.splunk.Entity
containsValue(Object) - Method in class com.splunk.ResourceCollection
content - Variable in class com.splunk.AtomEntry
The value of the Atom entry's <content> element.
content - Variable in class com.splunk.Entity
 
control(String) - Method in class com.splunk.Job
Performs the requested action on this job.
control(String, Map) - Method in class com.splunk.Job
Performs the requested action on this job.
create() - Static method in class com.splunk.Args
Creates a new empty instance of Args.
create(String, Object) - Static method in class com.splunk.Args
Creates a new Args instance and initializes it with a single key-value pair.
create(Map<String, Object>) - Static method in class com.splunk.Args
Creates a new Args instance and initializes it with a pre-existing hash map.
create(String) - Method in class com.splunk.ConfCollection
Creates a new stanza in the current configuration file.
create(String, Map) - Method in class com.splunk.ConfCollection
Creates a new stanza in the current configuration file with attributes.
create(String) - Method in class com.splunk.DataModelCollection
Creates an entity in this collection.
create(String, Map) - Method in class com.splunk.DataModelCollection
Creates an entity in this collection.
create(String) - Method in class com.splunk.EntityCollection
Creates an entity in this collection.
create(String, Map) - Method in class com.splunk.EntityCollection
Creates an entity in this collection.
create(String, String) - Method in class com.splunk.EventTypeCollection
Creates an event type.
create(String, String, Map) - Method in class com.splunk.EventTypeCollection
Creates an event type.
create(String) - Method in class com.splunk.InputCollection
Creates a stub for a new data input.
create(String, Map) - Method in class com.splunk.InputCollection
Creates a stub for a new data input based on additional arguments.
create(String, InputKind) - Method in class com.splunk.InputCollection
Creates a new data input based on the input kind.
create(String, InputKind, Map<String, Object>) - Method in class com.splunk.InputCollection
Creates a new data input based on the input kind and additional arguments.
create(String) - Static method in class com.splunk.InputKind
Create an InputKind object from a String giving the relative path from data/inputs/ to the kind.
create(String) - Method in class com.splunk.JobCollection
Creates a search with a UTF8 pre-encoded search request.
create(String, Map) - Method in class com.splunk.JobCollection
Creates a search.
create(String, JobArgs) - Method in class com.splunk.JobCollection
Creates a search.
create(String, String, String) - Method in class com.splunk.LicensePoolCollection
Creates a license pool.
create(String, String, String, Map) - Method in class com.splunk.LicensePoolCollection
Creates a license pool.
create(String, String) - Method in class com.splunk.MessageCollection
Creates a new message.
create(String, String) - Method in class com.splunk.PasswordCollection
Creates a credential with a username and password.
create(String, String, String) - Method in class com.splunk.PasswordCollection
Creates a credential with a username, password, and realm.
create(String) - Method in class com.splunk.SavedSearchCollection
Creates an entity in this collection.
create(String, String) - Method in class com.splunk.SavedSearchCollection
Creates a saved search from a name and search query.
create(String, String, Map) - Method in class com.splunk.SavedSearchCollection
Creates a saved search from a name, search query, and additional arguments.
create(String, String, String) - Method in class com.splunk.UserCollection
Creates a new Splunk user from a username, password, and role.
create(String, String, String[]) - Method in class com.splunk.UserCollection
Creates a new Splunk user from a username, password, and array of roles.
create(String, String, String, Map) - Method in class com.splunk.UserCollection
Creates a new Splunk user from a username, password, role, and additional arguments.
create(String, String, String[], Map) - Method in class com.splunk.UserCollection
Creates a new Splunk user from a username, password, array of roles, and additional arguments.
createItem(AtomEntry) - Method in class com.splunk.InputCollection
Creates a new data input based on an Atom entry.
createItem(Class, String, Args) - Method in class com.splunk.ResourceCollection
Creates a collection member.
createItem(AtomEntry) - Method in class com.splunk.ResourceCollection
Creates a collection member corresponding to a given Atom entry.
createLocalAccelerationJob() - Method in class com.splunk.DataModelObject
Local acceleration is tsidx acceleration of a data model object that is handled manually by a user.
createLocalAccelerationJob(String) - Method in class com.splunk.DataModelObject
Local acceleration is tsidx acceleration of a data model object that is handled manually by a user.
createPivotSpecification() - Method in class com.splunk.DataModelObject
Create a PivotSpecification on this data model object.
createReader(InputStream) - Static method in class com.splunk.AtomObject
Instantiates the XMLStreamReader, advances to the root element and validates the root document structure.
createSSLFactory() - Static method in class com.splunk.HttpService
 

D

data - Variable in class com.splunk.modularinput.Event
 
DataModel - Class in com.splunk
DataModel represents a data model on the server.
DataModelArgs - Class in com.splunk
Class representing arguments to creating a data model.
DataModelArgs() - Constructor for class com.splunk.DataModelArgs
 
DataModelCalculation - Class in com.splunk
Abstract class specifying a calculation on a data model object.
DataModelCalculation(String[], String, Map<String, DataModelField>, String, boolean) - Constructor for class com.splunk.DataModelCalculation
 
DataModelCollection - Class in com.splunk
 
DataModelConstraint - Class in com.splunk
Represents a constraint on a data model object or a field on a data model object.
DataModelField - Class in com.splunk
Represents a field of a data model object.
DataModelObject - Class in com.splunk
DataModelObject represents one of the structured views in a data model.
DataModelObject(DataModel) - Constructor for class com.splunk.DataModelObject
 
dataModelObject - Variable in class com.splunk.PivotFilter
 
DataModelSearch - Class in com.splunk
DataModelSearch represents a data model object that directly wraps a Splunk search query.
DataModelTransaction - Class in com.splunk
Represents a datamodel object that inherits directly from BaseTransaction, that is, an object that wraps a Splunk transaction.
dataType - Variable in class com.splunk.modularinput.Argument
 
DEBUG - Static variable in class com.splunk.modularinput.EventWriter
 
DEFAULT_HOST - Static variable in class com.splunk.Service
The default host name, which is used when a host name is not provided.
DEFAULT_PORT - Static variable in class com.splunk.Service
The default port number, which is used when a port number is not provided.
DEFAULT_SCHEME - Static variable in class com.splunk.Service
The default scheme, which is used when a scheme is not provided.
delete(String) - Method in class com.splunk.HttpService
Issues a DELETE request against the service using a given path.
delete(String, Map<String, Object>) - Method in class com.splunk.HttpService
Issues a DELETE request against the service using a given path and query arguments.
DeploymentClient - Class in com.splunk
The DeploymentClient class represents a Splunk deployment client, providing access to deployment client configuration and status.
DeploymentServer - Class in com.splunk
The DeploymentServer class represents a Splunk deployment server, and provides access to the configurations of all deployment servers.
DeploymentServerClass - Class in com.splunk
The DeploymentServerClass class represents a Splunk deployment server class, providing access to the configuration of a server class.
DeploymentTenant - Class in com.splunk
The DeploymentTenant class represents a Splunk deployment tenant, and provides access to the multi-tenants configuration for this Splunk instance.
description - Variable in class com.splunk.modularinput.Argument
 
description - Variable in class com.splunk.modularinput.Scheme
 
disable() - Method in class com.splunk.DeploymentClient
Not supported for this endpoint.
disable() - Method in class com.splunk.DistributedConfiguration
Disable distributed search on this Splunk instance.
disable() - Method in class com.splunk.Entity
Disables the entity that is named by this endpoint.
disablePreview() - Method in class com.splunk.Job
Disables preview for this job.
dispatch() - Method in class com.splunk.SavedSearch
Runs the saved search.
dispatch(Map) - Method in class com.splunk.SavedSearch
Runs the saved search using dispatch arguments.
dispatch(SavedSearchDispatchArgs) - Method in class com.splunk.SavedSearch
Runs the saved search using dispatch arguments.
DistributedConfiguration - Class in com.splunk
The DistributedConfiguration class represents a Splunk distributed search configuration, providing access to Splunk's distributed search options.
DistributedPeer - Class in com.splunk
The DistributedPeer class represents a Splunk distributed peer, providing distributed peer server management.
done - Variable in class com.splunk.modularinput.Event
 

E

enable() - Method in class com.splunk.DeploymentClient
Not supported for this endpoint.
enable() - Method in class com.splunk.DistributedConfiguration
Enable distributed search on this Splunk instance.
enable() - Method in class com.splunk.Entity
Enables the entity that is named by this endpoint.
enablePreview() - Method in class com.splunk.Job
Enables preview for this job (although it might slow search considerably).
encode(String) - Static method in class com.splunk.Args
Encodes a single string with UTF8 encoding.
encode(Map<String, Object>) - Static method in class com.splunk.Args
Encodes a hash map of String:String or String:String[] into a single UTF8-encoded string.
encode() - Method in class com.splunk.Args
Encodes an Args instance into a UTF8-encoded string.
Entity - Class in com.splunk
The Entity class represents a Splunk entity.
Entity(Service, String) - Constructor for class com.splunk.Entity
Class constructor.
EntityCollection<T extends Entity> - Class in com.splunk
The EntityCollection class represents a collection of Splunk entities.
EntityCollection(Service, String, Class, Args) - Constructor for class com.splunk.EntityCollection
Class constructor.
EntityMetadata - Class in com.splunk
The EntityMetadata class provides access to the metadata properties of a corresponding entity.
entries - Variable in class com.splunk.AtomFeed
The list of Atom entries contained in this AtomFeed object.
entrySet() - Method in class com.splunk.Entity
entrySet() - Method in class com.splunk.ResourceCollection
equals(Object) - Method in class com.splunk.modularinput.InputDefinition
 
equals(Object) - Method in class com.splunk.modularinput.MultiValueParameter
 
equals(Object) - Method in class com.splunk.modularinput.SingleValueParameter
 
equals(Object) - Method in class com.splunk.modularinput.ValidationDefinition
 
equals(Object) - Method in class com.splunk.ResourceCollection
ERROR - Static variable in class com.splunk.modularinput.EventWriter
 
EvalDataModelCalculation - Class in com.splunk
Represents a calculation on a data model object done by an eval.
EvalDataModelCalculation(String[], String, Map<String, DataModelField>, String, boolean, String) - Constructor for class com.splunk.EvalDataModelCalculation
 
Event - Class in com.splunk
The Event class wraps an individual event or result that was returned by the ResultsReader.getNextEvent() method.
Event - Class in com.splunk.modularinput
The Event class represents an event or fragment of an event to be written by this modular input to Splunk.
Event() - Constructor for class com.splunk.modularinput.Event
 
EventType - Class in com.splunk
The EventType class represents an event type.
EventTypeCollection - Class in com.splunk
The EventTypeCollection class represents a collection of event types.
EventWriter - Class in com.splunk.modularinput
The EventWriter class encapsulates writing events and error messages to Splunk from a modular input.
EventWriter() - Constructor for class com.splunk.modularinput.EventWriter
 
EventWriter(Writer, Writer) - Constructor for class com.splunk.modularinput.EventWriter
 
export(String) - Method in class com.splunk.Service
Runs an export search (using the search/jobs/export endpoint), and streams results back in an input stream.
export(String, Map) - Method in class com.splunk.Service
Runs an export search with arguments (using the search/jobs/export endpoint), and streams results back in an input stream.
export(String, JobExportArgs) - Method in class com.splunk.Service
Runs an export search with arguments (using the search/jobs/export endpoint), and streams results back in an input stream.

F

FATAL - Static variable in class com.splunk.modularinput.EventWriter
 
fieldName - Variable in class com.splunk.PivotFilter
 
FieldType - Enum in com.splunk
Represents the type of a field in a data model object.
finish() - Method in class com.splunk.Job
Stops the job and provides intermediate results available for retrieval.
FiredAlert - Class in com.splunk
The FiredAlert class represents a fired alert.
FiredAlertGroup - Class in com.splunk
The FiredAlertGroup class represents a group of fired alerts, which are the alerts for a given saved search.
FiredAlertGroupCollection - Class in com.splunk
The FiredAlertGroupCollection class represents a collection of fired alert groups.
fullpath(String, Args) - Method in class com.splunk.Service
Ensures that a given path is fully qualified, prepending a path prefix if necessary.

G

GeoIPDataModelCalculation - Class in com.splunk
Represents a GeoIP lookup on a data model object, which uses an input field to add geographic information to the output.
get(Map<String, Object>, String, T) - Static method in class com.splunk.Args
Returns the hash-map value of a specific key, or the default value if the key is not found.
get(Object) - Method in class com.splunk.Entity
get(String) - Method in class com.splunk.Event
Returns the single value or delimited set of values for the specified field name, or null if the specified field is not present.
get(String) - Method in class com.splunk.HttpService
Issues an HTTP GET request against the service using a given path.
get(String, Map<String, Object>) - Method in class com.splunk.HttpService
Issues an HTTP GET request against the service using a given path and query arguments.
get(Object) - Method in class com.splunk.InputCollection
Gets the value of a given key, if it exists within this collection.
get(Object, Args) - Method in class com.splunk.InputCollection
Returns the value of a scoped, namespace-constrained key, if it exists within this collection.
get(Object) - Method in class com.splunk.ResourceCollection
Gets the value of a given key, if it exists within this collection.
get(Object, Args) - Method in class com.splunk.ResourceCollection
Gets a the value of a scoped, namespace-constrained key, if it exists within this collection.
getAcceleratedQuery() - Method in class com.splunk.Pivot
 
getAccelerationCronSchedule() - Method in class com.splunk.DataModel
Return the cron schedule on which the cached data for acceleration should be updated.
getAccelerationNamespace() - Method in class com.splunk.DataModel
Returns the tsidx namespace which holds global acceleration events for this data model.
getAccelerationNamespace() - Method in class com.splunk.PivotSpecification
 
getAction() - Method in class com.splunk.FiredAlert
Returns this alert's actions (such as notifying by email, running a script, adding to RSS, tracking in Alert Manager, and enabling summary indexing).
getActionEmailAuthPassword() - Method in class com.splunk.SavedSearch
Returns the email password.
getActionEmailAuthUsername() - Method in class com.splunk.SavedSearch
Returns the email username.
getActionEmailBcc() - Method in class com.splunk.SavedSearch
Returns the blind carbon copy (BCC) email address.
getActionEmailCc() - Method in class com.splunk.SavedSearch
Returns the carbon copy (CC) email address.
getActionEmailCommand() - Method in class com.splunk.SavedSearch
Returns the search command (or pipeline) that runs the action.
getActionEmailFormat() - Method in class com.splunk.SavedSearch
Returns the format of text in the email.
getActionEmailFrom() - Method in class com.splunk.SavedSearch
Returns the email sender's name.
getActionEmailHostname() - Method in class com.splunk.SavedSearch
Returns the host name used in the web link (URL) that is sent in email alerts.
getActionEmailInline() - Method in class com.splunk.SavedSearch
Indicates whether the search results are contained in the body of the email.
getActionEmailMailServer() - Method in class com.splunk.SavedSearch
Returns the address of the MTA server that is used to send the emails.
getActionEmailMaxResults() - Method in class com.splunk.SavedSearch
Returns the maximum number of search results to send in email alerts.
getActionEmailMaxTime() - Method in class com.splunk.SavedSearch
Returns the maximum amount of time an email action takes before the action is canceled.
getActionEmailPdfView() - Method in class com.splunk.SavedSearch
Returns the name of the view to deliver if ActionEmailSendPdf is enabled.
getActionEmailPreProcessResults() - Method in class com.splunk.SavedSearch
Returns the search string for pre-processing results before emailing them.
getActionEmailReportPaperOrientation() - Method in class com.splunk.SavedSearch
Returns the paper orientation.
getActionEmailReportPaperSize() - Method in class com.splunk.SavedSearch
Returns the paper size for PDFs.
getActionEmailReportServerEnabled() - Method in class com.splunk.SavedSearch
Indicates whether the PDF server is enabled.
getActionEmailReportServerUrl() - Method in class com.splunk.SavedSearch
Returns the URL of the PDF report server, if one is set up and available on the network.
getActionEmailSendPdf() - Method in class com.splunk.SavedSearch
Indicates whether to create and send the results in PDF format.
getActionEmailSendResults() - Method in class com.splunk.SavedSearch
Indicates whether search results are attached to an email.
getActionEmailSubject() - Method in class com.splunk.SavedSearch
Returns the subject line of the email.
getActionEmailTo() - Method in class com.splunk.SavedSearch
Returns a list of email recipients.
getActionEmailTrackAlert() - Method in class com.splunk.SavedSearch
Indicates whether running this email action results in a trackable alert.
getActionEmailTtl() - Method in class com.splunk.SavedSearch
Returns the minimum time-to-live (ttl) of search artifacts if this email action is triggered.
getActionEmailUseSsl() - Method in class com.splunk.SavedSearch
Indicates whether to use secure socket layer (SSL) when communicating with the SMTP server.
getActionEmailUseTls() - Method in class com.splunk.SavedSearch
Indicates whether to use transport layer security (TLS) when communicating with the SMTP server.
getActionEmailWidthSortColumns() - Method in class com.splunk.SavedSearch
Indicates whether columns should be sorted from least wide to most wide, left to right.
getActionPopulateLookupCommand() - Method in class com.splunk.SavedSearch
Returns the search command (or pipeline) that runs the action.
getActionPopulateLookupDest() - Method in class com.splunk.SavedSearch
Returns the name of the lookup table or lookup path to populate.
getActionPopulateLookupHostname() - Method in class com.splunk.SavedSearch
Returns the host name used in the web link (URL) that is sent in populate-lookup alerts.
getActionPopulateLookupMaxResults() - Method in class com.splunk.SavedSearch
Returns the maximum number of search results to send in populate-lookup alerts.
getActionPopulateLookupMaxTime() - Method in class com.splunk.SavedSearch
Returns the maximum amount of time an alert action takes before the action is canceled.
getActionPopulateLookupTrackAlert() - Method in class com.splunk.SavedSearch
Indicates whether running this populate-lookup action results in a trackable alert.
getActionPopulateLookupTtl() - Method in class com.splunk.SavedSearch
Returns the minimum time-to-live (ttl) of search artifacts if this populate-lookup action is triggered.
getActionRssCommand() - Method in class com.splunk.SavedSearch
Returns the search command (or pipeline) that runs the action.
getActionRssHostname() - Method in class com.splunk.SavedSearch
Returns the host name used in the web link (URL) that is sent in RSS alerts.
getActionRssMaxResults() - Method in class com.splunk.SavedSearch
Returns the maximum number of search results to send in RSS alerts.
getActionRssMaxTime() - Method in class com.splunk.SavedSearch
Returns the maximum amount of time an RSS alert action takes before the action is canceled.
getActionRssTrackAlert() - Method in class com.splunk.SavedSearch
Indicates whether running this RSS action results in a trackable alert.
getActionRssTtl() - Method in class com.splunk.SavedSearch
Returns the minimum time-to-live (ttl) of search artifacts if this RSS action is triggered.
getActionScriptCommand() - Method in class com.splunk.SavedSearch
Returns the search command (or pipeline) that runs the action.
getActionScriptFilename() - Method in class com.splunk.SavedSearch
Returns the filename of the script to call.
getActionScriptHostname() - Method in class com.splunk.SavedSearch
Returns the host name used in the web link (URL) that is sent in script alerts.
getActionScriptMaxResults() - Method in class com.splunk.SavedSearch
Returns the maximum number of search results to send in script alerts.
getActionScriptMaxTime() - Method in class com.splunk.SavedSearch
Returns the maximum amount of time a script action takes before the action is canceled.
getActionScriptTrackAlert() - Method in class com.splunk.SavedSearch
Indicates whether running this script action results in a trackable alert.
getActionScriptTtl() - Method in class com.splunk.SavedSearch
Returns the minimum time-to-live (ttl) of search artifacts if this script action is triggered.
getActionSummaryIndexCommand() - Method in class com.splunk.SavedSearch
Returns the search command (or pipeline) that runs the action.
getActionSummaryIndexHostname() - Method in class com.splunk.SavedSearch
Returns the host name used in the web link (URL) that is sent in summary-index alerts.
getActionSummaryIndexInline() - Method in class com.splunk.SavedSearch
Indicates whether to run the summary indexing action as part of the scheduled search.
getActionSummaryIndexMaxResults() - Method in class com.splunk.SavedSearch
Returns the maximum number of search results to send in summary-index alerts.
getActionSummaryIndexMaxTime() - Method in class com.splunk.SavedSearch
Returns the maximum amount of time a summary action takes before the action is canceled.
getActionSummaryIndexName() - Method in class com.splunk.SavedSearch
Returns the name of the summary index where the results of the scheduled search are saved.
getActionSummaryIndexTrackAlert() - Method in class com.splunk.SavedSearch
Indicates whether running this summary-index action results in a trackable alert.
getActionSummaryIndexTtl() - Method in class com.splunk.SavedSearch
Returns the minimum time-to-live (ttl) of search artifacts if a summary-index action is triggered.
getAlertComparator() - Method in class com.splunk.SavedSearch
Returns the alert comparator.
getAlertCondition() - Method in class com.splunk.SavedSearch
Returns a conditional search that is evaluated against the results of the saved search.
getAlertDigestMode() - Method in class com.splunk.SavedSearch
Indicates whether Splunk applies the alert actions to the entire result set (digest) or to each individual search result (per result).
getAlertExpires() - Method in class com.splunk.SavedSearch
Returns the amount of time to show the alert in the dashboard.
getAlerts() - Method in class com.splunk.FiredAlertGroup
Returns a group of fired alerts for a given saved search.
getAlertSeverity() - Method in class com.splunk.SavedSearch
Returns the alert severity level.
getAlertSuppress() - Method in class com.splunk.SavedSearch
Indicates whether alert suppression is enabled for this search.
getAlertSuppressFields() - Method in class com.splunk.SavedSearch
Returns a list of fields to use for alert suppression.
getAlertSuppressPeriod() - Method in class com.splunk.SavedSearch
Returns the alert suppression period, which is only valid if AlertSuppress is enabled.
getAlertThreshold() - Method in class com.splunk.SavedSearch
Returns the value to compare to before triggering the alert action.
getAlertTrack() - Method in class com.splunk.SavedSearch
Returns a value that indicates how to track the actions triggered by this saved search.
getAlertType() - Method in class com.splunk.FiredAlert
Returns this alert's type.
getAlertType() - Method in class com.splunk.SavedSearch
Returns a value that indicates what to base the alert on.
getApp() - Method in class com.splunk.EntityMetadata
Returns the app context of this entity.
getApp() - Method in class com.splunk.Service
Returns the app context for this Service instance.
getApplications() - Method in class com.splunk.Service
Returns the collection of applications.
getAppName() - Method in class com.splunk.ApplicationArchive
Returns the name of the app.
getAppUrl() - Method in class com.splunk.ApplicationUpdate
Returns the fully-qualified URL to the app update.
getArgument(String) - Method in class com.splunk.ModularInputKind
Returns a map-like object representing a particular argument of this modular input kind.
getArguments() - Method in class com.splunk.modularinput.Scheme
Returns all the arguments to this modular input kind.
getArguments() - Method in class com.splunk.ModularInputKind
Returns an argument map that contains the argument names as keys, and the ModularInputKindArguments as corresponding values.
getArray(String) - Method in class com.splunk.Event
Gets the values for the specified field name.
getArray(String, String) - Method in class com.splunk.Event
Gets the values for the specified field name.
getAssureUTF8() - Method in class com.splunk.Index
Indicates whether the data retrieved from this index has been UTF8-encoded.
getAttributeName() - Method in class com.splunk.LimitPivotFilter
Return the name of the field to use for sorting.
getAttributeOwnerLineage() - Method in class com.splunk.LimitPivotFilter
 
getAuthor() - Method in class com.splunk.Application
Returns the name of the app's author.
getAutoExtractedFields() - Method in class com.splunk.DataModelObject
Get a collection of objects specifying all the fields that were automatically extracted from events (as opposed to generated by calculations in a data model).
getAutoLB() - Method in class com.splunk.OutputDefault
Indicates whether this forwarder performs automatic load balancing.
getAutoLB() - Method in class com.splunk.OutputGroup
Indicates whether this forwarder performs automatic load balancing.
getAutoLBFrequency() - Method in class com.splunk.OutputDefault
Returns the frequency of automatic load balancing.
getBaseline() - Method in class com.splunk.WindowsRegistryInput
Indicates whether this Windows Registry input has an established baseline.
getBaseSearch() - Method in class com.splunk.DataModelSearch
 
getBinning() - Method in class com.splunk.TimestampPivotColumnSplit
 
getBinning() - Method in class com.splunk.TimestampPivotRowSplit
 
getBlacklist() - Method in class com.splunk.DeploymentServerClass
Returns a list of the hosts that are excluded from this server class.
getBlacklist() - Method in class com.splunk.MonitorInput
Returns a regular expression for a file path that when matched is not indexed.
getBlacklistByIndex(int) - Method in class com.splunk.DeploymentServerClass
Returns a list of excluded client addresses, by index.
getBlacklistNames() - Method in class com.splunk.DistributedConfiguration
Returns a list of server names that are excluded from being peers.
getBlacklistUrls() - Method in class com.splunk.DistributedConfiguration
Returns a list of server URLs that are excluded from being peers.
getBlockSignatureDatabase() - Method in class com.splunk.Index
Returns the block signature database for this index.
getBlockSignSize() - Method in class com.splunk.Index
Returns the number of events that make up a block for block signatures.
getBloomfilterTotalSizeKB() - Method in class com.splunk.Index
Returns the total size of all bloom filter files.
getBoolean() - Method in class com.splunk.modularinput.SingleValueParameter
Tries to coerce the value of this parameter to a Boolean.
getBucketRebuildMemoryHint() - Method in class com.splunk.Index
Returns the suggested size of the .tsidx file for the bucket rebuild process.
getBuild() - Method in class com.splunk.DistributedPeer
Returns this peer's build number.
getBuild() - Method in class com.splunk.ServiceInfo
Returns the build number of this Splunk instance.
getBundleVersions() - Method in class com.splunk.DistributedPeer
Returns a list of bundle versions.
getBytesIndexed() - Method in class com.splunk.Upload
Returns the number of bytes that are currently indexed.
getCalculation(String) - Method in class com.splunk.DataModelObject
Fetch a calculation by its unique ID.
getCalculationID() - Method in class com.splunk.DataModelCalculation
 
getCalculations() - Method in class com.splunk.DataModelObject
Return the calculations done by this data model object to produce fields.
getCapabilities() - Method in class com.splunk.Role
Returns an array of capabilities assigned to this role.
getCapabilities() - Method in class com.splunk.Service
Returns an array of system capabilities.
getCategory() - Method in class com.splunk.LicenseMessage
Returns the category of this license message.
getCellValues() - Method in class com.splunk.PivotSpecification
 
getCheckForUpdates() - Method in class com.splunk.Application
Indicates whether Splunk checks Splunkbase for updates.
getCheckpointDir() - Method in class com.splunk.modularinput.InputDefinition
Gets the path to which to write checkpoint files for restarting inputs.
getCheckpointDir() - Method in class com.splunk.modularinput.ValidationDefinition
Gets the path to write checkpoint files for restarting inputs in.
getChecksum() - Method in class com.splunk.ApplicationUpdate
Returns the checksum of the app.
getChecksumType() - Method in class com.splunk.ApplicationUpdate
Returns the checksum type of the app.
getCheckTimedOutServersFrequency() - Method in class com.splunk.DistributedConfiguration
Returns the frequency at which servers that have timed out are rechecked.
getClasses() - Method in class com.splunk.WindowsWmiInput
Returns the WMI class name of this WMI input.
getClearPassword() - Method in class com.splunk.Password
Returns the clear-text password for this credential.
getCode() - Method in exception com.splunk.SplunkException
 
getColdPath() - Method in class com.splunk.Index
Returns the absolute file path to the cold database for this index.
getColdPathExpanded() - Method in class com.splunk.Index
Returns the expanded absolute file path to the cold database for this index.
getColdToFrozenDir() - Method in class com.splunk.Index
Returns the frozen archive destination path for this index.
getColdToFrozenScript() - Method in class com.splunk.Index
Returns the path to the archiving script.
getColumnSplits() - Method in class com.splunk.PivotSpecification
 
getComment() - Method in class com.splunk.DataModelCalculation
 
getComment() - Method in class com.splunk.DataModelField
 
getCompressRawdata() - Method in class com.splunk.Index
Deprecated. Splunk always compresses raw data.
getConfs() - Method in class com.splunk.Service
Returns the collection of configurations.
getConfs(Args) - Method in class com.splunk.Service
Returns the collection of configurations.
getConnection() - Method in class com.splunk.TcpConnections
Returns the TCP connection.
getConnectionHost() - Method in class com.splunk.TcpInput
Returns the style of host connection.
getConnectionHost() - Method in class com.splunk.TcpSplunkInput
Returns the style of host connection.
getConnectionHost() - Method in class com.splunk.UdpInput
Returns the style of host connection.
getConnectionTimeout() - Method in class com.splunk.DistributedConfiguration
Returns the time-out period for connecting to search peers.
getConstraints() - Method in class com.splunk.DataModelObject
 
getContent() - Method in class com.splunk.Entity
 
getContent() - Method in class com.splunk.RequestMessage
Returns the message body content.
getContent() - Method in class com.splunk.ResponseMessage
Returns the body content stream.
getContinueMatching() - Method in class com.splunk.DeploymentServerClass
Indicates whether look-ups halt on the first server match or continue to match against multiple servers.
getCounters() - Method in class com.splunk.WindowsPerfmonInput
Returns a list of monitored counters for this Windows Perfmon input.
getCpuArch() - Method in class com.splunk.ServiceInfo
Returns the CPU architecture of this Splunk instance.
getCrcSalt() - Method in class com.splunk.MonitorInput
Returns a string that is used to force Splunk to index files that have a matching cyclic redundancy check (CRC).
getCreationTime() - Method in class com.splunk.License
Returns the time and date the license was created.
getCreationTime() - Method in class com.splunk.LicenseMessage
Returns the time and date that this license message was created.
getCronSchedule() - Method in class com.splunk.SavedSearch
Returns the cron-style schedule for running this saved search.
getCurrentDBSizeMB() - Method in class com.splunk.Index
Returns the current size of this index.
getCursorTime() - Method in class com.splunk.Job
Returns the earliest time from which no events are later scanned.
getData() - Method in class com.splunk.modularinput.Event
Gets the text of the event that Splunk should index.
getDataModel() - Method in class com.splunk.DataModelObject
Fetch the data model on which this object is defined.
getDataModels() - Method in class com.splunk.Service
Returns the collection of data models.
getDataType() - Method in class com.splunk.modularinput.Argument
Gets the data type of this argument.
getDefaultApp() - Method in class com.splunk.Role
Returns the app to use as the default app for this role.
getDefaultApp() - Method in class com.splunk.User
Returns the user's default app.
getDefaultAppIsUserOverride() - Method in class com.splunk.User
Indicates whether the user's default app was set specifically by the user.
getDefaultAppSourceRole() - Method in class com.splunk.User
Returns the name of the role that the default app was inherited from, or system if it was inherited from the default system setting.
getDefaultDatabase() - Method in class com.splunk.Index
Return the default index name of the Splunk instance.
getDelegate() - Method in class com.splunk.Job
Returns a value that indicates how jobs were started (such as the scheduler).
getDeploymentClient() - Method in class com.splunk.Service
Returns the configuration and status of a deployment client.
getDeploymentServerClasses() - Method in class com.splunk.Service
Returns a collection of class configurations for a deployment server.
getDeploymentServerClasses(Args) - Method in class com.splunk.Service
Returns a collection of class configurations for a deployment server.
getDeploymentServers() - Method in class com.splunk.Service
Returns the configuration of all deployment servers.
getDeploymentServers(Args) - Method in class com.splunk.Service
Returns the collection of deployment servers.
getDeploymentTenants() - Method in class com.splunk.Service
Returns a collection of multi-tenant configurations.
getDeploymentTenants(Args) - Method in class com.splunk.Service
Returns a collection of multi-tenant configurations.
getDescription() - Method in class com.splunk.Application
Returns a short description of the app.
getDescription() - Method in class com.splunk.DataModel
 
getDescription() - Method in class com.splunk.EventType
Returns the description of this event type.
getDescription() - Method in class com.splunk.LicenseMessage
Returns the description of this license message.
getDescription() - Method in class com.splunk.LicensePool
Returns the description of this license pool.
getDescription() - Method in class com.splunk.modularinput.Argument
Gets the human readable description of this argument.
getDescription() - Method in class com.splunk.modularinput.Scheme
Gets the human readable description of this modular input kind.
getDescription() - Method in class com.splunk.ModularInputKind
Returns the description of this modular input kind.
getDescription() - Method in class com.splunk.ModularInputKindArgument
Returns the description of this field.
getDescription() - Method in class com.splunk.SavedSearch
Returns a description of this saved search.
getDestHost() - Method in class com.splunk.OutputServer
Returns the DNS name of the destination server for this connection.
getDestHost() - Method in class com.splunk.OutputServerAllConnections
Returns the DNS name of the destination server.
getDestIp() - Method in class com.splunk.OutputServer
Returns the IP address of the destination server for this connection.
getDestIp() - Method in class com.splunk.OutputServerAllConnections
Returns the IP address of the destination server for this connection.
getDestPort() - Method in class com.splunk.OutputServer
Return the port on which the destination server is listening.
getDestPort() - Method in class com.splunk.OutputServerAllConnections
Return the port on which the destination server is listening.
getDetail() - Method in exception com.splunk.HttpException
Returns the HTTP error response message detail.
getDiskUsage() - Method in class com.splunk.Job
Returns the disk usage for this job.
getDispatchBuckets() - Method in class com.splunk.SavedSearch
Returns the maximum number of timeline buckets.
getDispatchEarliestTime() - Method in class com.splunk.SavedSearch
Returns the earliest time for this search.
getDispatchLatestTime() - Method in class com.splunk.SavedSearch
Returns the latest time for this search.
getDispatchLookups() - Method in class com.splunk.SavedSearch
Indicates whether lookups are enabled for this search.
getDispatchMaxCount() - Method in class com.splunk.SavedSearch
Returns the maximum number of results before finalizing the search.
getDispatchMaxTime() - Method in class com.splunk.SavedSearch
Returns the maximum amount of time before finalizing the search.
getDispatchRealTimeBackfill() - Method in class com.splunk.SavedSearch
Indicates whether to back fill the real-time window for this search.
getDispatchReduceFrequency() - Method in class com.splunk.SavedSearch
Returns how frequently Splunk runs the MapReduce reduce phase on accumulated map values.
getDispatchRtBackfill() - Method in class com.splunk.SavedSearch
Deprecated. Use SavedSearch.getDispatchRealTimeBackfill() instead.
getDispatchSpawnProcess() - Method in class com.splunk.SavedSearch
Indicates whether Splunk spawns a new search process when running this saved search.
getDispatchState() - Method in class com.splunk.Job
Returns the dispatch state for this job.
getDispatchTimeFormat() - Method in class com.splunk.SavedSearch
Returns the time format used to specify the earliest and latest times for this search.
getDispatchTtl() - Method in class com.splunk.SavedSearch
Returns the time to live (ttl) for artifacts of the scheduled search (the time before the search job expires and artifacts are still available), if no alerts are triggered.
getDisplayName() - Method in class com.splunk.DataModel
 
getDisplayName() - Method in class com.splunk.DataModelField
 
getDisplayName() - Method in class com.splunk.DataModelObject
 
getDisplayView() - Method in class com.splunk.SavedSearch
Returns the default view in which to load results.
getDistributedConfiguration() - Method in class com.splunk.Service
Returns information about distributed search options.
getDistributedPeers() - Method in class com.splunk.Service
Returns a collection of distributed search peers.
getDistributedPeers(Args) - Method in class com.splunk.Service
Returns a collection of distributed search peers.
getDoneProgress() - Method in class com.splunk.Job
Returns the approximate progress of the job, in the range of 0.0 to 1.0.
getDouble() - Method in class com.splunk.modularinput.SingleValueParameter
Coerces the value of this field to a double.
getDropCount() - Method in class com.splunk.Job
Returns the number of possible events that were dropped due to the rt_queue_size (the number of events that the indexer should use for this search).
getDropEventsOnQueueFull() - Method in class com.splunk.OutputDefault
Returns the amount of time this forwarder waits before dropping events if the output queue is full.
getEarliestAcceleratedTime() - Method in class com.splunk.DataModel
Return the earliest time of the window over which the data model is accelerated.
getEarliestTime() - Method in class com.splunk.Job
Returns the earliest time in the time range to search.
getElementText(XMLStreamReader) - Static method in class com.splunk.AtomObject
 
getEmail() - Method in class com.splunk.User
Returns the user's email address.
getEnableOnlineBucketRepair() - Method in class com.splunk.Index
Returns whether asynchronous "online fsck" bucket repair is enabled.
getEnableRealtimeSearch() - Method in class com.splunk.Index
Indicates whether real-time search is enabled for this index.
getEnableSplunkWebSSL() - Method in class com.splunk.Settings
Indicates whether SSL is enabled on the Splunk management port.
getEncryptedPassword() - Method in class com.splunk.Password
Returns the encrypted password for this credential.
getEnd() - Method in class com.splunk.RangePivotColumnSplit
 
getEnd() - Method in class com.splunk.RangePivotRowSplit
 
getEndpoint() - Method in class com.splunk.DeploymentServerClass
Returns the URL template string, which specifies the endpoint from which content can be downloaded by a deployment client.
getEndTime() - Method in class com.splunk.ScriptInput
Returns the time when the scripted input stopped running.
getEventAvailableCount() - Method in class com.splunk.Job
Returns the count of events stored by search that are available to be retrieved from the events endpoint.
getEventCount() - Method in class com.splunk.Job
Returns the count of events (pre-transforming) that were generated.
getEventFieldCount() - Method in class com.splunk.Job
Returns the count of event fields.
getEventIsStreaming() - Method in class com.splunk.Job
Indicates whether the events from this job are available by streaming.
getEventIsTruncated() - Method in class com.splunk.Job
Indicates whether any events from this job have not been stored.
getEvents() - Method in class com.splunk.Job
Returns the InputStream IO handle for this job's events.
getEvents(Map) - Method in class com.splunk.Job
Returns the InputStream IO handle for this job's events.
getEvents(JobEventsArgs) - Method in class com.splunk.Job
Returns the InputStream IO handle for this job's events.
getEventSearch() - Method in class com.splunk.Job
Returns the subset of the entire search that is before any transforming commands.
getEventSorting() - Method in class com.splunk.Job
Returns a value that indicates how events are sorted.
getEventTypes() - Method in class com.splunk.Service
Returns a collection of saved event types.
getEventTypes(Args) - Method in class com.splunk.Service
Returns a collection of saved event types.
getExpirationTime() - Method in class com.splunk.FiredAlert
Returns the rendered expiration time for this alert.
getExpirationTime() - Method in class com.splunk.License
Returns the time and date this license expires.
getExpression() - Method in class com.splunk.EvalDataModelCalculation
 
getExpression() - Method in class com.splunk.RegexpDataModelCalculation
 
getFalseDisplayValue() - Method in class com.splunk.BooleanPivotRowSplit
 
getFeatures() - Method in class com.splunk.License
Returns a list of enabled features for this license.
getField(String) - Method in class com.splunk.DataModelObject
Fetch a single field of a given name from this data model object.
getField(String) - Method in class com.splunk.modularinput.InputDefinition
Gets the name of the field to fetch.
getFieldName() - Method in class com.splunk.PivotCellValue
 
getFieldName() - Method in class com.splunk.PivotColumnSplit
 
getFieldName() - Method in class com.splunk.PivotFilter
 
getFieldName() - Method in class com.splunk.PivotRowSplit
 
getFields() - Method in class com.splunk.DataModelObject
Return all the fields, whether input or created by calculations.
getFields() - Method in class com.splunk.ResultsReaderCsv
Returns a collection of field names from the results.
getFields() - Method in class com.splunk.ResultsReaderJson
This method is not supported.
getFields() - Method in class com.splunk.ResultsReaderXml
Returns a collection of field names from the results.
getFields() - Method in interface com.splunk.SearchResults
Returns a collection of field names from the results.
getFields() - Method in class com.splunk.WindowsWmiInput
Returns the properties (fields) collected for this class for this WMI input.
getFieldSearch() - Method in class com.splunk.DataModelField
 
getFileCount() - Method in class com.splunk.MonitorInput
Returns the file count of this monitor input.
getFilePath() - Method in class com.splunk.ApplicationArchive
Returns a path indicating where the app archive file is stored on the server, for direct file access.
getFilters() - Method in class com.splunk.PivotSpecification
 
getFilterType() - Method in class com.splunk.DeploymentServerClass
Returns the filter type that is applied first.
getFiredAlertGroups() - Method in class com.splunk.Service
Returns a collection of alerts that have been fired by the service.
getFiredAlertsGroups(Args) - Method in class com.splunk.Service
Returns a collection of alerts that have been fired by the service.
getFloat() - Method in class com.splunk.modularinput.SingleValueParameter
Coerces the value of this field to a float.
getFollowTail() - Method in class com.splunk.MonitorInput
Indicates whether files that are seen for the first time will be read from the end.
getForwardedIndex0Whitelist() - Method in class com.splunk.OutputDefault
Returns the inclusive set of indexes (whitelist 0) for this forwarder.
getForwardedIndex1Blacklist() - Method in class com.splunk.OutputDefault
Returns the exclusive set of indexes (blacklist 1) for this forwarder.
getForwardedIndex2Whitelist() - Method in class com.splunk.OutputDefault
Returns the inclusive set of indexes (whitelist 2) for this forwarder.
getFrozenTimePeriodInSecs() - Method in class com.splunk.Index
Returns the maximum age for a bucket, after which the data in this index rolls to frozen.
getGeneratedField(String) - Method in class com.splunk.DataModelCalculation
 
getGeneratedFields() - Method in class com.splunk.DataModelCalculation
 
getGroup() - Method in class com.splunk.ScriptInput
Returns the OS group of commands for this scripted input.
getGroup() - Method in class com.splunk.TcpInput
Returns the group of this raw TCP input.
getGroup() - Method in class com.splunk.TcpSplunkInput
Returns the group for this cooked TCP input.
getGroup() - Method in class com.splunk.UdpConnections
Return the server name.
getGroup() - Method in class com.splunk.UdpInput
Returns the group for this UDP input.
getGroupByFields() - Method in class com.splunk.DataModelTransaction
 
getGroupId() - Method in class com.splunk.License
Returns the group ID for this license.
getGuid() - Method in class com.splunk.DistributedPeer
Returns this peer's GUID.
getGuid() - Method in class com.splunk.ServiceInfo
Returns a GUID identifying this Splunk instance.
getHeader() - Method in class com.splunk.RequestMessage
Returns a map of message headers.
getHeader() - Method in class com.splunk.ResponseMessage
Returns the response headers.
getHeartbeatFrequency() - Method in class com.splunk.OutputDefault
Returns the frequency that specifies how often to send a heartbeat packet to the receiving server.
getHive() - Method in class com.splunk.WindowsRegistryInput
Returns the hive name to monitor for this Windows Registry input.
getHomepage() - Method in class com.splunk.ApplicationUpdate
Returns the fully-qualified URL to the app's homepage.
getHomePath() - Method in class com.splunk.Index
Returns the absolute path to both hot and warm buckets for this index.
getHomePathExpanded() - Method in class com.splunk.Index
Returns the expanded absolute path to both hot and warm buckets for this index.
getHost() - Method in class com.splunk.HttpService
Returns the host name of this service.
getHost() - Method in class com.splunk.modularinput.Event
Gets a host specifying the name of the network host on which this event was produced.
getHost() - Method in class com.splunk.MonitorInput
Returns the host for this monitor input.
getHost() - Method in class com.splunk.ScriptInput
Returns the source host for this scripted input.
getHost() - Method in class com.splunk.Settings
Returns the default host name to use for data inputs.
getHost() - Method in class com.splunk.TcpInput
Returns the source host of this raw TCP input where this indexer gets its data.
getHost() - Method in class com.splunk.TcpSplunkInput
Returns the source host for this cooked TCP input where this indexer gets its data.
getHost() - Method in class com.splunk.UdpInput
Returns the source host for this UDP input, where this indexer gets its data.
getHostRegex() - Method in class com.splunk.MonitorInput
Returns the regular expression for a file path to determine the host.
getHosts() - Method in class com.splunk.WindowsEventLogInput
Returns a list of secondary hosts used for monitoring.
getHttpPort() - Method in class com.splunk.Settings
Returns the port on which Splunk Web is listening for this instance of Splunk.
getIgnoreOlderThan() - Method in class com.splunk.MonitorInput
Returns a time value that defines a rolling time window for monitoring files.
getImportedCapabilities() - Method in class com.splunk.Role
Returns an array of capabilities imported for this role.
getImportedIndexesAllowed() - Method in class com.splunk.Role
Returns an array of indexes that a user with this role has permissions to search.
getImportedIndexesDefault() - Method in class com.splunk.Role
Returns an array of indexes to search by default when no index is specified for a user with this role.
getImportedRealTimeSearchJobsQuota() - Method in class com.splunk.Role
Returns the maximum number of concurrent real-time search jobs a user with this role is allowed to run.
getImportedRoles() - Method in class com.splunk.Role
Returns an array of roles to import attributes from, such as capabilities and allowed indexes to search.
getImportedRtSearchJobsQuota() - Method in class com.splunk.Role
Deprecated. Use Role.getImportedRealTimeSearchJobsQuota() instead.
getImportedSearchDiskQuota() - Method in class com.splunk.Role
Returns the maximum disk space that can be used for search jobs by a user with this role.
getImportedSearchFilter() - Method in class com.splunk.Role
Returns a search string that restricts the scope of searches run by this role.
getImportedSearchJobsQuota() - Method in class com.splunk.Role
Returns the maximum number of concurrent searches a user with this role is allowed to run.
getImportedSearchTimeWindow() - Method in class com.splunk.Role
Returns the maximum time span of a search, in seconds.
getIndex() - Method in class com.splunk.modularinput.Event
Gets an index field specifying which index Splunk should write this event to.
getIndex() - Method in class com.splunk.MonitorInput
Gets the index where events from this monitor input are stored.
getIndex() - Method in class com.splunk.ScriptInput
Returns the index name for this scripted input.
getIndex() - Method in class com.splunk.TcpInput
Returns the index name of this raw TCP input.
getIndex() - Method in class com.splunk.TcpSplunkInput
Returns the index name for this cooked TCP input.
getIndex() - Method in class com.splunk.UdpInput
Returns the index name for this UDP input.
getIndex() - Method in class com.splunk.WindowsActiveDirectoryInput
Returns the index name of this Windows Active Directory input.
getIndex() - Method in class com.splunk.WindowsEventLogInput
Returns the index name of this Windows Event Log input.
getIndex() - Method in class com.splunk.WindowsPerfmonInput
Returns the index name of this Windows Perfmon input.
getIndex() - Method in class com.splunk.WindowsRegistryInput
Returns the index name for this Windows Registry input.
getIndex() - Method in class com.splunk.WindowsWmiInput
Returns the index name of this WMI input.
getIndexes() - Method in class com.splunk.Service
Returns a collection of Splunk indexes.
getIndexes(IndexCollectionArgs) - Method in class com.splunk.Service
Returns a collection of Splunk indexes.
getIndexes(Args) - Method in class com.splunk.Service
Returns a collection of Splunk indexes.
getIndexThreads() - Method in class com.splunk.Index
Returns the index thread for this index.
getInfo() - Method in class com.splunk.Service
Returns information about the Splunk service.
getInputField() - Method in class com.splunk.GeoIPDataModelCalculation
 
getInputField() - Method in class com.splunk.RegexpDataModelCalculation
 
getInputFieldMappings() - Method in class com.splunk.LookupDataModelCalculation
 
getInputKinds() - Method in class com.splunk.InputCollection
Return a set of all the input kinds recognized by the Splunk server.
getInputs() - Method in class com.splunk.modularinput.InputDefinition
 
getInputs() - Method in class com.splunk.Service
Returns a collection of configured inputs.
getInputs(Args) - Method in class com.splunk.Service
Returns a collection of configured inputs.
getInstances() - Method in class com.splunk.WindowsPerfmonInput
Returns the counter instances of this Windows Perfmon input.
getInstances() - Method in class com.splunk.WindowsWmiInput
Returns a list of the WMI class instances for this WMI input.
getInt() - Method in class com.splunk.modularinput.SingleValueParameter
Coerces the value of this field to an int.
getInterval() - Method in class com.splunk.ScriptInput
Returns the frequency for running this scripted input.
getInterval() - Method in class com.splunk.WindowsPerfmonInput
Returns the interval at which to poll the performance counters for this Windows Perfmon input.
getInterval() - Method in class com.splunk.WindowsWmiInput
Returns the interval at which WMI input providers are queried for this WMI input.
getJob(String) - Method in class com.splunk.Service
Returns a Job by the provided sid.
getJobs() - Method in class com.splunk.Service
Returns a collection of current search jobs.
getJobs(CollectionArgs) - Method in class com.splunk.Service
Returns a collection of current search jobs.
getJobs(Args) - Method in class com.splunk.Service
Returns a collection of current search jobs.
getKey() - Method in class com.splunk.Message
Returns the title of this message.
getKeywords() - Method in class com.splunk.Job
Returns all positive keywords used by this job.
getKind() - Method in class com.splunk.Input
Returns an InputKind representing this input's type.
getKind() - Method in class com.splunk.MonitorInput
Returns the type of monitor input.
getKind() - Method in class com.splunk.ScriptInput
Returns the input kind for this scripted input.
getKind() - Method in class com.splunk.TcpInput
Returns the input kind of this input.
getKind() - Method in class com.splunk.TcpSplunkInput
Returns the input kind of this input.
getKind() - Method in class com.splunk.UdpInput
Returns the input kind for this input.
getKind() - Method in class com.splunk.WindowsActiveDirectoryInput
Returns the input kind of this input.
getKind() - Method in class com.splunk.WindowsEventLogInput
Returns the input kind of this input.
getKind() - Method in class com.splunk.WindowsPerfmonInput
Returns the input kind of this input.
getKind() - Method in class com.splunk.WindowsRegistryInput
Returns the input kind for this input.
getKind() - Method in class com.splunk.WindowsWmiInput
Returns the input kind of this input.
getLabel() - Method in class com.splunk.Application
Returns the app's label (its name).
getLabel() - Method in class com.splunk.Job
Returns this job's label.
getLabel() - Method in class com.splunk.License
Returns the label for this license.
getLabel() - Method in class com.splunk.LicenseSlave
Returns the label for this license slave.
getLabel() - Method in class com.splunk.LicenseStack
Returns the label of this license stack.
getLabel() - Method in class com.splunk.PivotCellValue
 
getLabel() - Method in class com.splunk.PivotRowSplit
 
getLastInitTime() - Method in class com.splunk.Index
Returns the last initialization time for this index.
getLatestTime() - Method in class com.splunk.Job
Returns the latest time in the time range to search.
getLevel() - Method in class com.splunk.Logger
Returns the logging level of this logger.
getLicenseGroups() - Method in class com.splunk.Service
Returns a collection of license group configurations.
getLicenseGroups(Args) - Method in class com.splunk.Service
Returns a collection of license group configurations.
getLicenseHash() - Method in class com.splunk.License
Returns the hash value for this license.
getLicenseKeys() - Method in class com.splunk.ServiceInfo
Returns an array of the license keys for this Splunk instance.
getLicenseLabels() - Method in class com.splunk.ServiceInfo
Returns an array of the service's license labels.
getLicenseMessages() - Method in class com.splunk.Service
Returns a collection of messages from the licenser.
getLicenseMessages(Args) - Method in class com.splunk.Service
Returns a collection of messages from the licenser.
getLicensePools() - Method in class com.splunk.Service
Returns a collection of licenser pool configurations.
getLicensePools(Args) - Method in class com.splunk.Service
Returns a collection of licenser pool configurations.
getLicenses() - Method in class com.splunk.Service
Returns a collection of licenses for this service.
getLicenses(Args) - Method in class com.splunk.Service
Returns a collection of licenses for this service.
getLicenseSignature() - Method in class com.splunk.DistributedPeer
Returns this peer's license signature.
getLicenseSignature() - Method in class com.splunk.ServiceInfo
Returns the license signature for this Splunk instance.
getLicenseSlaves() - Method in class com.splunk.Service
Returns a collection of slaves reporting to this license master.
getLicenseSlaves(Args) - Method in class com.splunk.Service
Returns a collection of slaves reporting to this license master.
getLicenseStacks() - Method in class com.splunk.Service
Returns a collection of license stack configurations.
getLicenseStacks(Args) - Method in class com.splunk.Service
Returns a collection of license stack configurations.
getLicenseState() - Method in class com.splunk.ServiceInfo
Returns the current license state of this Splunk instance.
getLimit() - Method in class com.splunk.LimitPivotFilter
 
getLimit() - Method in class com.splunk.RangePivotRowSplit
 
getLineage() - Method in class com.splunk.DataModelCalculation
Return the lineage of the data model object on which this calculation is defined, starting with the most remote ancestor and ending with the data model object on which this calculation is defined.
getLineage() - Method in class com.splunk.DataModelObject
Data model objects can inherit from other data model objects in the same data model (or from a couple of global base objects such as BaseEvent and BaseTransaction).
getLocalName() - Method in class com.splunk.WindowsEventLogInput
Returns the collection name of this Windows Event Log input.
getLocalName() - Method in class com.splunk.WindowsWmiInput
Returns the collection name for this WMI input.
getLoggers() - Method in class com.splunk.Service
Returns a collection of service logging categories and their status.
getLoggers(Args) - Method in class com.splunk.Service
Returns a collection of service logging categories and their status.
getLogs() - Method in class com.splunk.WindowsEventLogInput
Returns the list of event log names to gather data from for this Windows Event Log input.
getLong() - Method in class com.splunk.modularinput.SingleValueParameter
Coerces the value of this field to a long.
getLookupHost() - Method in class com.splunk.WindowsEventLogInput
Returns the main host of this Windows Event Log input.
getLookupHost() - Method in class com.splunk.WindowsWmiInput
Returns the main server for this WMI input.
getLookupName() - Method in class com.splunk.LookupDataModelCalculation
 
getMasterGuid() - Method in class com.splunk.ServiceInfo
Returns a GUID identifying the license master for this Splunk instance.
getMaxBloomBackfillBucketAge() - Method in class com.splunk.Index
Returns the time that indicates a bucket age.
getMaxConcurrent() - Method in class com.splunk.SavedSearch
Returns the maximum number of concurrent instances of this search the scheduler is allowed to run.
getMaxConcurrentOptimizes() - Method in class com.splunk.Index
Returns the maximum number of concurrent optimize processes that can run against a hot bucket for this index.
getMaxDataSize() - Method in class com.splunk.Index
Returns the maximum data size before triggering a roll from hot to warm buckets for this index.
getMaxHotBuckets() - Method in class com.splunk.Index
Returns the maximum number of hot buckets that can exist for this index.
getMaxHotIdleSecs() - Method in class com.splunk.Index
Returns the maximum lifetime of a hot bucket for this index.
getMaxHotSpanSecs() - Method in class com.splunk.Index
Returns the upper bound of the target maximum timespan of hot and warm buckets for this index.
getMaxMemMB() - Method in class com.splunk.Index
Returns the amount of memory to allocate for buffering a single .tsidx file into memory before flushing to disk.
getMaxMetaEntries() - Method in class com.splunk.Index
Returns the maximum number of unique lines that are allowed in a bucket's .data files for this index.
getMaxPause() - Method in class com.splunk.DataModelTransaction
maxPause is the maximum amount of time between two events in a transaction, specified as a string such as "1m" for one minute or "20s" for twenty seconds.
getMaxQueueSize() - Method in class com.splunk.OutputDefault
Returns the maximum size of the output queue for this forwarder.
getMaxRunningProcessGroups() - Method in class com.splunk.Index
Returns the maximum number of concurrent helper processes for this index.
getMaxSpan() - Method in class com.splunk.DataModelTransaction
maxSpan is the maximum amount of time (in a Splunk defined format, such as "1m" for one minute or "20s" for twenty seconds) that a single transaction can span.
getMaxTime() - Method in class com.splunk.Index
Returns the maximum time attribute for this index.
getMaxTimeUnreplicatedNoAcks() - Method in class com.splunk.Index
Returns the upper limit, in seconds, for how long an event can sit in a raw slice.
getMaxTimeUnreplicatedWithAcks() - Method in class com.splunk.Index
Returns the upper limit, in seconds, for how long an event can sit unacknowledged in a raw slice.
getMaxTotalDataSizeMB() - Method in class com.splunk.Index
Returns the maximum size of this index.
getMaxViolations() - Method in class com.splunk.License
Returns the maximum number of violations allowed for this license.
getMaxWarmDBCount() - Method in class com.splunk.Index
Returns the maximum number of warm buckets for this index.
getMemPoolMB() - Method in class com.splunk.Index
Returns the memory pool for this index.
getMessages() - Method in class com.splunk.Service
Returns a collection of system messages.
getMessages(Args) - Method in class com.splunk.Service
Returns a collection of system messages.
getMetadata() - Method in class com.splunk.Entity
Returns the metadata (eai:acl) of this entity.
getMethod() - Method in class com.splunk.OutputGroup
Returns the type of output processor for this forwarder group.
getMethod() - Method in class com.splunk.OutputServer
Returns the data distribution method used when two or more servers exist in the same forwarder group.
getMethod() - Method in class com.splunk.RequestMessage
Returns the message's HTTP method.
getMgmtPort() - Method in class com.splunk.Settings
Returns the IP address:port number for Splunkd.
getMinFreeSpace() - Method in class com.splunk.Settings
Returns the amount of free disk space that is required for Splunk to continue searching and indexing.
getMinRawFileSyncSecs() - Method in class com.splunk.Index
Returns the frequency at which Splunkd forces a filesystem sync while compressing journal slices for this index.
getMinTime() - Method in class com.splunk.Index
Returns the minimum time attribute for this index.
getMode() - Method in class com.splunk.ServiceInfo
Returns the current mode of this Splunk instance.
getModularInputKinds() - Method in class com.splunk.Service
Returns a collection of modular inputs.
getModularInputKinds(Args) - Method in class com.splunk.Service
Returns a collection of modular inputs.
getMonitorSubnodes() - Method in class com.splunk.WindowsRegistryInput
Indicates whether this Windows Registry input monitors all sub-nodes under a given hive.
getMonitorSubtree() - Method in class com.splunk.WindowsActiveDirectoryInput
Indicates whether the directory path subtree is being monitored for this Windows Active Directory input.
getName() - Method in class com.splunk.DataModelField
 
getName() - Method in class com.splunk.DataModelObject
 
getName() - Method in class com.splunk.Job
Returns this job's name (its search ID).
getName() - Method in class com.splunk.modularinput.Argument
Gets the name that Splunk uses to represent this argument.
getName() - Method in class com.splunk.modularinput.MultiValueParameter
Gets the name of this parameter.
getName() - Method in class com.splunk.modularinput.Parameter
 
getName() - Method in class com.splunk.modularinput.SingleValueParameter
 
getName() - Method in class com.splunk.modularinput.ValidationDefinition
Gets the name of the proposed modular input instance.
getName() - Method in class com.splunk.Password
Returns the username for this credential.
getName() - Method in class com.splunk.Resource
Returns the resource name.
getNextElement() - Method in class com.splunk.MultiResultsReader
 
getNextEvent() - Method in class com.splunk.ResultsReader
Returns the next event in the event stream.
getNextScheduledTime() - Method in class com.splunk.SavedSearch
Returns the next scheduled time.
getNoAppendingTimeStamp() - Method in class com.splunk.UdpInput
Indicates whether Splunk prepends a timestamp and host name to incoming events.
getNoPriorityStripping() - Method in class com.splunk.UdpInput
Indicates whether Splunk removes the priority field from incoming events.
getNumBloomfilters() - Method in class com.splunk.Index
Returns the number of bloom filters created for this index.
getNumHotBuckets() - Method in class com.splunk.Index
Returns the number of hot buckets that were created for this index.
getNumPreviews() - Method in class com.splunk.Job
Returns the number of previews that have been generated so far for this job.
getNumWarmBuckets() - Method in class com.splunk.Index
Returns the number of warm buckets created for this index.
getObject(String) - Method in class com.splunk.DataModel
Retrieve an object by name from this data model.
getObject() - Method in class com.splunk.WindowsPerfmonInput
Returns the performance monitor object for this Windows Perfmon input (for example, "Process", "Server", or "PhysicalDisk").
getObjects() - Method in class com.splunk.DataModel
 
getObjectsToGroup() - Method in class com.splunk.DataModelTransaction
 
getOffset() - Method in class com.splunk.Upload
Returns the current offset.
getOsBuild() - Method in class com.splunk.ServiceInfo
Returns the OS build of this Splunk instance.
getOsName() - Method in class com.splunk.ServiceInfo
Returns the service's OS name (type).
getOsVersion() - Method in class com.splunk.ServiceInfo
Returns the OS version of this Splunk instance.
getOutputDefault() - Method in class com.splunk.Service
Returns global TCP output properties.
getOutputGroups() - Method in class com.splunk.Service
Returns a collection of output group configurations.
getOutputGroups(Args) - Method in class com.splunk.Service
Returns a collection of output group configurations.
getOutputServers() - Method in class com.splunk.Service
Returns a collection of data-forwarding configurations.
getOutputServers(Args) - Method in class com.splunk.Service
Returns a collection of data-forwarding configurations.
getOutputSyslogs() - Method in class com.splunk.Service
Returns a collection of configurations for forwarding data in standard syslog format.
getOutputSyslogs(Args) - Method in class com.splunk.Service
Returns a collection of configurations for forwarding data in standard syslog format.
getOwner() - Method in class com.splunk.DataModelCalculation
Returns the name of the object on which this calculation is defined.
getOwner() - Method in class com.splunk.DataModelConstraint
 
getOwner() - Method in class com.splunk.EntityMetadata
Returns the username of the entity owner.
getOwner() - Method in class com.splunk.PivotCellValue
 
getOwner() - Method in class com.splunk.PivotColumnSplit
 
getOwner() - Method in class com.splunk.Service
Returns the current owner context for this Service instance.
getOwnerLineage() - Method in class com.splunk.DataModelField
Return the lineage of the data model object on which this field is defined.
getOwnerLineage() - Method in class com.splunk.PivotFilter
 
getOwnerLineage() - Method in class com.splunk.PivotRowSplit
 
getOwnerName() - Method in class com.splunk.DataModelField
Return the name of the data model object on which this field is defined.
getOwnerName() - Method in class com.splunk.PivotFilter
 
getOwnerName() - Method in class com.splunk.PivotRowSplit
 
getParameters() - Method in class com.splunk.modularinput.ValidationDefinition
 
getParent() - Method in class com.splunk.DataModelObject
 
getParentName() - Method in class com.splunk.DataModelObject
Returns the name of the parent of this object.
getParsedExpirationTime() - Method in class com.splunk.FiredAlert
Returns the rendered expiration time for this alert, parsed as a Date object.
getPartialServiceMetaPeriod() - Method in class com.splunk.Index
Returns the frequency at which metadata is for partially synced (synced in-place) for this index.
getPass4SymmKey() - Method in class com.splunk.Settings
Returns the string that is prepended to the Splunk symmetric key to generate the final key that used to sign all traffic between master and slave licensers.
getPassAuth() - Method in class com.splunk.ScriptInput
Returns the username that this scripted input runs under.
getPassword() - Method in class com.splunk.Password
Returns the displayable password string for this credential.
getPassword() - Method in class com.splunk.Service
Returns the current password that was used to authenticate the session.
getPassword() - Method in class com.splunk.User
Returns the user's password.
getPasswords() - Method in class com.splunk.Service
Returns a collection of passwords.
getPasswords(Args) - Method in class com.splunk.Service
Returns a collection of passwords.
getPath() - Method in class com.splunk.Resource
Returns the path to this resource.
getPeerName() - Method in class com.splunk.DistributedPeer
Returns this peer's name.
getPeerType() - Method in class com.splunk.DistributedPeer
Returns this peer's type.
getPermissions() - Method in class com.splunk.EntityMetadata
Returns this entity's permissions, which represent an allowable inclusive action:list-of-roles map.
getPivotQuery() - Method in class com.splunk.Pivot
 
getPoolId() - Method in class com.splunk.LicenseMessage
Returns the pool ID of this license message.
getPoolIds() - Method in class com.splunk.LicenseSlave
Returns a list of pool IDs for this license slave.
getPort() - Method in class com.splunk.HttpService
Returns the port number of this service.
getPrefix() - Method in class com.splunk.HttpService
Returns the URL prefix of this service, consisting of scheme://host[:port].
getPrettyQuery() - Method in class com.splunk.Pivot
 
getPriority() - Method in class com.splunk.EventType
Returns the priority of this event type.
getPriority() - Method in class com.splunk.Job
Returns this job's priority in the range of 0-10.
getProc() - Method in class com.splunk.WindowsRegistryInput
Returns the regular expression (regex) that is compared to process names when including or excluding events for this Windows Registry input.
getQualifiedSearch() - Method in class com.splunk.SavedSearch
Returns the qualified search.
getQuarantineFutureSecs() - Method in class com.splunk.Index
Returns the future event-time quarantine for this index.
getQuarantinePastSecs() - Method in class com.splunk.Index
Returns the past event-time quarantine for this index.
getQuery() - Method in class com.splunk.DataModelConstraint
 
getQuery() - Method in class com.splunk.DataModelObject
 
getQueryForDrilldown() - Method in class com.splunk.Pivot
 
getQueue() - Method in class com.splunk.MonitorInput
Returns the queue for this monitor input.
getQueue() - Method in class com.splunk.TcpInput
Returns the queue for this raw TCP input.
getQueue() - Method in class com.splunk.TcpSplunkInput
Returns the queue for this cooked TCP input.
getQueue() - Method in class com.splunk.UdpInput
Returns the queue for this UDP input.
getQuota() - Method in class com.splunk.License
Returns the daily indexing quota, which is the maximum bytes per day of indexing volume for this license.
getQuota() - Method in class com.splunk.LicensePool
Returns the indexing quota for this license pool.
getQuota() - Method in class com.splunk.LicenseStack
Returns the combined daily indexing quota for all of the licenses in this license stack.
getRawChunkSizeBytes() - Method in class com.splunk.Index
Returns the target uncompressed size of individual raw slices in the rawdata journal for this index.
getRawJson() - Method in class com.splunk.DataModel
 
getRawJsonDescription() - Method in class com.splunk.DataModelArgs
 
getRawQuery() - Method in class com.splunk.Pivot
 
getRcvBuf() - Method in class com.splunk.MonitorInput
Deprecated. Returns the value of the _rcvbuf attribute for this monitor input.
getRcvBuf() - Method in class com.splunk.ScriptInput
Deprecated. Returns the value of the _rcvbuf attribute for this scripted input.
getRcvBuf() - Method in class com.splunk.TcpInput
Deprecated. Returns the value of the _rcvbuf attribute for this TCP input.
getRcvBuf() - Method in class com.splunk.TcpSplunkInput
Deprecated. Returns the value of the _rcvbuf attribute for this cooked TCP input.
getRcvBuf() - Method in class com.splunk.UdpInput
Deprecated. This is not used anymore. No replacement.
getRealm() - Method in class com.splunk.Password
Returns the credential realm.
getRealName() - Method in class com.splunk.User
Returns the full name associated with this user.
getRealtimeSchedule() - Method in class com.splunk.SavedSearch
Indicates whether the scheduler computes the next run time of a scheduled search based on the current time or on the last search run time (for continuous scheduling).
getRealTimeSearchJobsQuota() - Method in class com.splunk.Role
Returns the maximum number of concurrent real-time search jobs a user with this role is allowed to run.
getReceiver() - Method in class com.splunk.Service
Returns the receiver object for the Splunk service.
getReceiveTimeout() - Method in class com.splunk.DistributedConfiguration
Returns the time-out period for trying to read and receive data from a search peer.
getRecursive() - Method in class com.splunk.MonitorInput
Indicates whether sub-directories are monitored within this monitor input.
getRefresh() - Method in class com.splunk.Application
Indicates whether to reload objects contained in the locally-installed app.
getRefresh() - Method in class com.splunk.ApplicationArchive
Indicates whether to reload the objects contained in the locally-installed app.
getRefresh() - Method in class com.splunk.ApplicationSetup
Indicates whether to reload the objects contained in the locally-installed app.
getRemoteSearch() - Method in class com.splunk.Job
Returns the search string that is sent to every search peer for this job.
getRemovedTimedOutServers() - Method in class com.splunk.DistributedConfiguration
Indicates whether timed-out servers are removed from the distributed configuration.
getReplicationStatus() - Method in class com.splunk.DistributedPeer
Returns this peer's replication status.
getReportSearch() - Method in class com.splunk.Job
Returns the reporting subset of this search, which is the streaming part of the search that is send to remote providers if reporting commands are used.
getRepositoryLocation() - Method in class com.splunk.DeploymentServerClass
Returns the location on the deployment server to store the content that is to be deployed for this server class.
getRequestUiDispatchApp() - Method in class com.splunk.SavedSearch
Returns the app in which Splunk Web dispatches this search.
getRequestUiDispatchView() - Method in class com.splunk.SavedSearch
Returns the view in which Splunk Web displays this search.
getRequiredOnCreate() - Method in class com.splunk.ModularInputKindArgument
Indicates whether this argument is required when creating a modular input of this kind.
getRequiredOnEdit() - Method in class com.splunk.ModularInputKindArgument
Indicates whether this argument is required when editing a modular input of this kind.
getRestartOnSearchPeerAdd() - Method in class com.splunk.SavedSearch
Indicates whether a real-time search managed by the scheduler is restarted when a search peer becomes available for this saved search.
getRestrictToHost() - Method in class com.splunk.TcpInput
Returns the incoming host restriction for this raw TCP input.
getRestrictToHost() - Method in class com.splunk.TcpSplunkInput
Returns the incoming host restriction for this cooked TCP input.
getResultCount() - Method in class com.splunk.Job
Returns the total count of results returned for this search job.
getResultIsStreaming() - Method in class com.splunk.Job
Indicates whether the job's results are available by streaming.
getResultPreviewCount() - Method in class com.splunk.Job
Returns the number of result rows in the latest preview results for this job.
getResults() - Method in class com.splunk.Job
Returns the InputStream IO handle for the results from this job.
getResults(Map) - Method in class com.splunk.Job
Returns the InputStream IO handle for the results from this job.
getResults(JobResultsArgs) - Method in class com.splunk.Job
Returns the InputStream IO handle for the results from this job.
getResultsPreview() - Method in class com.splunk.Job
Returns the InputStream IO handle for the preview results from this job.
getResultsPreview(Map) - Method in class com.splunk.Job
Returns the InputStream IO handle for the preview results from this job.
getResultsPreview(JobResultsPreviewArgs) - Method in class com.splunk.Job
Returns the InputStream IO handle for the preview results from this job.
getRoles() - Method in class com.splunk.Service
Returns a collection of Splunk user roles.
getRoles(Args) - Method in class com.splunk.Service
Returns a collection of Splunk user roles.
getRoles() - Method in class com.splunk.User
Returns an array of roles assigned to this user.
getRotatePeriodInSecs() - Method in class com.splunk.Index
Returns the frequency to check for the need to create a new hot bucket and the need to roll or freeze any warm or cold buckets for this index.
getRowSplits() - Method in class com.splunk.PivotSpecification
 
getRtSearchJobsQuota() - Method in class com.splunk.Role
Deprecated. Use Role.getRealTimeSearchJobsQuota() instead.
getRunDuration() - Method in class com.splunk.Job
Returns the time that the search job took to complete.
getRunOnStartup() - Method in class com.splunk.SavedSearch
Indicates whether this search is run when Splunk starts.
getSavedSearches() - Method in class com.splunk.Service
Returns a collection of saved searches.
getSavedSearches(SavedSearchCollectionArgs) - Method in class com.splunk.Service
Returns a collection of saved searches.
getSavedSearches(Args) - Method in class com.splunk.Service
Returns a collection of saved searches.
getSavedSearchName() - Method in class com.splunk.FiredAlert
Returns the saved search for this alert.
getScanCount() - Method in class com.splunk.Job
Returns the number of events that are scanned or read off disk.
getScheme() - Method in class com.splunk.HttpService
Returns the scheme used by this service.
getScheme() - Method in class com.splunk.modularinput.Script
Gets the scheme that defines the parameters understood by this modular input.
getSearch() - Method in class com.splunk.EventType
Returns the search terms for this event type.
getSearch() - Method in class com.splunk.Job
Returns this job's search title.
getSearch() - Method in class com.splunk.SavedSearch
Returns the search query for this saved search.
getSearchDiskQuota() - Method in class com.splunk.Role
Returns the maximum disk space that can be used for search jobs by a user with this role.
getSearchEarliestTime() - Method in class com.splunk.Job
Returns the earliest time in the time range to search.
getSearchFilter() - Method in class com.splunk.Role
Returns a search string that restricts the scope of searches run by this role.
getSearchIndexesAllowed() - Method in class com.splunk.Role
Returns an array of indexes that a user with this role has permissions to search.
getSearchIndexesDefault() - Method in class com.splunk.Role
Returns an array of indexes to search by default when no index is specified for a user with this role.
getSearchJobsQuota() - Method in class com.splunk.Role
Returns the maximum number of concurrent searches a user with this role is allowed to run.
getSearchLatestTime() - Method in class com.splunk.Job
Returns the latest time in the time range to search.
getSearchLog() - Method in class com.splunk.Job
Returns the InputStream IO handle to the search log for this job.
getSearchLog(Map) - Method in class com.splunk.Job
Returns the InputStream IO handle to the search log for this job.
getSearchProviders() - Method in class com.splunk.Job
Returns a list of search peers that were contacted for this search.
getSearchTimeWin() - Method in class com.splunk.Role
Deprecated. Use Role.getSearchTimeWindow() instead.
getSearchTimeWindow() - Method in class com.splunk.Role
Returns the maximum time span of a search that is allowed for users in this role.
getSegmentedRaw() - Method in class com.splunk.Event
Gets the XML markup for the "_raw" field value.
getSendCookedData() - Method in class com.splunk.OutputDefault
Indicates whether Splunk has processed ("cooked") the event data.
getSendTimeout() - Method in class com.splunk.DistributedConfiguration
Returns the time-out period for trying to write or send data to a search peer.
getServer() - Method in class com.splunk.OutputSyslog
Returns the destination host:port of this server.
getServerClasses() - Method in class com.splunk.DeploymentClient
Returns the list of server classes.
getServerHost() - Method in class com.splunk.modularinput.InputDefinition
Gets the name of the server on which this modular input is being run.
getServerHost() - Method in class com.splunk.modularinput.ValidationDefinition
Gets the name of the server on which this modular input is being run.
getServerName() - Method in class com.splunk.ServiceInfo
Returns the server name of this Splunk instance.
getServerName() - Method in class com.splunk.Settings
Returns the name that is used to identify this Splunk instance for features such as distributed search.
getServername() - Method in class com.splunk.TcpConnections
Returns the server name.
getServers() - Method in class com.splunk.DistributedConfiguration
Returns a list of peer servers.
getServers() - Method in class com.splunk.OutputGroup
Returns the list of servers for this forwarder group.
getServers() - Method in class com.splunk.WindowsWmiInput
Returns a list of secondary servers used for monitoring.
getServerUri() - Method in class com.splunk.modularinput.InputDefinition
Gets the URI to the server on which this modular input is being run.
getServerUri() - Method in class com.splunk.modularinput.ValidationDefinition
Gets the URI to the server on which this modular input is being run.
getService() - Method in class com.splunk.Resource
Returns the Service instance this resource is connected to.
getServiceMetaPeriod() - Method in class com.splunk.Index
Returns the frequency at which metadata is synced to disk for this index.
getSessionKey() - Method in class com.splunk.modularinput.InputDefinition
Sets a session providing access to splunkd's REST API on this host.
getSessionKey() - Method in class com.splunk.modularinput.ValidationDefinition
Gets a session key providing access to splunkd's REST API on this host.
getSessionTimeout() - Method in class com.splunk.Settings
Returns the amount of time before a user session times out.
getSettings() - Method in class com.splunk.Service
Returns service configuration information for an instance of Splunk.
getSetupXml() - Method in class com.splunk.ApplicationSetup
Returns the app's setup information in XML format.
getSeverity() - Method in class com.splunk.FiredAlert
Returns this alert's severity on a scale of 1 to 10, with 1 being the highest severity.
getSeverity() - Method in class com.splunk.LicenseMessage
Returns the severity of this license message.
getShareBundles() - Method in class com.splunk.DistributedConfiguration
Indicates whether this server uses bundle replication to share search-time configuration with search peers.
getSharing() - Method in class com.splunk.EntityMetadata
Returns how this entity is shared (app, global, and/or user).
getSid() - Method in class com.splunk.FiredAlert
Returns this alert's search ID (SID).
getSid() - Method in class com.splunk.Job
Returns the unique search identifier (SID) for this job.
getSize() - Method in class com.splunk.ApplicationUpdate
Returns the size of the app update.
getSize() - Method in class com.splunk.Upload
Returns the current size.
getSlaveId() - Method in class com.splunk.LicenseMessage
Returns the slave ID of this license message.
getSlaves() - Method in class com.splunk.LicensePool
Returns the list of slaves for this license pool.
getSlavesUsageBytes() - Method in class com.splunk.LicensePool
Returns the usage of indexing volume by slave licenses in this license pool.
getSortDirection() - Method in class com.splunk.LimitPivotFilter
 
getSource() - Method in class com.splunk.modularinput.Event
Gets the file, service, or other producer that this Event comes from.
getSource() - Method in class com.splunk.MonitorInput
Returns the source of events from this monitor input.
getSource() - Method in class com.splunk.ScriptInput
Returns the source of events from this scripted input.
getSource() - Method in class com.splunk.TcpInput
Returns the initial source key for this raw TCP input.
getSource() - Method in class com.splunk.TcpSplunkInput
Returns the initial source key for this cooked TCP input.
getSource() - Method in class com.splunk.UdpInput
Returns the initial source key for this UDP input.
getSourcePort() - Method in class com.splunk.OutputServer
Returns the port on the destination server where data is forwarded.
getSourcePort() - Method in class com.splunk.OutputServerAllConnections
Returns the port on the destination server where data is forwarded.
getSourcesIndexed() - Method in class com.splunk.Upload
Returns the number of sources that are indexed.
getSourceType() - Method in class com.splunk.modularinput.Event
Gets a classification of this event.
getSourceType() - Method in class com.splunk.MonitorInput
Returns the source type of events from this monitor input.
getSourceType() - Method in class com.splunk.ScriptInput
Returns the source type of events from this scripted input.
getSourceType() - Method in class com.splunk.TcpInput
Returns the source type for events from this raw TCP input.
getSourceType() - Method in class com.splunk.TcpSplunkInput
Returns the event source type for this cooked TCP input.
getSourceType() - Method in class com.splunk.UdpInput
Returns the event source type for this UDP input.
getSourceTypes() - Method in class com.splunk.License
Returns the source types that, when indexed, count against the indexing volume for this license.
getSplunkDB() - Method in class com.splunk.Settings
Returns the fully-qualified path to the directory containing the default index for this instance of Splunk.
getSplunkHome() - Method in class com.splunk.Settings
Returns the fully-qualified path to the Splunk installation directory.
getSpoolTime() - Method in class com.splunk.Upload
Returns the start time of the upload that is being indexed.
getSSL() - Method in class com.splunk.TcpInput
Indicates whether this raw TCP input is using secure socket layer (SSL).
getSSL() - Method in class com.splunk.TcpSplunkInput
Indicates whether this cooked TCP input is using secure socket layer (SSL).
getSslSecurityProtocol() - Static method in class com.splunk.HttpService
Returns the SSL security protocol of this service.
getSSLSocketFactory() - Static method in class com.splunk.HttpService
 
getStackId() - Method in class com.splunk.License
Returns the stack ID for this license.
getStackId() - Method in class com.splunk.LicenseMessage
Returns the stack ID of this license message.
getStackId() - Method in class com.splunk.LicensePool
Returns the stack ID for this license pool.
getStackIds() - Method in class com.splunk.LicenseGroup
Returns the stack IDs of the license stacks in this license group.
getStackIds() - Method in class com.splunk.LicenseSlave
Returns a list of stack IDs for this license pool.
getStanza() - Method in class com.splunk.modularinput.Event
Gets the name of the input this event should be sent to.
getStart() - Method in class com.splunk.RangePivotColumnSplit
 
getStart() - Method in class com.splunk.RangePivotRowSplit
 
getStartingNode() - Method in class com.splunk.WindowsActiveDirectoryInput
Returns the starting location in the directory path for this Windows Active Directory input.
getStartTime() - Method in class com.splunk.ScriptInput
Returns the time when the script was started.
getStartWebServer() - Method in class com.splunk.Settings
Indicates whether the instance is configured to start Splunk Web.
getStatsFunction() - Method in class com.splunk.LimitPivotFilter
 
getStatsFunction() - Method in class com.splunk.PivotCellValue
 
getStatus() - Method in class com.splunk.DistributedPeer
Return this peer's overall status.
getStatus() - Method in exception com.splunk.HttpException
Returns the HTTP status code.
getStatus() - Method in class com.splunk.License
Returns the status of this license.
getStatus() - Method in class com.splunk.OutputServer
Returns the server connection status (usually "connect_done", "connect_fail", or "connect_try").
getStatus() - Method in class com.splunk.OutputServerAllConnections
Returns the status of this connection.
getStatus() - Method in class com.splunk.ResponseMessage
Returns the response status.
getStatusBuckets() - Method in class com.splunk.Job
Returns the maximum number of timeline buckets for this job.
getStatusTimeout() - Method in class com.splunk.DistributedConfiguration
Returns the time-out period for gathering a search peer's basic information.
getStep() - Method in class com.splunk.RangePivotColumnSplit
 
getStep() - Method in class com.splunk.RangePivotRowSplit
 
getStreamingMode() - Method in class com.splunk.modularinput.Scheme
Returns whether this modular input kind will send events to Splunk as XML (the default and preferred value) or plain text.
getStreamingMode() - Method in class com.splunk.ModularInputKind
Returns the streaming mode of this modular input kind.
getSummary() - Method in class com.splunk.Job
Returns the InputStream IO handle for the summary for this job.
getSummary(Map) - Method in class com.splunk.Job
Returns the InputStream IO handle for the summary for this job.
getSummary(JobSummaryArgs) - Method in class com.splunk.Job
Returns the InputStream IO handle for the summary for this job.
getSuppressBannerList() - Method in class com.splunk.Index
Returns a list of indexes that suppress "index missing" messages.
getSync() - Method in class com.splunk.Index
Returns the number of events that trigger the indexer to sync events.
getSyncMeta() - Method in class com.splunk.Index
Indicates whether the sync operation is called before the file descriptor is closed on metadata updates.
getTags() - Method in class com.splunk.EventType
Deprecated. Use tags.conf.spec file to assign tags to groups of events with related field values. Returns the list of tags for this event type.
getTargetDc() - Method in class com.splunk.WindowsActiveDirectoryInput
Returns the fully-qualified domain name of a valid, network-accessible domain controller.
getTargetRepositoryLocation() - Method in class com.splunk.DeploymentServerClass
Returns the location on the deployment client where the content to be deployed for this server class should be installed.
getTargetUri() - Method in class com.splunk.DeploymentClient
Returns the target URI of the deployment server for this deployment client.
getText() - Method in exception com.splunk.SplunkException
 
getThawedPath() - Method in class com.splunk.Index
Returns the absolute path to the thawed index for this index.
getThawedPathExpanded() - Method in class com.splunk.Index
Returns the expanded absolute path to the thawed index for this index.
getThrottleCheckPeriod() - Method in class com.splunk.Index
Returns the frequency at which Splunk checks for an index throttling condition.
getTime() - Method in class com.splunk.modularinput.Event
Gets a java.util.Date object giving the timestamp that should be sent with this event.
getTimeBeforeClose() - Method in class com.splunk.MonitorInput
Returns the time period for keeping a file open.
getTimeline() - Method in class com.splunk.Job
Returns the InputStream IO handle for the timeline for this job.
getTimeline(Map) - Method in class com.splunk.Job
Returns the InputStream IO handle for the timeline for this job.
getTitle() - Method in class com.splunk.modularinput.Scheme
Gets the title of this modular input kind.
getTitle() - Method in class com.splunk.ModularInputKind
Returns the title of this modular input kind, which is also displayed in Splunk Web (rather than the name used in the REST API).
getTitle() - Method in class com.splunk.Resource
Return the title of this resource, which corresponds to the Atom <title> element.
getTmpFolder() - Method in class com.splunk.DeploymentServerClass
Returns the location of the working folder used by the deployment server.
getToken() - Method in class com.splunk.Service
Returns the current session token.
getTotalEventCount() - Method in class com.splunk.Index
Returns the total event count for this index.
getTriggeredAlertCount() - Method in class com.splunk.FiredAlert
Returns the count of triggered alerts.
getTriggerTime() - Method in class com.splunk.FiredAlert
Returns the time this alert was triggered.
getTriggerTimeRendered() - Method in class com.splunk.FiredAlert
Returns this alert's rendered trigger time.
getTrueDisplayValue() - Method in class com.splunk.BooleanPivotRowSplit
 
getTrustedIP() - Method in class com.splunk.Settings
Returns the IP address of the authenticating proxy.
getTtl() - Method in class com.splunk.Job
Returns this job's time to live--that is, the time before the search job expires and is still available.
getType() - Method in class com.splunk.DataModelField
 
getType() - Method in class com.splunk.License
Returns the license type.
getType() - Method in class com.splunk.LicenseStack
Returns the license type of the licenses in this license stack.
getType() - Method in class com.splunk.ModularInputKindArgument
Returns the type of this argument to the modular input.
getType() - Method in class com.splunk.OutputSyslog
Returns the connection type of this server.
getType() - Method in class com.splunk.PivotFilter
 
getType() - Method in class com.splunk.User
Returns the authentication method responsible for this user.
getType() - Method in class com.splunk.WindowsRegistryInput
Returns the regular expressions (regexes) that are compared to registry event types for this Windows Registry input.
getTz() - Method in class com.splunk.User
Returns the time zone to use when displaying dates for this user.
getUpdate() - Method in class com.splunk.Application
Returns any update information that is available for the app.
getUpdateName() - Method in class com.splunk.ApplicationUpdate
Returns the app's name.
getUploads() - Method in class com.splunk.Service
Returns a collection of in-progress oneshot uploads.
getUploads(Args) - Method in class com.splunk.Service
Returns a collection of in-progress oneshot uploads.
getUrl() - Method in class com.splunk.ApplicationArchive
Returns a URL to the app archive file on the server, for web browser access.
getUrl(String) - Method in class com.splunk.HttpService
Constructs a fully-qualified URL for this service using a given path.
getUsedBytes() - Method in class com.splunk.LicensePool
Returns the usage of indexing volume for this license pool.
getUsername() - Method in class com.splunk.Password
Returns the username for this credential.
getUsername() - Method in class com.splunk.Service
Returns the Splunk account username that was used to authenticate the current session.
getUsers() - Method in class com.splunk.Service
Returns a collection of Splunk users.
getUsers(Args) - Method in class com.splunk.Service
Returns a collection of Splunk users.
getValidation() - Method in class com.splunk.modularinput.Argument
Gets the validation to be used on this argument, if using internal validation.
getValue() - Method in class com.splunk.Message
Returns the content of this message.
getValue() - Method in class com.splunk.modularinput.SingleValueParameter
Returns the parameter as found (as a String), without trying to coerce it to another type.
getValues() - Method in class com.splunk.modularinput.MultiValueParameter
Gets a list of all values of this parameter.
getVersion() - Method in class com.splunk.Application
Returns the version of the app.
getVersion() - Method in class com.splunk.ApplicationUpdate
Returns the app's version.
getVersion() - Method in class com.splunk.DistributedPeer
Returns this peer's version.
getVersion() - Method in class com.splunk.ServiceInfo
Returns the version number of this Splunk instance.
getVsid() - Method in class com.splunk.SavedSearch
Returns the view state ID that is associated with the view specified in the DisplayView attribute.
getWhitelist() - Method in class com.splunk.DeploymentServerClass
Returns a list of hosts included for this server class.
getWhitelist() - Method in class com.splunk.MonitorInput
Returns a regular expression for a file path that, when matched, is indexed.
getWhitelistByIndex(int) - Method in class com.splunk.DeploymentServer
Returns inclusive criteria for determining deployment client access to this deployment server.
getWhitelistByIndex(int) - Method in class com.splunk.DeploymentServerClass
Returns a list of included client addresses, by index.
getWhitelistByIndex(int) - Method in class com.splunk.DeploymentTenant
Returns inclusive criteria for determining deployment client access to this deployment server.
getWindowPeriod() - Method in class com.splunk.License
Returns the number of days remaining in the rolling time window for this license.
getWql() - Method in class com.splunk.WindowsWmiInput
Returns the query string for this WMI input.
groupByFields - Variable in class com.splunk.DataModelTransaction
 

H

hasArgument(String) - Method in class com.splunk.ModularInputKind
Indicates whether this modular input kind has a given argument.
hashCode() - Method in class com.splunk.modularinput.InputDefinition
 
hashCode() - Method in class com.splunk.modularinput.MultiValueParameter
 
hashCode() - Method in class com.splunk.modularinput.SingleValueParameter
 
hashCode() - Method in class com.splunk.modularinput.ValidationDefinition
 
hashCode() - Method in class com.splunk.ResourceCollection
 
history() - Method in class com.splunk.SavedSearch
Returns an array of search jobs created from this saved search.
host - Variable in class com.splunk.HttpService
The host name of the service.
host - Variable in class com.splunk.modularinput.Event
 
host - Variable in class com.splunk.ServiceArgs
Deprecated. Use ServiceArgs.setHost(String) instead.
HttpException - Exception in com.splunk
Thrown for HTTP responses that return an error status code.
HttpService - Class in com.splunk
The HttpService class represents a generic HTTP service at a given address (host:port), accessed using a given protocol scheme (http or https).
HttpService() - Constructor for class com.splunk.HttpService
Constructs a new HttpService instance.
HttpService(String) - Constructor for class com.splunk.HttpService
Constructs a new HttpService instance at the given host.
HttpService(String, int) - Constructor for class com.splunk.HttpService
Constructs a new HttpService instance at the given host and port.
HttpService(String, int, String) - Constructor for class com.splunk.HttpService
Constructs a new HttpService instance using the given host, port, and scheme.
HttpService(String, int, String, URLStreamHandler) - Constructor for class com.splunk.HttpService
Constructs a new HttpService instance using the given host, port, and scheme, and instructing it to use the specified HTTPS handler.
httpsHandler - Variable in class com.splunk.HttpService
A variable to hold an optional custom HTTPS handler

I

id - Variable in class com.splunk.AtomObject
The value of the Atom <id> element.
Index - Class in com.splunk
The Index class represents an index.
index - Variable in class com.splunk.modularinput.Event
 
indexAndForward() - Method in class com.splunk.OutputDefault
Indicates whether to index data locally in addition to forwarding it.
IndexCollection - Class in com.splunk
The IndexCollection class represents a collection of indexes.
IndexCollectionArgs - Class in com.splunk
The IndexCollectionArgs class contains arguments for retrieving indexes from a collection (see Service.getIndexes()).
IndexCollectionArgs() - Constructor for class com.splunk.IndexCollectionArgs
Class constructor.
INFO - Static variable in class com.splunk.modularinput.EventWriter
 
Input - Class in com.splunk
The Input class represents a data input.
InputCollection - Class in com.splunk
The InputCollection class represents a collection of inputs.
InputDefinition - Class in com.splunk.modularinput
The InputDefinition class encodes the XML defining inputs that Splunk passes to a modular input script as a Java object.
inputField - Variable in class com.splunk.LookupDataModelCalculation.LookupFieldMapping
 
InputKind - Class in com.splunk
The InputKind enumeration defines the different types of Splunk data inputs (input kinds).
inputKinds - Variable in class com.splunk.InputCollection
 
inputStream - Variable in class com.splunk.ResultsReader
 
INTERRUPTED - Static variable in exception com.splunk.SplunkException
 
invalidate() - Method in class com.splunk.Resource
Marks the local state of this resource as no longer current.
IPv4Comparison - Enum in com.splunk
Comparison operators that apply to IPv4 values in data models and pivots.
IPv4PivotFilter - Class in com.splunk
Represents a filter on an IPv4 valued field in a pivot.
isAccelerated() - Method in class com.splunk.DataModel
 
isActionEmail() - Method in class com.splunk.SavedSearch
Indicates whether the email action is enabled.
isActionPopulateLookup() - Method in class com.splunk.SavedSearch
Indicates whether the populate-lookup action is enabled.
isActionRss() - Method in class com.splunk.SavedSearch
Indicates whether the RSS action is enabled.
isActionScript() - Method in class com.splunk.SavedSearch
Indicates whether the script action is enabled.
isActionSummaryIndex() - Method in class com.splunk.SavedSearch
Indicates whether the summary-index action is enabled.
isActive() - Method in class com.splunk.LicenseGroup
Indicates whether this license group is active.
isCompressed() - Method in class com.splunk.OutputDefault
Indicates whether this forwarder sends compressed data.
isConfigured() - Method in class com.splunk.Application
Indicates whether the app's custom setup has been performed.
isDigestMode() - Method in class com.splunk.FiredAlert
Indicates whether the result is a set of events (digest) or a single event (per result).
isDigestMode() - Method in class com.splunk.SavedSearch
Indicates whether Splunk applies the alert actions to the entire result set (digest) or to each individual search result (per result).
isDisabled() - Method in class com.splunk.Entity
Indicates whether this entity is disabled.
isDistSearchEnabled() - Method in class com.splunk.DistributedConfiguration
Indicates whether distributed search is enabled.
isDone() - Method in class com.splunk.Job
Indicates whether the job is done.
isDone() - Method in class com.splunk.modularinput.Event
Gets a value indicating whether this is the last piece of an event broken across multiple Event objects.
isEditable() - Method in class com.splunk.DataModelCalculation
 
isEditable() - Method in class com.splunk.DataModelField
Some fields are part of system objects such as BaseEvent or are part of the structure of the object, such as a field with the same name as the object.
isEmpty() - Method in class com.splunk.Entity
isEmpty() - Method in class com.splunk.ResourceCollection
isEndElement(XMLStreamReader, String) - Static method in class com.splunk.AtomObject
 
isFailed() - Method in class com.splunk.Job
Indicates whether the job failed.
isFinalized() - Method in class com.splunk.Job
Indicates whether the job is finalized (forced to finish).
isForwardedIndexFilterDisable() - Method in class com.splunk.OutputDefault
Indicates whether the index filter for this forwarder is disabled.
isFree() - Method in class com.splunk.ServiceInfo
Indicates whether this Splunk instance is running under a free license.
isHidden() - Method in class com.splunk.DataModelField
 
isHttps() - Method in class com.splunk.DistributedPeer
Indicates whether this peer is using HTTPS.
isImplicitIdRequired() - Method in class com.splunk.ApplicationUpdate
Indicates whether an implicit ID is required.
isInternal() - Method in class com.splunk.Index
Indicates whether this index is an internal index.
isModifiable() - Method in class com.splunk.EntityMetadata
Indicates whether this entity can be modified.
isMultivalued() - Method in class com.splunk.DataModelField
 
isNameChangeAllowed() - Method in class com.splunk.Entity
Returns whether this entity's name can be changed via Entity.update(java.util.Map).
isNameChangeAllowed() - Method in class com.splunk.OutputDefault
 
isPaused() - Method in class com.splunk.Job
Indicates whether the job is paused.
isPreview() - Method in class com.splunk.ResultsReaderCsv
This method is not supported.
isPreview() - Method in class com.splunk.ResultsReaderJson
Indicates whether the results are a preview from an unfinished search.
isPreview() - Method in class com.splunk.ResultsReaderXml
Indicates whether the results are a preview from an unfinished search.
isPreview() - Method in interface com.splunk.SearchResults
Indicates whether the results are a preview from an unfinished search.
isPreviewEnabled() - Method in class com.splunk.Job
Indicates whether preview for the job is enabled.
isReady() - Method in class com.splunk.Job
Indicates whether the job has been scheduled and is ready to return data.
isRealTimeSearch() - Method in class com.splunk.Job
Indicates whether the job is a real-time search.
isRemoteTimeline() - Method in class com.splunk.Job
Indicates whether the job has a remote timeline component.
isRequired() - Method in class com.splunk.DataModelField
 
isRequiredOnCreate() - Method in class com.splunk.modularinput.Argument
Returns whether a value for this argument must be specified when creating a modular input of this kind.
isRequiredOnEdit() - Method in class com.splunk.modularinput.Argument
Returns whether a value for this argument must be specified when editing an existing modular input of this kind.
isRtSearchEnabled() - Method in class com.splunk.ServiceInfo
Indicates whether real-time search is enabled for the service.
isSaved() - Method in class com.splunk.Job
Indicates whether the job is to be saved indefinitely.
isSavedSearch() - Method in class com.splunk.Job
Indicates whether this job was run as a saved search (via scheduler).
isScheduled() - Method in class com.splunk.SavedSearch
Indicates whether this search is run on a schedule.
isStartElement(XMLStreamReader, String) - Static method in class com.splunk.AtomObject
 
isTrial() - Method in class com.splunk.ServiceInfo
Indicates whether this Splunk instance is running under a trial license.
isUnbroken() - Method in class com.splunk.modularinput.Event
Gets a value indicating whether this event is completely encapsulated in this Event object.
isUseExternalValidation() - Method in class com.splunk.modularinput.Scheme
Returns whether Splunk should use the modular input kind script to validate the arguments of a particular modular input or use the validation predicates specified by the arguments.
isUseSingleInstance() - Method in class com.splunk.modularinput.Scheme
Returns whether Splunk should run all modular inputs of this kind via one instance of the script or start an instance for each modular input.
isVisible() - Method in class com.splunk.Application
Indicates whether the app is visible and navigable from Splunk Web.
isVisible() - Method in class com.splunk.SavedSearch
Indicates whether the search should be visible in the saved search list.
isZombie() - Method in class com.splunk.Job
Indicates whether the process running the search is dead but with the search not finished.
itemClass - Variable in class com.splunk.ResourceCollection
 
itemKey(AtomEntry) - Method in class com.splunk.JobCollection
Returns the job's unique search identifier (SID), which is used as this item's key.
itemKey(AtomEntry) - Method in class com.splunk.PasswordCollection
Returns the username for a credential.
itemKey(AtomEntry) - Method in class com.splunk.ResourceCollection
Returns the value to use as the key from a given Atom entry.
itemKind(String) - Method in class com.splunk.InputCollection
Returns the input kind for a given path.
itemPath(AtomEntry) - Method in class com.splunk.ConfCollection
Returns the endpoint path for this configuration stanza.
itemPath(AtomEntry) - Method in class com.splunk.ResourceCollection
Returns the value to use as the member's path from a given Atom entry.
items - Variable in class com.splunk.ResourceCollection
 
itemsPerPage - Variable in class com.splunk.AtomFeed
The value of the Atom feed's <itemsPerPage> element.
iterator() - Method in class com.splunk.MultiResultsReader
Returns an iterator over the sets of results from this reader.
iterator() - Method in class com.splunk.ResultsReader
Returns an iterator over the events from this reader.

J

Job - Class in com.splunk
The Job class represents a job, which is an individual instance of a running or completed search or report, along with its related output.
JOB_NOTREADY - Static variable in exception com.splunk.SplunkException
 
JobArgs - Class in com.splunk
The JobArgs class contains arguments for creating a Job.
JobArgs() - Constructor for class com.splunk.JobArgs
Class constructor.
JobArgs.ExecutionMode - Enum in com.splunk
Specifies how to create a job using the JobCollection.create(java.lang.String) method.
JobArgs.SearchMode - Enum in com.splunk
Specifies how to create a job using the JobCollection.create(java.lang.String) method.
JobCollection - Class in com.splunk
The JobCollection class represents a collection of jobs.
JobEventsArgs - Class in com.splunk
The JobEventsArgs class contains arguments for getting events using the Job.getEvents() method.
JobEventsArgs() - Constructor for class com.splunk.JobEventsArgs
Class constructor.
JobEventsArgs.OutputMode - Enum in com.splunk
Specifies the format for the returned output.
JobEventsArgs.TruncationMode - Enum in com.splunk
Specifies how to truncate lines to achieve the value in JobEventsArgs.setMaximumLines(int).
JobExportArgs - Class in com.splunk
The JobExportArgs class contains arguments for exporting events using the Service.export(java.lang.String) method.
JobExportArgs() - Constructor for class com.splunk.JobExportArgs
Class constructor.
JobExportArgs.OutputMode - Enum in com.splunk
Specifies the format for the returned output.
JobExportArgs.SearchMode - Enum in com.splunk
Specifies how to create a job using the JobCollection.create(java.lang.String) method.
JobExportArgs.TruncationMode - Enum in com.splunk
Specifies how to truncate lines to achieve the value in JobExportArgs.setMaximumLines(int).
JobResultsArgs - Class in com.splunk
The JobResultsArgs class contains arguments for getting job results using the Job.getResults() method.
JobResultsArgs() - Constructor for class com.splunk.JobResultsArgs
Class constructor.
JobResultsArgs.OutputMode - Enum in com.splunk
Specifies the format for the returned output.
JobResultsPreviewArgs - Class in com.splunk
The JobResultsPreviewArgs class contains arguments for getting job results previews using the Job.getResultsPreview() method.
JobResultsPreviewArgs() - Constructor for class com.splunk.JobResultsPreviewArgs
Class constructor.
JobResultsPreviewArgs.OutputMode - Enum in com.splunk
Specifies the format for the returned output.
JobSummaryArgs - Class in com.splunk
The JobSummaryArgs class contains arguments for getting a job summary using the Job.getSummary() method.
JobSummaryArgs() - Constructor for class com.splunk.JobSummaryArgs
Class constructor.

K

keySet() - Method in class com.splunk.Entity
keySet() - Method in class com.splunk.ResourceCollection

L

License - Class in com.splunk
The License class represents a license, providing access to the licenses for this Splunk instance.
LicenseGroup - Class in com.splunk
The LicenseGroup class represents a license group, which is a collection of one or more license stacks.
LicenseMessage - Class in com.splunk
The LicenseMessage class represents a license message.
LicensePool - Class in com.splunk
The LicensePool class represents a license pool, which is made up of a single license master and zero or more license slave instances of Splunk that are configured to use the licensing volume from a set license or license stack.
LicensePoolCollection - Class in com.splunk
The LicensePoolCollection class represents a collection of license pools.
LicenseSlave - Class in com.splunk
The LicenseSlave class represents a license slave, which is a member of one or more license pools.
LicenseStack - Class in com.splunk
The LicenseStack class represents a license stack, which is a collection of licenses of the same type.
LimitPivotFilter - Class in com.splunk
Represents a limit on the events shown in a pivot by sorting them according to some field, then taking the specified number from the beginning or end of the list.
links - Variable in class com.splunk.AtomObject
The value of the <link> elements in this AtomObject.
list() - Method in class com.splunk.JobCollection
Returns the job's response.
list() - Method in class com.splunk.ResourceCollection
Issues an HTTP request to list the contents of the collection resource.
log(String, String) - Method in class com.splunk.modularinput.EventWriter
Logs messages about the state of this modular input to Splunk.
log(String) - Method in class com.splunk.Receiver
Submits an event to this index through HTTP POST.
log(String, String) - Method in class com.splunk.Receiver
Submits an event to this index through HTTP POST.
log(Args, String) - Method in class com.splunk.Receiver
Submits an event to this index through HTTP POST.
log(String, Args, String) - Method in class com.splunk.Receiver
Logs an event to this index through HTTP POST.
Logger - Class in com.splunk
The Logger class represents a specific Splunkd logging category.
login() - Method in class com.splunk.Service
Authenticates the Service instance with the username and password that were specified when the instance was created.
login(String, String) - Method in class com.splunk.Service
Authenticates the Service instance with a specified username and password.
logout() - Method in class com.splunk.Service
Forgets the current session token.
LookupDataModelCalculation - Class in com.splunk
Represents a lookup calculation on a data model object.
LookupDataModelCalculation.LookupFieldMapping - Class in com.splunk
 
LookupDataModelCalculation.LookupFieldMapping() - Constructor for class com.splunk.LookupDataModelCalculation.LookupFieldMapping
 
lookupField - Variable in class com.splunk.LookupDataModelCalculation.LookupFieldMapping
 

M

MalformedDataException - Exception in com.splunk.modularinput
Exception thrown when parsing XML that is syntactically valid, but does not match the schema expected by the Splunk SDK for Java.
MalformedDataException(String) - Constructor for exception com.splunk.modularinput.MalformedDataException
 
matchesInputName(InputKind, String, String) - Static method in class com.splunk.InputCollection
Indicates whether a given string matches the input name (string equality).
maxPause - Variable in class com.splunk.DataModelTransaction
 
maxSpan - Variable in class com.splunk.DataModelTransaction
 
Message - Class in com.splunk
The Message class represents a message.
MessageCollection - Class in com.splunk
The MessageCollection class represents a collection of messages, providing access to Splunk system messages.
ModularInputKind - Class in com.splunk
The ModularInputKind class represents a particular modular input.
ModularInputKindArgument - Class in com.splunk
The ModularInputKindArgument class is a map-like object that is specialized to represent arguments for modular input kinds.
ModularInputKindArgument.Type - Enum in com.splunk
 
Monitor - Static variable in class com.splunk.InputKind
Monitor input.
MonitorInput - Class in com.splunk
The MonitorInput class represents a monitor input, which is a file, directory, script, or network port that is monitored for new data.
MultiResultsReader<T extends ResultsReader> - Class in com.splunk
The MultiResultsReader class represents a streaming reader for Splunk search results.
MultiResultsReaderJson - Class in com.splunk
The MultiResultsReaderJson class represents a streaming JSON reader for Splunk search results.
MultiResultsReaderJson(InputStream) - Constructor for class com.splunk.MultiResultsReaderJson
Class constructor.
MultiResultsReaderXml - Class in com.splunk
The MultiResultsReaderXml class represents a streaming XML reader for Splunk search results.
MultiResultsReaderXml(InputStream) - Constructor for class com.splunk.MultiResultsReaderXml
Class constructor.
MultiValueParameter - Class in com.splunk.modularinput
The MultiValueParameter class represents a parameter containing multiple values that is passed as part of a definition of a modular input instance.

N

name - Variable in class com.splunk.modularinput.Argument
 
nodeToParameterList(Node) - Static method in class com.splunk.modularinput.Parameter
Generates a list of Parameter objects from an org.w3c.dom.Node object containing a set of parameters.
NonblockingInputStream - Class in com.splunk.modularinput
The NonblockingInputStream class is a stream wrapper that acts as though the underlying stream has terminated every time it blocks.
NonblockingInputStream(InputStream) - Constructor for class com.splunk.modularinput.NonblockingInputStream
 
NumberComparison - Enum in com.splunk
Comparison operators on numeric fields.
NumberPivotFilter - Class in com.splunk
Specifies a filter in a pivot on a numeric field.
NumberPivotRowSplit - Class in com.splunk
Specifies a row split in a pivot on a numeric field.
NumericPivotColumnSplit - Class in com.splunk
 

O

objectsToGroup - Variable in class com.splunk.DataModelTransaction
 
oneshotSearch(String) - Method in class com.splunk.Service
Creates a oneshot synchronous search.
oneshotSearch(String, Map) - Method in class com.splunk.Service
Creates a oneshot synchronous search using search arguments.
oneshotSearch(String, Args) - Method in class com.splunk.Service
Creates a oneshot synchronous search using search arguments.
open(int) - Method in class com.splunk.Service
Opens a raw socket to this service.
OutputDefault - Class in com.splunk
The OutputDefault class represents the default TCP output configuration, providing access to global TCP output properties.
OutputGroup - Class in com.splunk
The OutputGroup class represents an output group, providing access to the configuration of a group of one or more data-forwarding destinations.
OutputServer - Class in com.splunk
The OutputServer class represents an output server, providing access to data-forwarding configurations.
OutputServerAllConnections - Class in com.splunk
The OutputServerAllConnections class represents all the connections of an output server.
OutputSyslog - Class in com.splunk
The OutputSyslog class represents a syslog output, providing access to properties of a forwarding server that provides data in standard syslog format.
owner - Variable in class com.splunk.Service
The current owner context.
owner - Variable in class com.splunk.ServiceArgs
Deprecated. Use ServiceArgs.setOwner(String) instead.

P

Parameter - Class in com.splunk.modularinput
The Parameter class is a base class for parameters of modular inputs.
parse(JsonElement) - Static method in class com.splunk.DataModelField
 
parse(String) - Method in class com.splunk.Service
Parses a search query and returns a semantic map for the search in JSON format.
parse(String, Map) - Method in class com.splunk.Service
Parses a search query with additional arguments and returns a semantic map for the search in JSON format.
parse(InputStream) - Static method in class com.splunk.Xml
Parses the given input stream and returns it as an XML document object model (DOM).
parseDefinition(InputStream) - Static method in class com.splunk.modularinput.InputDefinition
Parses a stream containing XML into an InputDefinition.
parseDefinition(InputStream) - Static method in class com.splunk.modularinput.ValidationDefinition
Create a ValidationDefinition from a provided stream containing XML.
parseEnd(XMLStreamReader) - Method in class com.splunk.AtomObject
Parses the element at the current cursor position and reads the corresponding end element.
parseStream(InputStream) - Static method in class com.splunk.AtomEntry
Creates a new AtomEntry instance based on a given stream.
parseStream(InputStream) - Static method in class com.splunk.AtomFeed
Creates a new AtomFeed instance based on the given stream.
parseText(XMLStreamReader) - Method in class com.splunk.AtomObject
Parses and returns the text value of the element at the current cursor position and reads the corresponding end element.
parseType(String) - Static method in enum com.splunk.FieldType
 
Password - Class in com.splunk
The Password class represents a saved credential.
password - Variable in class com.splunk.Service
The password, which is used to authenticate the Splunk instance.
PasswordCollection - Class in com.splunk
The PasswordCollection class represents a collection of credentials.
passwordEndPoint - Variable in class com.splunk.Service
The default password endpoint, can change over Splunk versions.
path - Variable in class com.splunk.Resource
 
pause() - Method in class com.splunk.Job
Pauses the current search.
Pivot - Class in com.splunk
A call of pivot on a PivotSpecification object queries splunkd to get the queries corresponding to that pivot, which will be returned as an instance of the Pivot class.
pivot() - Method in class com.splunk.PivotSpecification
Query Splunk for SPL queries corresponding to this pivot.
PivotCellValue - Class in com.splunk
Represents an aggregate value to appear in the cells of a pivot.
PivotColumnSplit - Class in com.splunk
 
PivotFilter - Class in com.splunk
Base class representing filters in pivots.
PivotRowSplit - Class in com.splunk
Base class representing row splits in a pivot.
PivotSpecification - Class in com.splunk
PivotSpecification represents a pivot to be done on a particular data model object.
port - Variable in class com.splunk.HttpService
The port number of the service.
port - Variable in class com.splunk.ServiceArgs
Deprecated. Use ServiceArgs.setPort(int) instead.
post(String) - Method in class com.splunk.HttpService
Issues a POST request against the service using a given path.
post(String, Map<String, Object>) - Method in class com.splunk.HttpService
Issues a POST request against the service using a given path and form arguments.
published - Variable in class com.splunk.AtomEntry
The value of the Atom entry's <published> element.
put(String, Object) - Method in class com.splunk.Entity
put(String, String) - Method in class com.splunk.Event
 
put(String, T) - Method in class com.splunk.ResourceCollection
putAll(Map<? extends String, ? extends Object>) - Method in class com.splunk.Entity
putAll(Map<? extends String, ? extends String>) - Method in class com.splunk.Event
 
putAll(Map<? extends String, ? extends T>) - Method in class com.splunk.ResourceCollection
Copies all mappings from a given map to this map (unsupported).

R

RangePivotColumnSplit - Class in com.splunk
Split values of a field into rows by ranges of a numeric field.
RangePivotRowSplit - Class in com.splunk
Split values of a field into rows by ranges of a numeric field.
read() - Method in class com.splunk.modularinput.NonblockingInputStream
 
Receiver - Class in com.splunk
The Receiver class represents a named index and unnamed index receivers.
ReceiverBehavior - Interface in com.splunk
The ReceiverBehavior interface represents actions to be taken given an output stream connected to Splunk over which a program can stream events.
Record - Class in com.splunk
The Record class represents an extension of HashMap that contains a variety of value-converting access methods.
Record() - Constructor for class com.splunk.Record
 
refresh() - Method in class com.splunk.Entity
Refreshes the local state of this resource.
refresh() - Method in class com.splunk.InputCollection
Refreshes this input collection.
refresh() - Method in class com.splunk.Job
Refreshes this job.
refresh() - Method in class com.splunk.Resource
Refreshes the local state of this resource.
refresh() - Method in class com.splunk.ResourceCollection
Refreshes the local state of this resource.
refreshArgs - Variable in class com.splunk.Resource
 
RegexpDataModelCalculation - Class in com.splunk
Represents a calculation on a data model object done by a regular expression.
reload() - Method in class com.splunk.DeploymentClient
Reloads the deployment client from the configuration file.
remove(Object) - Method in class com.splunk.Entity
remove() - Method in class com.splunk.Entity
Removes this entity from its corresponding collection.
remove(String) - Method in class com.splunk.EntityCollection
Removes an entity from this collection.
remove(String, Args) - Method in class com.splunk.EntityCollection
Removes an entity from this collection, with a namespace restriction.
remove(Object) - Method in class com.splunk.Event
 
remove(String) - Method in class com.splunk.IndexCollection
Removes an entity from this collection.
remove(String) - Method in class com.splunk.InputCollection
Removes an entity from this collection.
remove(String, Args) - Method in class com.splunk.InputCollection
Removes an entity from this collection, with a namespace restriction.
remove() - Method in class com.splunk.Job
Unsupported.
remove(Object) - Method in class com.splunk.ResourceCollection
RequestMessage - Class in com.splunk
The RequestMessage class represents an HTTP request message including method, headers, and body content.
RequestMessage() - Constructor for class com.splunk.RequestMessage
Creates a new RequestMessage instance.
RequestMessage(String) - Constructor for class com.splunk.RequestMessage
Creates a new RequestMessage instance with a given method
requiredOnCreate - Variable in class com.splunk.modularinput.Argument
 
requiredOnEdit - Variable in class com.splunk.modularinput.Argument
 
Resource - Class in com.splunk
The Resource abstract base class represents a Splunk resource.
ResourceCollection<T extends Resource> - Class in com.splunk
The ResourceCollection abstract base class represents a collection of Splunk resources.
ResponseMessage - Class in com.splunk
The ResponseMessage class represents an HTTP response message that includes status codes, response headers, and body content.
restart() - Method in class com.splunk.Service
Restarts the service.
ResultsReader - Class in com.splunk
The ResultsReader class is a base class for the streaming readers for Splunk search results.
ResultsReaderCsv - Class in com.splunk
The ResultsReaderCsv class represents a streaming CSV reader for Splunk search results.
ResultsReaderCsv(InputStream) - Constructor for class com.splunk.ResultsReaderCsv
Class constructor.
ResultsReaderJson - Class in com.splunk
The ResultsReaderJson class represents a streaming JSON reader for Splunk search results.
ResultsReaderJson(InputStream) - Constructor for class com.splunk.ResultsReaderJson
Class constructor.
ResultsReaderXml - Class in com.splunk
The ResultsReaderXml class represents a streaming XML reader for Splunk search results.
ResultsReaderXml(InputStream) - Constructor for class com.splunk.ResultsReaderXml
Class constructor.
Role - Class in com.splunk
The Role class represents a Splunk role, which is a collection of permissions and capabilities.
rollHotBuckets() - Method in class com.splunk.Index
Performs rolling hot buckets for this index.
run(String[]) - Method in class com.splunk.modularinput.Script
Encodes all the common behavior of modular inputs.
run(String[], EventWriter, InputStream) - Method in class com.splunk.modularinput.Script
Encodes all the common behavior of modular inputs.
run() - Method in class com.splunk.Pivot
 
run(JobArgs) - Method in class com.splunk.Pivot
 
run(OutputStream) - Method in interface com.splunk.ReceiverBehavior
 
runQuery() - Method in class com.splunk.DataModelObject
Start a job that fetches all the events of this data model object.
runQuery(JobArgs) - Method in class com.splunk.DataModelObject
Start a job that fetches all the events of this data model object.
runQuery(String) - Method in class com.splunk.DataModelObject
Start a job that applies querySuffix to all the events in this data model object.
runQuery(String, JobArgs) - Method in class com.splunk.DataModelObject
Start a job that applies querySuffix to all the events in this data model object.

S

SavedSearch - Class in com.splunk
The SavedSearch class represents a saved search.
SavedSearchCollection - Class in com.splunk
The SavedSearchCollection class represents a collection of saved searches.
SavedSearchCollectionArgs - Class in com.splunk
The SavedSearchCollectionArgs class contains arguments getting a collection of saved searches.
SavedSearchCollectionArgs() - Constructor for class com.splunk.SavedSearchCollectionArgs
Class constructor.
SavedSearchDispatchArgs - Class in com.splunk
The SavedSearchDispatchArgs class contains arguments for dispatching a saved search using the SavedSearch.dispatch() method.
SavedSearchDispatchArgs() - Constructor for class com.splunk.SavedSearchDispatchArgs
Class constructor.
scan(XMLStreamReader) - Static method in class com.splunk.AtomObject
 
scanEnd(XMLStreamReader) - Static method in class com.splunk.AtomObject
 
scanTag(XMLStreamReader) - Static method in class com.splunk.AtomObject
 
scheme - Variable in class com.splunk.HttpService
The scheme used to access the service.
Scheme - Class in com.splunk.modularinput
The Scheme class represents the metadata for a modular input kind.
Scheme(String) - Constructor for class com.splunk.modularinput.Scheme
 
scheme - Variable in class com.splunk.ServiceArgs
Deprecated. Use ServiceArgs.setScheme(String) instead.
Scheme.StreamingMode - Enum in com.splunk.modularinput
 
Script - Static variable in class com.splunk.InputKind
Script input.
Script - Class in com.splunk.modularinput
The Script class is an abstract base class for implementing modular inputs.
Script() - Constructor for class com.splunk.modularinput.Script
 
ScriptInput - Class in com.splunk
The ScriptInput class represents a scripted data input.
search(String) - Method in class com.splunk.Service
Creates an asynchronous search using the given query.
search(String, Map<String, Object>) - Method in class com.splunk.Service
Creates an asynchronous search job using the given query and search arguments.
SearchResults - Interface in com.splunk
The SearchResults interface represents Splunk search results.
send(String, RequestMessage) - Method in class com.splunk.HttpService
Issue an HTTP request against the service using a given path and request message.
send(String, RequestMessage) - Method in class com.splunk.Service
Issues an HTTP request against the service using a request path and message.
service - Variable in class com.splunk.Resource
 
Service - Class in com.splunk
The Service class represents a Splunk service instance at a given address (host:port), accessed using the http or https protocol scheme.
Service(String) - Constructor for class com.splunk.Service
Creates a new Service instance using a host.
Service(String, int) - Constructor for class com.splunk.Service
Creates a new Service instance using a host and port.
Service(String, int, String) - Constructor for class com.splunk.Service
Creates a new Service instance using a host, port, and scheme for accessing the service (http or https).
Service(String, int, String, URLStreamHandler) - Constructor for class com.splunk.Service
Constructs a new Service instance using the given host, port, and scheme, and instructing it to use the specified HTTPS handler.
Service(ServiceArgs) - Constructor for class com.splunk.Service
Creates a new Service instance using a collection of arguments.
Service(Map<String, Object>) - Constructor for class com.splunk.Service
Creates a new Service instance using a map of arguments.
ServiceArgs - Class in com.splunk
The ServiceArgs class contains a collection of arguments that are used to initialize a Splunk Service instance.
ServiceArgs() - Constructor for class com.splunk.ServiceArgs
 
ServiceInfo - Class in com.splunk
The ServiceInfo class contains information about a running Splunk Service instance (Splunkd).
setAcceleration(boolean) - Method in class com.splunk.DataModel
Enable or disable global acceleration on this data model.
setAccelerationCronSchedule(String) - Method in class com.splunk.DataModel
Set the cron schedule on which the cached data for the acceleration should be updated.
setAccelerationJob(String) - Method in class com.splunk.PivotSpecification
Set a job with a query ending in tscollect, usually generated by createLocalAccelerationJob on a DataModelObject instance, as the acceleration cache for this pivot.
setAccelerationJob(Job) - Method in class com.splunk.PivotSpecification
Set a job with a query ending in tscollect, usually generated by createLocalAccelerationJob on a DataModelObject instance, as the acceleration cache for this pivot.
setAccelerationNamespace(String) - Method in class com.splunk.PivotSpecification
Set the namespace to use for this acceleration, usually the name of a data model.
setActionEmailAuthPassword(String) - Method in class com.splunk.SavedSearch
Sets the password to use when authenticating with the SMTP server.
setActionEmailAuthUsername(String) - Method in class com.splunk.SavedSearch
Sets the username to use when authenticating the SMTP server.
setActionEmailBcc(String) - Method in class com.splunk.SavedSearch
Sets the blind carbon copy (BCC) email address to use for email alerts.
setActionEmailCc(String) - Method in class com.splunk.SavedSearch
Sets the carbon copy (CC) email address to use for email alerts.
setActionEmailCommand(String) - Method in class com.splunk.SavedSearch
Returns the search command (or pipeline) that runs the action.
setActionEmailFormat(String) - Method in class com.splunk.SavedSearch
Sets the format of text in the email.
setActionEmailFrom(String) - Method in class com.splunk.SavedSearch
Sets the email sender's name.
setActionEmailHostname(String) - Method in class com.splunk.SavedSearch
Sets the host name used in the web link (URL) to send in email alerts.
setActionEmailInline(boolean) - Method in class com.splunk.SavedSearch
Sets whether the search results are contained in the body of the email.
setActionEmailMailServer(String) - Method in class com.splunk.SavedSearch
Sets the address of the MTA server that is used to send the emails.
setActionEmailMaxResults(int) - Method in class com.splunk.SavedSearch
Sets the maximum number of search results to send in email alerts.
setActionEmailMaxTime(String) - Method in class com.splunk.SavedSearch
Sets the maximum amount of time an email action takes before the action is canceled.
setActionEmailPdfView(String) - Method in class com.splunk.SavedSearch
Sets the name of the view to deliver if ActionEmailSendPdf is enabled.
setActionEmailPreProcessResults(String) - Method in class com.splunk.SavedSearch
Sets the search string for pre-processing results before emailing them.
setActionEmailReportPaperOrientation(String) - Method in class com.splunk.SavedSearch
Sets the paper orientation.
setActionEmailReportPaperSize(String) - Method in class com.splunk.SavedSearch
Sets the paper size for PDFs.
setActionEmailReportServerEnabled(boolean) - Method in class com.splunk.SavedSearch
Sets whether the PDF server is enabled.
setActionEmailReportServerUrl(String) - Method in class com.splunk.SavedSearch
Sets the URL of the PDF report server.
setActionEmailSendPdf(boolean) - Method in class com.splunk.SavedSearch
Sets whether to create and send the results in PDF format.
setActionEmailSendResults(boolean) - Method in class com.splunk.SavedSearch
Sets whether to attach the search results to an email.
setActionEmailSubject(String) - Method in class com.splunk.SavedSearch
Sets the subject line of the email.
setActionEmailTo(String) - Method in class com.splunk.SavedSearch
Sets a list of email recipients.
setActionEmailTrackAlert(boolean) - Method in class com.splunk.SavedSearch
Sets whether running this email action results in a trackable alert.
setActionEmailTtl(String) - Method in class com.splunk.SavedSearch
Sets the minimum time-to-live in seconds of the search artifacts if an email action is triggered.
setActionEmailUseSsl(boolean) - Method in class com.splunk.SavedSearch
Sets whether to use secure socket layer (SSL) when communicating with the SMTP server.
setActionEmailUseTls(boolean) - Method in class com.splunk.SavedSearch
Sets whether to use transport layer security (TLS) when communicating with the SMTP server.
setActionEmailWidthSortColumns(boolean) - Method in class com.splunk.SavedSearch
Sets whether columns should be sorted from least wide to most wide, left to right.
setActionPopulateLookupCommand(String) - Method in class com.splunk.SavedSearch
Sets the search command (or pipeline) that runs the action.
setActionPopulateLookupDest(String) - Method in class com.splunk.SavedSearch
Sets the name of the lookup table or lookup path to populate.
setActionPopulateLookupHostname(String) - Method in class com.splunk.SavedSearch
Sets the host name used in the web link (URL) to send in populate-lookup alerts.
setActionPopulateLookupMaxResults(int) - Method in class com.splunk.SavedSearch
Sets the maximum number of search results to send in populate-lookup alerts.
setActionPopulateLookupMaxTime(String) - Method in class com.splunk.SavedSearch
Sets the maximum amount of time an alert action takes before the action is canceled.
setActionPopulateLookupTrackAlert(boolean) - Method in class com.splunk.SavedSearch
Sets whether running this populate-lookup action results in a trackable alert.
setActionPopulateLookupTtl(String) - Method in class com.splunk.SavedSearch
Sets the minimum time-to-live (ttl) of the search artifacts if this populate-lookup action is triggered.
setActionRssCommand(String) - Method in class com.splunk.SavedSearch
Sets the search command (or pipeline) that runs the action.
setActionRssHostname(String) - Method in class com.splunk.SavedSearch
Sets the host name to use in the web link (URL) to send in RSS alerts.
setActionRssMaxResults(int) - Method in class com.splunk.SavedSearch
Sets the maximum number of search results to send in RSS alerts.
setActionRssMaxTime(String) - Method in class com.splunk.SavedSearch
Sets the maximum amount of time an RSS action takes before the action is canceled.
setActionRssTrackAlert(boolean) - Method in class com.splunk.SavedSearch
Sets whether running this RSS action results in a trackable alert.
setActionRssTtl(String) - Method in class com.splunk.SavedSearch
Sets the minimum time-to-live in seconds of the search artifacts if an RSS action is triggered.
setActions(String) - Method in class com.splunk.SavedSearch
Sets whichs actions to enable.
setActionScriptCommand(String) - Method in class com.splunk.SavedSearch
Sets the search command (or pipeline) that runs the action.
setActionScriptFilename(String) - Method in class com.splunk.SavedSearch
Sets the file name of the script to call.
setActionScriptHostname(String) - Method in class com.splunk.SavedSearch
Sets the host name used in the web link (URL) to send in script alerts.
setActionScriptMaxResults(int) - Method in class com.splunk.SavedSearch
Sets the maximum number of search results to send in script alerts.
setActionScriptMaxTime(String) - Method in class com.splunk.SavedSearch
Sets the maximum amount of time a script action takes before the action is canceled.
setActionScriptTrackAlert(boolean) - Method in class com.splunk.SavedSearch
Sets whether running this script action results in a trackable alert.
setActionScriptTtl(String) - Method in class com.splunk.SavedSearch
Sets the minimum time-to-live in seconds of the search artifacts if a script action is triggered.
setActionSummaryIndexCommand(String) - Method in class com.splunk.SavedSearch
Sets the search command (or pipeline) that runs the action.
setActionSummaryIndexHostname(String) - Method in class com.splunk.SavedSearch
Sets the host name used in the web link (URL) to send in summary-index alerts.
setActionSummaryIndexInline(boolean) - Method in class com.splunk.SavedSearch
Sets whether to run the summary indexing action as part of the scheduled search.
setActionSummaryIndexMaxResults(int) - Method in class com.splunk.SavedSearch
Sets the maximum number of search results to send in summary-index alerts.
setActionSummaryIndexMaxTime(String) - Method in class com.splunk.SavedSearch
Sets the maximum amount of time a summary-index action takes before the action is canceled.
setActionSummaryIndexName(String) - Method in class com.splunk.SavedSearch
Sets the name of the summary index where the results of the scheduled search are saved.
setActionSummaryIndexTrackAlert(boolean) - Method in class com.splunk.SavedSearch
Sets whether running summary-index action results in a trackable alert.
setActionSummaryIndexTtl(String) - Method in class com.splunk.SavedSearch
Sets the minimum time-to-live in seconds of the search artifacts if a summary-index action is triggered.
setActive(boolean) - Method in class com.splunk.LicenseGroup
Sets whether this license group is active.
setAlertComparator(String) - Method in class com.splunk.SavedSearch
Sets the alert comparator.
setAlertCondition(String) - Method in class com.splunk.SavedSearch
Sets a conditional search that is evaluated against the results of the saved search.
setAlertDigestMode(boolean) - Method in class com.splunk.SavedSearch
Sets whether Splunk applies the alert actions to the entire result set or on each individual result.
setAlertExpires(String) - Method in class com.splunk.SavedSearch
Sets the period of time to show the alert in the dashboard.
setAlertSeverity(int) - Method in class com.splunk.SavedSearch
Sets the alert severity level, which is an integer from 1-6 (1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=SEVERE, 6=FATAL).
setAlertSuppress(boolean) - Method in class com.splunk.SavedSearch
Sets whether to enable alert suppression for this scheduled search.
setAlertSuppressFields(String) - Method in class com.splunk.SavedSearch
Specifies a list of fields to use for alert suppression.
setAlertSuppressPeriod(String) - Method in class com.splunk.SavedSearch
Sets the period for alert suppression.
setAlertThreshold(String) - Method in class com.splunk.SavedSearch
Sets the value to compare to before triggering the alert action.
setAlertTrack(String) - Method in class com.splunk.SavedSearch
Sets how to track the actions triggered by this saved search.
setAlertType(String) - Method in class com.splunk.SavedSearch
Sets a value that indicates what to base the alert on.
setApp(String) - Method in class com.splunk.CollectionArgs
Sets the app context in which to list the collection.
setApp(String) - Method in class com.splunk.ServiceArgs
 
setAppendSlaves(boolean) - Method in class com.splunk.LicensePool
Sets whether to append or overwrite slaves to this license pool.
setArguments(List<Argument>) - Method in class com.splunk.modularinput.Scheme
Replaces the current list of arguments with the specified one.
setAssureUTF8(boolean) - Method in class com.splunk.Index
Sets whether the data retrieved from this index is UTF8-encoded.
setAuthor(String) - Method in class com.splunk.Application
Sets the name of the app's author.
setAutoCancel(int) - Method in class com.splunk.JobArgs
Sets the number of seconds of inactivity after which to automatically cancel a job.
setAutoCancel(int) - Method in class com.splunk.JobExportArgs
Sets the number of seconds of inactivity after which to automatically cancel a job.
setAutoFinalizeEventCount(int) - Method in class com.splunk.JobArgs
Sets the number of events to process after which to auto-finalize the search.
setAutoFinalizeEventCount(int) - Method in class com.splunk.JobExportArgs
Sets the number of events to process after which to auto-finalize the search.
setAutoLB(boolean) - Method in class com.splunk.OutputGroup
Sets whether this forwarder performs automatic load balancing.
setAutoPause(int) - Method in class com.splunk.JobArgs
Sets the number of seconds of inactivity after which to automatically pause a job.
setAutoPause(int) - Method in class com.splunk.JobExportArgs
Sets the number of seconds of inactivity after which to automatically pause a job.
setBaseline(boolean) - Method in class com.splunk.WindowsRegistryInput
Sets whether to establish a baseline value for the registry keys.
setBlacklist(String) - Method in class com.splunk.MonitorInput
Sets a regular expression for a file path that, when matched, is not indexed.
setBlacklistByIndex(int, String) - Method in class com.splunk.DeploymentServerClass
Sets a specific blacklist entry.
setBlacklistNames(String) - Method in class com.splunk.DistributedConfiguration
Sets the blacklist server names that are excluded from being peers.
setBlacklistURLs(String) - Method in class com.splunk.DistributedConfiguration
Sets the blacklist server names or URIs that are excluded from being peers.
setBlockSignSize(int) - Method in class com.splunk.Index
Sets the number of events that make up a block for block signatures.
setBucketRebuildMemoryHint(String) - Method in class com.splunk.Index
Sets the suggested size of the .tsidx file for the bucket rebuild process.
setCapabilities(String[]) - Method in class com.splunk.Role
Assigns an array of capabilities to this role.
setCapabilities(String) - Method in class com.splunk.Role
Assigns a single capability to this role.
setCheckForUpdates(boolean) - Method in class com.splunk.Application
Sets whether Splunk checks Splunkbase for updates to the app.
setCheckIndex(boolean) - Method in class com.splunk.MonitorInput
Sets whether the index value is checked to ensure that it is the name of a valid index.
setCheckPath(boolean) - Method in class com.splunk.MonitorInput
Sets whether the name value is checked to ensure that it exists.
setCheckpointDir(String) - Method in class com.splunk.modularinput.InputDefinition
Sets the path to which to write checkpoint files.
setCheckTimedOutServersFrequency(int) - Method in class com.splunk.DistributedConfiguration
Sets the server recheck frequency.
setClasses(String) - Method in class com.splunk.WindowsWmiInput
Sets the WMI class name.
setColdToFrozenDir(String) - Method in class com.splunk.Index
Sets the destination path for the frozen archive, where Splunk automatically puts frozen buckets.
setColdToFrozenScript(String) - Method in class com.splunk.Index
Sets the path to the archiving script.
setCompressed(boolean) - Method in class com.splunk.OutputGroup
Sets whether this forwarder sends compressed data.
setConfigured(boolean) - Method in class com.splunk.Application
Sets whether the app's custom setup has been performed.
setConnectionHost(String) - Method in class com.splunk.TcpInput
Sets the value for the from-host field for the remote server that is sending data.
setConnectionHost(String) - Method in class com.splunk.TcpSplunkInput
Sets the value for the from-host field for the remote server that is sending data.
setConnectionHost(String) - Method in class com.splunk.UdpInput
Sets the value of the from-host field for the remote server that is sending data.
setConnectionTimeout(int) - Method in class com.splunk.DistributedConfiguration
Sets the time-out period for establishing a search peer connection.
setContent(String) - Method in class com.splunk.RequestMessage
Sets the message body content.
setContent(OutputStream) - Method in class com.splunk.RequestMessage
 
setContinueMatching(boolean) - Method in class com.splunk.DeploymentServerClass
Sets how this deployment server class controls its configurations across classes and server-specific settings.
setCount(int) - Method in class com.splunk.CollectionArgs
Sets the maximum number of entries to return.
setCount(int) - Method in class com.splunk.IndexCollectionArgs
Sets the maximum number of entries to return.
setCount(int) - Method in class com.splunk.JobEventsArgs
Sets the maximum number of results to return.
setCount(int) - Method in class com.splunk.JobResultsArgs
Sets the maximum number of results to return.
setCount(int) - Method in class com.splunk.JobResultsPreviewArgs
Sets the maximum number of results to return.
setCounters(String[]) - Method in class com.splunk.WindowsPerfmonInput
Sets the counters to monitor.
setCounters(String) - Method in class com.splunk.WindowsPerfmonInput
Sets a counter to monitor.
setCrcSalt(String) - Method in class com.splunk.MonitorInput
Sets a string that is used to force Splunk to index files that have a matching cyclic redundancy check (CRC).
setCronSchedule(String) - Method in class com.splunk.SavedSearch
Sets the cron schedule for running this saved search.
setData(String) - Method in class com.splunk.modularinput.Event
Sets the text of the event that Splunk should index.
setDataType(Argument.DataType) - Method in class com.splunk.modularinput.Argument
Sets the data type of this argument.
setDefaultApp(String) - Method in class com.splunk.Role
Sets the default app for this role.
setDefaultApp(String) - Method in class com.splunk.User
Sets the default app for this user.
setDescription(String) - Method in class com.splunk.Application
Sets a short description of the application, which is displayed below the app's title on the Splunk Home tab in Splunk Web.
setDescription(String) - Method in class com.splunk.EventType
Sets the description of the event type.
setDescription(String) - Method in class com.splunk.LicensePool
Sets the description of this license pool.
setDescription(String) - Method in class com.splunk.modularinput.Argument
Sets the human readable description of this argument.
setDescription(String) - Method in class com.splunk.modularinput.Scheme
Sets the human readable description of this modular input kind.
setDescription(String) - Method in class com.splunk.SavedSearch
Sets the description of this saved search.
setDisabled(boolean) - Method in class com.splunk.DeploymentClient
Sets whether to enable or disable the deployment client.
setDisabled(boolean) - Method in class com.splunk.DeploymentServer
Sets whether the deployment server is enabled or disabled.
setDisabled(boolean) - Method in class com.splunk.DeploymentTenant
Sets whether the deployment tenant is enabled or disabled.
setDisabled(boolean) - Method in class com.splunk.DistributedConfiguration
Sets whether the distributed configuration is enabled or disabled.
setDisabled(boolean) - Method in class com.splunk.EventType
Sets whether the event type is enabled or disabled.
setDisabled(boolean) - Method in class com.splunk.SavedSearch
Sets whether the saved search is disabled.
setDisabled(boolean) - Method in class com.splunk.ScriptInput
Sets whether the scripted input is enabled or disabled.
setDisabled(boolean) - Method in class com.splunk.TcpInput
Sets whether this input is enabled or disabled.
setDisabled(boolean) - Method in class com.splunk.TcpSplunkInput
Sets whether this input is enabled or disabled.
setDisabled(boolean) - Method in class com.splunk.WindowsActiveDirectoryInput
Sets whether this input is enabled or disabled.
setDisabled(boolean) - Method in class com.splunk.WindowsPerfmonInput
Sets whether this input is enabled or disabled.
setDisabled(boolean) - Method in class com.splunk.WindowsRegistryInput
Sets whether this input is enabled or disabled.
setDisabled(boolean) - Method in class com.splunk.WindowsWmiInput
Sets whether this input is enabled or disabled.
setDispatchBuckets(String) - Method in class com.splunk.SavedSearch
Deprecated. Use SavedSearch.setDispatchBuckets(int) instead.
setDispatchBuckets(int) - Method in class com.splunk.SavedSearch
Sets the maximum number of timeline buckets.
setDispatchBuckets(int) - Method in class com.splunk.SavedSearchDispatchArgs
Sets the maximum number of timeline buckets.
setDispatchEarliestTime(String) - Method in class com.splunk.SavedSearch
Sets the earliest time for this search.
setDispatchEarliestTime(String) - Method in class com.splunk.SavedSearchDispatchArgs
Specifies the earliest time for this search.
setDispatchEarliestTime(Date) - Method in class com.splunk.SavedSearchDispatchArgs
Sets the earliest time for this search.
setDispatchLatestTime(String) - Method in class com.splunk.SavedSearch
Sets the latest time for this search.
setDispatchLatestTime(String) - Method in class com.splunk.SavedSearchDispatchArgs
Specifies the latest time for this search.
setDispatchLatestTime(Date) - Method in class com.splunk.SavedSearchDispatchArgs
Sets the latest time for this search.
setDispatchLookups(boolean) - Method in class com.splunk.SavedSearch
Sets whether to enable lookups for this search.
setDispatchLookups(boolean) - Method in class com.splunk.SavedSearchDispatchArgs
Indicates whether to enable lookups for this search.
setDispatchMaxCount(int) - Method in class com.splunk.SavedSearch
Sets the maximum number of results before finalizing the search.
setDispatchMaximumCount(int) - Method in class com.splunk.SavedSearchDispatchArgs
Sets the maximum number of results before finalizing the search.
setDispatchMaximumTime(int) - Method in class com.splunk.SavedSearchDispatchArgs
Sets the the maximum amount of time before finalizing the search.
setDispatchMaxTime(int) - Method in class com.splunk.SavedSearch
Sets the maximum time before finalizing the search.
setDispatchNow(String) - Method in class com.splunk.SavedSearchDispatchArgs
Sets a time that dispatches the search as though the specified time were the current time.
setDispatchRealTimeBackfill(boolean) - Method in class com.splunk.SavedSearch
Sets whether to back fill the real-time window for this search.
setDispatchRealTimeBackfill(boolean) - Method in class com.splunk.SavedSearchDispatchArgs
Indicates whether to back fill the real-time window for this search.
setDispatchReduceFrequency(int) - Method in class com.splunk.SavedSearch
Sets how frequently Splunk should run the MapReduce reduce phase on accumulated map values.
setDispatchReduceFrequency(int) - Method in class com.splunk.SavedSearchDispatchArgs
Set the frequency for how often Splunk should run the MapReduce reduce phase on accumulated map values.
setDispatchSpawnProcess(boolean) - Method in class com.splunk.SavedSearch
Sets whether Splunk spawns a new search process when running this saved search.
setDispatchSpawnProcess(boolean) - Method in class com.splunk.SavedSearchDispatchArgs
Indicates whether the search should run in a separate spawned process.
setDispatchTimeFormat(String) - Method in class com.splunk.SavedSearch
Sets the time format used to specify the earliest and latest times for this search.
setDispatchTimeFormat(String) - Method in class com.splunk.SavedSearchDispatchArgs
Sets a time format for Splunk to use to specify the earliest and latest times.
setDispatchTtl(String) - Method in class com.splunk.SavedSearch
Sets the minimum time-to-live in seconds of the search artifacts if no actions are triggered.
setDispatchTtl(String) - Method in class com.splunk.SavedSearchDispatchArgs
Indicates the time to live (TTL) for the artifacts of the scheduled search, if no actions are triggered.
setDisplayView(String) - Method in class com.splunk.SavedSearch
Sets the default view in which to load the results.
setDone(boolean) - Method in class com.splunk.modularinput.Event
Sets a value indicating whether this is the last piece of an event broken across multiple Event objects.
setDropEventsOnQueueFull(int) - Method in class com.splunk.OutputDefault
Sets how long to wait before throwing out all new events until the output queue has space.
setDropEventsOnQueueFull(int) - Method in class com.splunk.OutputGroup
Sets how long to wait before throwing out all new events until the output queue has space.
setEarliestAcceleratedTime(String) - Method in class com.splunk.DataModel
Set the size of the window (from the specified earliest time to now) over which the data model should be accelerated.
setEarliestTime(String) - Method in class com.splunk.JobArgs
Specifies the earliest time in the time range to search.
setEarliestTime(String) - Method in class com.splunk.JobEventsArgs
Specifies the earliest time in the time range to search.
setEarliestTime(String) - Method in class com.splunk.JobExportArgs
Specifies the earliest time in the time range to search.
setEarliestTime(String) - Method in class com.splunk.JobSummaryArgs
Specifies the earliest time in the time range to search.
setEarliestTime(String) - Method in class com.splunk.SavedSearchCollectionArgs
Sets the earliest time for which to display the scheduled times for scheduled searches (not just the next run time).
setEmail(String) - Method in class com.splunk.User
Sets the email address for this user.
setEnableLookups(boolean) - Method in class com.splunk.JobArgs
Indicates whether to enable lookups for this search.
setEnableLookups(boolean) - Method in class com.splunk.JobExportArgs
Indicates whether to enable lookups for this search.
setEnableOnlineBucketRepair(boolean) - Method in class com.splunk.Index
Sets whether asynchronous "online fsck" bucket repair is enabled.
setEnableSplunkWebSSL(boolean) - Method in class com.splunk.Settings
Sets whether Splunk Web uses HTTP or HTTPS.
setEndPoint(String) - Method in class com.splunk.DeploymentServerClass
Sets a URL template string that specifies the endpoint from which content can be downloaded by a deployment client.
setError() - Method in class com.splunk.modularinput.EventWriter
Declares that this EventWriter had an IOException.
setExecutionMode(JobArgs.ExecutionMode) - Method in class com.splunk.JobArgs
Sets the type of search to run ("blocking", "oneshot", or "normal").
setFieldList(String[]) - Method in class com.splunk.JobEventsArgs
Sets a list of fields to return for the event set.
setFieldList(String[]) - Method in class com.splunk.JobResultsArgs
Sets a list of fields to return for the event set.
setFieldList(String[]) - Method in class com.splunk.JobResultsPreviewArgs
Sets a list of fields to return for the event set.
setFieldList(String[]) - Method in class com.splunk.JobSummaryArgs
Sets a list of fields to return for the event set.
setFields(String[]) - Method in class com.splunk.WindowsWmiInput
Sets the properties (fields) that you want to gather from the given class.
setFields(String) - Method in class com.splunk.WindowsWmiInput
Sets a property (field) that you want to gather from the given class.
setFilterType(String) - Method in class com.splunk.DeploymentServerClass
Sets the order to apply filters: "whitelist" applies the whitelist filters first, followed by blacklist filters. "blacklist" applies the blacklist filters first, followed by whitelist filters.
setFollowTail(boolean) - Method in class com.splunk.MonitorInput
Sets whether files that are seen for the first time will be read from the end.
setForceBundleReplication(boolean) - Method in class com.splunk.JobArgs
Specifies whether this search should cause (and wait depending on the value of setSynchronizeBundleReplication) bundle synchronization with all search peers.
setForceBundleReplication(boolean) - Method in class com.splunk.JobExportArgs
Specifies whether this search should cause (and wait depending on the value of setSynchronizeBundleReplication) bundle synchronization with all search peers.
setForceDispatch(boolean) - Method in class com.splunk.SavedSearchDispatchArgs
Indicates whether to start a new search, even if another instance of this search is already running.
setFrozenTimePeriodInSecs(int) - Method in class com.splunk.Index
Sets the maximum age for a bucket, after which the data in this index rolls to frozen.
setHeartbeatFrequency(int) - Method in class com.splunk.OutputDefault
Sets the frequency between heartbeat packets that are sent to the receiving server.
setHeartbeatFrequency(int) - Method in class com.splunk.OutputGroup
Sets the frequency between heartbeat packets that are sent to the receiving server.
setHistogram(boolean) - Method in class com.splunk.JobSummaryArgs
Indicates whether to add histogram data to the summary output.
setHive(String) - Method in class com.splunk.WindowsRegistryInput
Sets the registry hive under which to monitor for changes.
setHost(String) - Method in class com.splunk.modularinput.Event
Sets a host specifying the name of the network host on which this event was produced.
setHost(String) - Method in class com.splunk.MonitorInput
Sets the value to populate in the host field for events from this monitor input.
setHost(String) - Method in class com.splunk.ScriptInput
Sets the value for the host field for events from this scripted input.
setHost(String) - Method in class com.splunk.ServiceArgs
 
setHost(String) - Method in class com.splunk.Settings
Sets the default host name to use for data inputs that do not override this setting.
setHost(String) - Method in class com.splunk.TcpInput
Sets the host from which the indexer gets data.
setHost(String) - Method in class com.splunk.TcpSplunkInput
Sets the host from which the indexer gets data.
setHost(String) - Method in class com.splunk.UdpInput
Sets the host from which the indexer gets data.
setHostRegex(String) - Method in class com.splunk.MonitorInput
Set the regular expression for a file path to determine the host.
setHosts(String) - Method in class com.splunk.WindowsEventLogInput
Sets a list of secondary hosts to be used for monitoring.
setHostSegment(String) - Method in class com.splunk.MonitorInput
Sets the specified slash-separate segment of the file path as the host field value.
setHttpPort(int) - Method in class com.splunk.Settings
Sets the Splunk Web listening port.
setHTTPSHandler(URLStreamHandler) - Method in class com.splunk.ServiceArgs
 
setId(String) - Method in class com.splunk.JobArgs
Sets a search ID (SID).
setIgnoreOlderThan(String) - Method in class com.splunk.MonitorInput
Sets a time value that defines a rolling time window for monitoring files.
setImportedRoles(String[]) - Method in class com.splunk.Role
Sets a list of roles to import attributes from, such as capabilities and allowed indexes to search.
setImportedRoles(String) - Method in class com.splunk.Role
Sets a role to import attributes from, such as capabilities and allowed indexes to search.
setIndex(String) - Method in class com.splunk.modularinput.Event
Sets an index field specifying which index Splunk should write this event to.
setIndex(String) - Method in class com.splunk.MonitorInput
Sets the index where events from this monitor input are stored.
setIndex(String) - Method in class com.splunk.ScriptInput
Sets the index in which to store events from this scripted input.
setIndex(String) - Method in class com.splunk.TcpInput
Sets the index in which to store all generated events.
setIndex(String) - Method in class com.splunk.UdpInput
Sets the index in which to store all generated events.
setIndex(String) - Method in class com.splunk.WindowsActiveDirectoryInput
Sets the index in which to store all generated events.
setIndex(String) - Method in class com.splunk.WindowsEventLogInput
Sets the index in which to store all generated events.
setIndex(String) - Method in class com.splunk.WindowsPerfmonInput
Sets the index in which to store all generated events.
setIndex(String) - Method in class com.splunk.WindowsRegistryInput
Sets the index in which to store all generated events.
setIndex(String) - Method in class com.splunk.WindowsWmiInput
Sets the index in which to store all generated events.
setIndexAndForward(boolean) - Method in class com.splunk.OutputDefault
Sets whether to index all data locally, in addition to forwarding it.
setIndexEarliest(String) - Method in class com.splunk.JobExportArgs
Specifies the earliest time in the time range to search, based on the index time.
setIndexLatest(String) - Method in class com.splunk.JobExportArgs
Specifies the latest time in the time range to search, based on the index time.
setInstances(String[]) - Method in class com.splunk.WindowsPerfmonInput
Sets the counter instances to monitor.
setInstances(String) - Method in class com.splunk.WindowsPerfmonInput
Sets a counter instance to monitor.
setInstances(String[]) - Method in class com.splunk.WindowsWmiInput
Sets the counter instances to monitor.
setInstances(String) - Method in class com.splunk.WindowsWmiInput
Sets a counter instance to monitor.
setInterval(String) - Method in class com.splunk.ScriptInput
Sets an interval or a cron schedule that determines when to run the script.
setInterval(int) - Method in class com.splunk.WindowsPerfmonInput
Sets the frequency to poll the performance counters.
setInterval(int) - Method in class com.splunk.WindowsWmiInput
Sets the frequency at which the WMI providers are queried.
setIsScheduled(boolean) - Method in class com.splunk.SavedSearch
Sets whether this search runs on a schedule.
setIsVisible(boolean) - Method in class com.splunk.SavedSearch
Sets whether this search appears in the visible list of saved searches.
setLabel(String) - Method in class com.splunk.Application
Sets the app's name, which is displayed in Splunk Web.
setLatestTime(String) - Method in class com.splunk.JobArgs
Specifies the latest time in the time range to search.
setLatestTime(String) - Method in class com.splunk.JobEventsArgs
Specifies the latest time in the time range to search.
setLatestTime(String) - Method in class com.splunk.JobExportArgs
Specifies the latest time in the time range to search.
setLatestTime(String) - Method in class com.splunk.JobSummaryArgs
Specifies the latest time in the time range to search.
setLatestTime(String) - Method in class com.splunk.SavedSearchCollectionArgs
Sets the latest time until which to display the scheduled times for scheduled searches (not just the next run time).
setLevel(String) - Method in class com.splunk.Logger
Sets the logging level of this logger.
setLogs(String) - Method in class com.splunk.WindowsEventLogInput
Sets the list of event log names to gather data from.
setLookupHost(String) - Method in class com.splunk.WindowsEventLogInput
Sets the main host from which to monitor log events.
setLookupHost(String) - Method in class com.splunk.WindowsWmiInput
Sets the main server from which to monitor log events.
setMaxBloomBackfillBucketAge(String) - Method in class com.splunk.Index
Sets the time that indicates a bucket age.
setMaxConcurrent(int) - Method in class com.splunk.SavedSearch
Sets the maximum number of concurrent instances of this search the scheduler is allowed to run.
setMaxConcurrentOptimizes(int) - Method in class com.splunk.Index
Sets the number of concurrent optimize processes that can run against a hot bucket for this index.
setMaxDataSize(String) - Method in class com.splunk.Index
Sets the maximum data size before triggering a roll from hot to warm buckets for this index.
setMaxHotBuckets(int) - Method in class com.splunk.Index
Sets the maximum number of hot buckets that can exist per index.
setMaxHotIdleSecs(int) - Method in class com.splunk.Index
Sets the maximum lifetime of a hot bucket for this index.
setMaxHotSpanSecs(int) - Method in class com.splunk.Index
Sets the upper bound of the target maximum timespan of hot and warm buckets for this index.
setMaximumCount(int) - Method in class com.splunk.JobArgs
Sets the number of events that can be accessible in any given status bucket.
setMaximumLines(int) - Method in class com.splunk.JobEventsArgs
Sets the maximum number of lines that any single event's _raw field should contain.
setMaximumLines(int) - Method in class com.splunk.JobExportArgs
Sets the maximum number of lines that any single event's _raw field should contain.
setMaximumTime(int) - Method in class com.splunk.JobArgs
Sets the maximum number of seconds to run this search before finalizing.
setMaximumTime(int) - Method in class com.splunk.JobExportArgs
Sets the number of seconds to run this search before finalizing.
setMaxMemMB(int) - Method in class com.splunk.Index
Sets the amount of memory allocated for buffering a single .tsidx file before flushing to disk.
setMaxMetaEntries(int) - Method in class com.splunk.Index
Sets the maximum number of unique lines in .data files in a bucket, which may help to reduce memory consumption.
setMaxQueueSize(String) - Method in class com.splunk.OutputDefault
Sets the maximum size of the forwarder's output queue.
setMaxQueueSize(String) - Method in class com.splunk.OutputGroup
Sets the maximum size of the forwarder's output queue.
setMaxTimeUnreplicatedNoAcks(int) - Method in class com.splunk.Index
Sets the upper limit for how long an event can sit in a raw slice.
setMaxTimeUnreplicatedWithAcks(int) - Method in class com.splunk.Index
Sets the upper limit for how long an event can sit unacknowledged in a raw slice.
setMaxTotalDataSizeMB(int) - Method in class com.splunk.Index
Sets the maximum size for this index.
setMaxWarmDBCount(int) - Method in class com.splunk.Index
Sets the maximum number of warm buckets.
setMethod(String) - Method in class com.splunk.OutputGroup
Sets the type of output processor.
setMethod(String) - Method in class com.splunk.OutputServer
Sets the type of data distribution method when two or more servers exist in the same forwarder group.
setMethod(String) - Method in class com.splunk.RequestMessage
Sets the message's HTTP method.
setMgmtPort(int) - Method in class com.splunk.Settings
Sets the management port for splunkd.
setMinimumFreeSpace(int) - Method in class com.splunk.Settings
Sets the amount of free disk space that must exist for splunkd to continue operating.
setMinimumFrequency(double) - Method in class com.splunk.JobSummaryArgs
Sets the fraction of results for each key that this key must occur in to be displayed.
setMinRawFileSyncSecs(String) - Method in class com.splunk.Index
Sets the frequency at which Splunkd forces a file system sync while compressing journal slices for this index.
setMonitorSubnodes(boolean) - Method in class com.splunk.WindowsRegistryInput
Sets whether to monitor the subnodes of the given registry hive.
setMonitorSubtree(boolean) - Method in class com.splunk.WindowsActiveDirectoryInput
Sets whether to monitor the subtrees of the given directory tree path.
setName(String) - Method in class com.splunk.modularinput.Argument
Sets the name that Splunk will use to represent this argument.
setName() - Method in class com.splunk.OutputDefault
Sets the name.
setNamespace(String) - Method in class com.splunk.JobArgs
Specifies the application namespace to which to restrict searches.
setNamespace(String) - Method in class com.splunk.JobExportArgs
Specifies the application namespace in which to restrict searches.
setNoAppendingTimeStamp(boolean) - Method in class com.splunk.UdpInput
Sets whether Splunk should prepend a timestamp and host name to incoming events.
setNoPriorityStripping(boolean) - Method in class com.splunk.UdpInput
Sets whether Splunk should strip the priority field from incoming events.
setNow(String) - Method in class com.splunk.JobArgs
Specifies a time string that sets the absolute time used for any relative time specifier in the search.
setNow(String) - Method in class com.splunk.JobExportArgs
Specifies a time string that sets the absolute time used for any relative time specifier in the search.
setObject(String) - Method in class com.splunk.WindowsPerfmonInput
Sets the performance monitor object (for example, "Process", "Server", or "PhysicalDisk").
setOffset(int) - Method in class com.splunk.CollectionArgs
Sets the index of the first entry to return.
setOffset(int) - Method in class com.splunk.JobEventsArgs
Specifies the index of the first result (inclusive) from which to begin returning data.
setOffset(int) - Method in class com.splunk.JobResultsArgs
Specifies the index of the first result (inclusive) from which to begin returning data.
setOffset(int) - Method in class com.splunk.JobResultsPreviewArgs
Specifies the index of the first result (inclusive) from which to begin returning data.
setOutputMode(JobEventsArgs.OutputMode) - Method in class com.splunk.JobEventsArgs
Sets the format of the output.
setOutputMode(JobExportArgs.OutputMode) - Method in class com.splunk.JobExportArgs
Sets the format of the output.
setOutputMode(JobResultsArgs.OutputMode) - Method in class com.splunk.JobResultsArgs
Sets the format of the output.
setOutputMode(JobResultsPreviewArgs.OutputMode) - Method in class com.splunk.JobResultsPreviewArgs
Sets the format of the output.
setOutputTimeFormat(String) - Method in class com.splunk.JobEventsArgs
Sets a UTC time format.
setOutputTimeFormat(String) - Method in class com.splunk.JobExportArgs
Sets a UTC time format.
setOutputTimeFormat(String) - Method in class com.splunk.JobSummaryArgs
Sets a UTC time format.
setOwner(String) - Method in class com.splunk.CollectionArgs
Sets the owner context in which to list the collection.
setOwner(String) - Method in class com.splunk.ServiceArgs
 
setParameters(Collection<Parameter>) - Method in class com.splunk.modularinput.ValidationDefinition
Sets a list of Parameter objects giving the proposed configuration.
setPartialServiceMetaPeriod(int) - Method in class com.splunk.Index
Sets the frequency at which metadata is for partially synced (synced in-place) for this index.
setPassAuth(String) - Method in class com.splunk.ScriptInput
Sets a username to run the script under.
setPassword(String) - Method in class com.splunk.Password
Sets the password for this credential.
setPassword(String) - Method in class com.splunk.ServiceArgs
 
setPassword(String) - Method in class com.splunk.User
Sets this user's password.
setPasswordSymmKey(String) - Method in class com.splunk.Settings
Sets the password string that is prepended to the Splunk symmetric key to generate the final key, which is used to sign all traffic between master/slave licensers.
setPort(int) - Method in class com.splunk.ServiceArgs
 
setPriority(int) - Method in class com.splunk.EventType
Sets the priority of the event type.
setPriority(int) - Method in class com.splunk.Job
Sets this job's priority in the range of 0-10.
setPriority(int) - Method in class com.splunk.OutputSyslog
Sets the syslog priority.
setProc(String) - Method in class com.splunk.WindowsRegistryInput
Sets the regular expression (regex) that is compared to process names when including or excluding events for this Windows Registry input.
setQuarantineFutureSecs(int) - Method in class com.splunk.Index
Sets a quarantine for events that are timestamped in the future to help prevent main hot buckets from being polluted with fringe events.
setQuarantinePastSecs(int) - Method in class com.splunk.Index
Sets a quarantine for events that are timestamped in the past to help prevent main hot buckets from being polluted with fringe events.
setQueue(String) - Method in class com.splunk.TcpInput
Sets how the input processor should deposit the events it reads.
setQueue(String) - Method in class com.splunk.UdpInput
Sets how the input processor should deposit the events it reads.
setQuota(String) - Method in class com.splunk.LicensePool
Sets the byte quota of this license pool.
setRawChunkSizeBytes(int) - Method in class com.splunk.Index
Sets the target uncompressed size of individual raw slices in the rawdata journal for this index.
setRawJsonDescription(String) - Method in class com.splunk.DataModelArgs
 
setRawTcpDoneTimeout(int) - Method in class com.splunk.TcpInput
Sets the timeout value for adding a Done key.
setRealName(String) - Method in class com.splunk.User
Sets this user's real name.
setRealtimeBlocking(boolean) - Method in class com.splunk.JobArgs
Indicates whether the indexer blocks if the queue for this search is full.
setRealtimeBlocking(boolean) - Method in class com.splunk.JobExportArgs
Indicates whether the indexer blocks if the queue for this search is full.
setRealtimeIndexFilter(boolean) - Method in class com.splunk.JobArgs
Indicates whether the indexer pre-filters events.
setRealtimeIndexFilter(boolean) - Method in class com.splunk.JobExportArgs
Indicates whether the indexer pre-filters events.
setRealtimeMaximumBlockSeconds(int) - Method in class com.splunk.JobArgs
Sets the number of seconds indicating the maximum time to block.
setRealtimeMaximumBlockSeconds(int) - Method in class com.splunk.JobExportArgs
Sets the number of seconds indicating the maximum time to block.
setRealtimeQueueSize(int) - Method in class com.splunk.JobArgs
Sets the number indicating the queue size (in events) that the indexer should use for this search.
setRealtimeQueueSize(int) - Method in class com.splunk.JobExportArgs
Sets the number indicating the queue size (in events) that the indexer should use for this search.
setRealtimeSchedule(boolean) - Method in class com.splunk.SavedSearch
Sets how the scheduler computes the next time a scheduled search is run.
setRealTimeSearchJobsQuota(int) - Method in class com.splunk.Role
Sets the maximum number of concurrent real-time search jobs a user with this role is allowed to run.
setReceiveTimeout(int) - Method in class com.splunk.DistributedConfiguration
Sets the time-out period for reading and receiving data from a search peer.
setRecursive(boolean) - Method in class com.splunk.MonitorInput
Sets whether to monitor sub-directories within this monitor input.
setReduceFrequency(int) - Method in class com.splunk.JobArgs
Sets the time to wait between running the MapReduce phase on accumulated map values.
setReduceFrequency(int) - Method in class com.splunk.JobExportArgs
Sets the time to wait between running the MapReduce phase on accumulated map values.
setReloadMacros(boolean) - Method in class com.splunk.JobArgs
Indicates whether to reload macro definitions from the macros.conf configuration file.
setReloadMacros(boolean) - Method in class com.splunk.JobExportArgs
Indicates whether to reload macro definitions from the macros.conf configuration file.
setRemotePassword(String) - Method in class com.splunk.DistributedPeer
Sets the remote password.
setRemoteServerList(String[]) - Method in class com.splunk.JobArgs
Sets a list of (possibly wildcarded) servers from which to pull raw events.
setRemoteServerList(String[]) - Method in class com.splunk.JobExportArgs
Sets a list of (possibly wildcarded) servers from which to pull raw events.
setRemoteUsername(String) - Method in class com.splunk.DistributedPeer
Sets the remote username.
setRemoveTimedOutServers(boolean) - Method in class com.splunk.DistributedConfiguration
Sets whether to remove a server connection that cannot be made within the time-out period specified by connectionTimeout, sendTimeout, or receiveTimeout.
setRenameSource(String) - Method in class com.splunk.MonitorInput
Sets the name to populate in the source field for events from this monitor input.
setRenameSource(String) - Method in class com.splunk.ScriptInput
Sets the source name for events from this scripted input.
setRepositoryLocation(String) - Method in class com.splunk.DeploymentServerClass
Sets the location on the deployment server to store the content that is to be deployed for this server class.
setRequestUiDispatchApp(String) - Method in class com.splunk.SavedSearch
Sets the app in which Splunk Web dispatches this search.
setRequestUiDispatchView(String) - Method in class com.splunk.SavedSearch
Sets the view in which Splunk Web displays this search.
setRequiredFieldList(String[]) - Method in class com.splunk.JobArgs
Sets one or more required fields to the search.
setRequiredFieldList(String[]) - Method in class com.splunk.JobExportArgs
Sets one or more required fields to the search.
setRequiredOnCreate(boolean) - Method in class com.splunk.modularinput.Argument
Sets whether a value for this argument must be specified when creating a modular input of this kind.
setRequiredOnEdit(boolean) - Method in class com.splunk.modularinput.Argument
Sets whether a value for this argument must be specified when editing an existing modular input of this kind.
setRestartBackgroundJobs(boolean) - Method in class com.splunk.User
Sets whether to restart background search jobs when Splunk restarts.
setRestartOnSearchpeerAdd(boolean) - Method in class com.splunk.SavedSearch
Deprecated. Use SavedSearch.setRestartOnSearchPeerAdd(boolean) instead.
setRestartOnSearchPeerAdd(boolean) - Method in class com.splunk.SavedSearch
Sets whether a real-time search managed by the scheduler is restarted when a search peer becomes available for this saved search.
setRoles(String[]) - Method in class com.splunk.User
Sets the roles for this user.
setRoles(String) - Method in class com.splunk.User
Sets this user's role.
setRotatePeriodInSecs(int) - Method in class com.splunk.Index
Sets the frequency to check for the need to create a new hot bucket and the need to roll or freeze any warm or cold buckets for this index.
setRunOnStartup(boolean) - Method in class com.splunk.SavedSearch
Sets whether this search is run when Splunk starts.
setScheme(String) - Method in class com.splunk.ServiceArgs
 
setSearch(String) - Method in class com.splunk.CollectionArgs
Sets a search query to filter the response.
setSearch(String) - Method in class com.splunk.EventType
Sets the search string.
setSearch(String) - Method in class com.splunk.JobEventsArgs
Sets the post-processing search to apply to results.
setSearch(String) - Method in class com.splunk.JobResultsArgs
Sets the post-processing search to apply to results.
setSearch(String) - Method in class com.splunk.JobResultsPreviewArgs
Sets the post-processing search to apply to results.
setSearch(String) - Method in class com.splunk.JobSummaryArgs
Sets a search query to filter the response.
setSearch(String) - Method in class com.splunk.SavedSearch
Sets the search query for this saved search.
setSearchDiskQuota(int) - Method in class com.splunk.Role
Sets the maximum disk space that can be used for search jobs by a user with this role.
setSearchFilter(String) - Method in class com.splunk.Role
Sets a search string that restricts the scope of searches run by this role.
setSearchIndexesAllowed(String[]) - Method in class com.splunk.Role
Sets the indexes that a user with this role has permissions to search.
setSearchIndexesAllowed(String) - Method in class com.splunk.Role
Sets the index that a user with this role has permissions to search.
setSearchIndexesDefault(String[]) - Method in class com.splunk.Role
Sets the indexes to search by default when no index is specified for a user with this role.
setSearchIndexesDefault(String) - Method in class com.splunk.Role
Sets the index to search by default when no index is specified for a user with this role.
setSearchJobsQuota(int) - Method in class com.splunk.Role
Sets the maximum number of concurrent searches a user with this role is allowed to run.
setSearchListener(String) - Method in class com.splunk.JobArgs
Sets a string that registers a search state listener with the search.
setSearchListener(String) - Method in class com.splunk.JobExportArgs
Sets a string that registers a search state listener with the search.
setSearchMode(JobArgs.SearchMode) - Method in class com.splunk.JobArgs
Sets the search mode ("normal" or "realtime").
setSearchMode(JobExportArgs.SearchMode) - Method in class com.splunk.JobExportArgs
Sets the search mode ("normal" or "realtime").
setSearchTimeWindow(int) - Method in class com.splunk.Role
Sets the maximum time span of a search that is allowed for users in this role.
setSegmentation(String) - Method in class com.splunk.JobEventsArgs
Sets the type of segmentation to perform on the data, including an option to perform k/v segmentation.
setSegmentation(String) - Method in class com.splunk.JobExportArgs
Sets the type of segmentation to perform on the data, including an option to perform k/v segmentation.
setSendCookedData(boolean) - Method in class com.splunk.OutputDefault
Sets whether to forward cooked data.
setSendCookedData(boolean) - Method in class com.splunk.OutputGroup
Sets whether to forward cooked data.
setSendTimeout(int) - Method in class com.splunk.DistributedConfiguration
Sets the time-out period for writing and sending data to a search peer.
setServer(String) - Method in class com.splunk.OutputSyslog
Sets the host:port where the syslog data is sent.
setServerHost(String) - Method in class com.splunk.modularinput.InputDefinition
Sets the name of the server on which this modular input is being run.
setServerName(String) - Method in class com.splunk.Settings
Sets the name that is used to identify this Splunk instance for features such as distributed search.
setServers(String) - Method in class com.splunk.DistributedConfiguration
Sets the initial peer server list.
setServers(String) - Method in class com.splunk.OutputGroup
Sets the list of servers included in this group.
setServers(String) - Method in class com.splunk.WindowsWmiInput
Sets secondary servers that you want to gather data from.
setServerUri(String) - Method in class com.splunk.modularinput.InputDefinition
Sets the URI to reach the server on which this modular input is being run.
setServiceMetaPeriod(int) - Method in class com.splunk.Index
Sets the frequency at which metadata is synced to disk for this index.
setSessionKey(String) - Method in class com.splunk.modularinput.InputDefinition
Sets a session key that can be used to access splunkd's REST API.
setSessionTimeout(String) - Method in class com.splunk.Settings
Sets the session timeout.
setShareBundles(boolean) - Method in class com.splunk.DistributedConfiguration
Sets whether this server uses bundle replication to share search-time configuration with search peers.
setSharing(String) - Method in class com.splunk.CollectionArgs
Sets the sharing context in which to list the collection.
setSlaves(String) - Method in class com.splunk.LicensePool
Sets the list of slaves that are members of this license pool.
setSlaves(String[]) - Method in class com.splunk.LicensePool
Sets the list of slaves that are members of this license pool.
setSortDirection(CollectionArgs.SortDirection) - Method in class com.splunk.CollectionArgs
Sets the direction to sort entries.
setSortKey(String) - Method in class com.splunk.CollectionArgs
Sets the field to use for sorting.
setSortMode(CollectionArgs.SortMode) - Method in class com.splunk.CollectionArgs
Sets the mode to use for sorting.
setSource(String) - Method in class com.splunk.modularinput.Event
Sets the file, service, or other producer that this Event comes from.
setSource(String) - Method in class com.splunk.ScriptInput
Sets the initial value for the source key for events from this input.
setSource(String) - Method in class com.splunk.TcpInput
Sets the initial value for the source key for events from this input.
setSource(String) - Method in class com.splunk.UdpInput
Sets the initial value for the source key for events from this input.
setSourceType(String) - Method in class com.splunk.modularinput.Event
Sets a classification of this event.
setSourcetype(String) - Method in class com.splunk.MonitorInput
Sets the source type to populate in the sourcetype field for events from this monitor input.
setSourcetype(String) - Method in class com.splunk.ScriptInput
Sets the source type for events from this scripted input.
setSourceType(String) - Method in class com.splunk.TcpInput
Sets the source type for events from this raw TCP input.
setSourceType(String) - Method in class com.splunk.UdpInput
Sets the source type for events from this input.
setSpawnProcess(boolean) - Method in class com.splunk.JobArgs
Indicates whether the search should run in a separate spawned process.
setSplunkDBPath(String) - Method in class com.splunk.Settings
Sets the fully-qualified local path to the default index.
setSSL(boolean) - Method in class com.splunk.TcpInput
Sets whether to use secure socket layer (SSL).
setSSL(boolean) - Method in class com.splunk.TcpSplunkInput
Sets whether to use secure socket layer (SSL).
setSslAltNameToCheck(String) - Method in class com.splunk.OutputServer
Sets the alternate name to match in the remote server's SSL certificate.
setSslCertPath(String) - Method in class com.splunk.OutputServer
Sets the path to the client certificate.
setSslCipher(String) - Method in class com.splunk.OutputServer
Sets the SSL cipher in the form: ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM
setSslCommonNameToCheck(String) - Method in class com.splunk.OutputServer
Sets the name against which to check the common name of the server's certificate.
setSslPassword(String) - Method in class com.splunk.OutputServer
Sets the password associated with the PEM file store.
setSslRootCAPath(String) - Method in class com.splunk.OutputServer
Sets the path to the root certificate authority file.
setSslSecurityProtocol(SSLSecurityProtocol) - Static method in class com.splunk.HttpService
Sets the SSL security protocol of this service.
setSSLSecurityProtocol(SSLSecurityProtocol) - Method in class com.splunk.ServiceArgs
 
setSSLSocketFactory(SSLSocketFactory) - Static method in class com.splunk.HttpService
 
setSslVerifyServerCert(boolean) - Method in class com.splunk.OutputServer
Sets whether the server being connected to is authenticated.
setStanza(String) - Method in class com.splunk.modularinput.Event
Sets the name of the input this event should be sent to.
setStartingNode(String) - Method in class com.splunk.WindowsActiveDirectoryInput
Sets the starting Active Directory directory to start monitoring.
setStartWebServer(boolean) - Method in class com.splunk.Settings
Sets whether to start Splunk Web.
setStatusBuckets(int) - Method in class com.splunk.JobArgs
Sets the maximum number of status buckets to generate.
setStatusTimeout(int) - Method in class com.splunk.DistributedConfiguration
Sets the time-out period for connecting to a search peer for getting its basic information.
setStreamingMode(Scheme.StreamingMode) - Method in class com.splunk.modularinput.Scheme
Specifies whether this modular input kind will send events to Splunk as XML (the default and preferred value) or plain text.
setSummarize(boolean) - Method in class com.splunk.IndexCollectionArgs
Sets whether to omits certain index details to provide a faster response.
setSynchronizeBundleReplication(boolean) - Method in class com.splunk.JobArgs
Indicates whether this search should wait for bundle replication to complete.
setSynchronizeBundleReplication(boolean) - Method in class com.splunk.JobExportArgs
Indicates whether this search should wait for bundle replication to complete.
setSyncMeta(boolean) - Method in class com.splunk.Index
Sets whether the sync operation is called before the file descriptor is closed on metadata updates.
setTargetDc(String) - Method in class com.splunk.WindowsActiveDirectoryInput
Sets the fully-qualified domain name of a valid, network-accessible domain controller.
setTargetUri(String) - Method in class com.splunk.DeploymentClient
Sets the deployment server's target URI for this deployment client.
setThrottleCheckPeriod(int) - Method in class com.splunk.Index
Sets the frequency at which Splunk checks for an index throttling condition.
setTime(Date) - Method in class com.splunk.modularinput.Event
Sets a java.util.Date object giving the timestamp that should be sent with this event.
setTimeBeforeClose(int) - Method in class com.splunk.MonitorInput
Sets the time period for keeping a file open.
setTimeFormat(String) - Method in class com.splunk.JobArgs
Sets the format for converting a formatted time string from {start,end}_time into UTC seconds.
setTimeFormat(String) - Method in class com.splunk.JobEventsArgs
Specifies an expression to convert a formatted time string from {start,end}_time into UTC seconds.
setTimeFormat(String) - Method in class com.splunk.JobExportArgs
Sets the format for converting a formatted time string from {start,end}_time into UTC seconds.
setTimeFormat(String) - Method in class com.splunk.JobSummaryArgs
Specifies an expression to convert a formatted time string from {start,end}_time into UTC seconds.
setTimeout(int) - Method in class com.splunk.JobArgs
Sets the number of seconds to keep this search after processing has stopped.
setTimeout(int) - Method in class com.splunk.JobExportArgs
Sets the number of seconds to keep this search after processing has stopped.
setTimestampFormat(String) - Method in class com.splunk.OutputSyslog
Sets the timestamp format that precedes each event that is sent.
Settings - Class in com.splunk
The Settings class represents configuration information for an instance of Splunk.
setTitle(String) - Method in class com.splunk.modularinput.Scheme
Sets the title of this modular input kind.
setToken(String) - Method in class com.splunk.Service
Provides a session token for use by this Service instance.
setToken(String) - Method in class com.splunk.ServiceArgs
 
setTopCount(int) - Method in class com.splunk.JobSummaryArgs
Sets for each key how many of the most frequent items to return.
setTriggerActions(boolean) - Method in class com.splunk.SavedSearchDispatchArgs
Indicates whether to trigger alert actions.
setTruncationMode(JobEventsArgs.TruncationMode) - Method in class com.splunk.JobEventsArgs
Specifies how to truncate lines to achieve the value in JobEventsArgs.setMaximumLines(int).
setTruncationMode(JobExportArgs.TruncationMode) - Method in class com.splunk.JobExportArgs
Specifies how to truncate lines to achieve the value in JobExportArgs.setMaximumLines(int).
setTrustedIP(String) - Method in class com.splunk.Settings
Sets the IP address of the authenticating proxy.
setType(String) - Method in class com.splunk.OutputSyslog
Sets the protocol to use to send syslog data.
setType(String[]) - Method in class com.splunk.WindowsRegistryInput
Sets the regular expressions (regexes) that are compared to registry event types for this Windows Registry input.
setTz(String) - Method in class com.splunk.User
Sets this user's time zone, which is used for display purposes.
setUnbroken(boolean) - Method in class com.splunk.modularinput.Event
Sets a value indicating whether this event is completely encapsulated in this Event object.
setup() - Method in class com.splunk.Application
Returns the app's setup information.
setUseExternalValidation(boolean) - Method in class com.splunk.modularinput.Scheme
Specifies whether Splunk should use the modular input kind script to validate the arguments of a particular modular input (true) or use the validation predicates specified by the arguments (false).
setUsername(String) - Method in class com.splunk.ServiceArgs
 
setUseSingleInstance(boolean) - Method in class com.splunk.modularinput.Scheme
Specifies whether Splunk should run all modular inputs of this kind via one instance of the script or start an instance for each modular input.
setValidation(String) - Method in class com.splunk.modularinput.Argument
Sets the validation string that internal validation should use on this argument.
setVersion(String) - Method in class com.splunk.Application
Sets the version of the app.
setVisible(boolean) - Method in class com.splunk.Application
Sets whether the app is visible and navigable from Splunk Web.
setVsid(String) - Method in class com.splunk.SavedSearch
Sets the view state ID that is associated with the view specified in the DisplayView attribute.
setWhitelist(String) - Method in class com.splunk.MonitorInput
Sets a regular expression for a file path that, when matched, is indexed.
setWhitelistByIndex(int, String) - Method in class com.splunk.DeploymentServerClass
Sets a specific whitelist entry.
simpleReceiverEndPoint - Variable in class com.splunk.Service
The default simple receiver endpoint.
SingleValueParameter - Class in com.splunk.modularinput
The SingleValueParameter class represents a parameter as part of a modular input instance that contains only a single value.
size() - Method in class com.splunk.Entity
size() - Method in class com.splunk.ResourceCollection
SortDirection - Enum in com.splunk
 
source - Variable in class com.splunk.modularinput.Event
 
sourceType - Variable in class com.splunk.modularinput.Event
 
SplunkException - Exception in com.splunk
Thrown for Splunk responses that return an error status code.
sslSecurityProtocol - Static variable in class com.splunk.HttpService
 
SSLSecurityProtocol - Enum in com.splunk
 
stackTraceToLogEntry(Exception) - Method in class com.splunk.modularinput.Script
 
stanza - Variable in class com.splunk.modularinput.Event
 
startIndex - Variable in class com.splunk.AtomFeed
The value of the Atom feed's <startIndex> element.
stateChangeRequiresRestart() - Method in class com.splunk.Application
Indicates whether a state change requires the app to be restarted.
StatsFunction - Enum in com.splunk
 
streamEvents(InputDefinition, EventWriter) - Method in class com.splunk.modularinput.Script
Streams events into Splunk.
streamingMode - Variable in class com.splunk.modularinput.Scheme
 
StringComparison - Enum in com.splunk
Comparison operators for string valued fields.
StringPivotColumnSplit - Class in com.splunk
Represents a column split on a string valued field.
StringPivotFilter - Class in com.splunk
Represents a filter on a string valued field.
StringPivotRowSplit - Class in com.splunk
Represents a row split on a string valued field.
submit(String) - Method in class com.splunk.Index
Submits an event to this index through an HTTP POST request.
submit(Args, String) - Method in class com.splunk.Index
Submits an event to this index through an HTTP POST request.
submit(String) - Method in class com.splunk.Receiver
Submits an event to this index through HTTP POST.
submit(String, String) - Method in class com.splunk.Receiver
Submits an event to this index through HTTP POST.
submit(Args, String) - Method in class com.splunk.Receiver
Submits an event to this index through HTTP POST.
submit(String, Args, String) - Method in class com.splunk.Receiver
Logs an event to this index through HTTP POST.
submit(String) - Method in class com.splunk.TcpInput
Submit a single event to this raw TCP input by opening the connection, submitting the event, and closing the connection.
submit(String) - Method in class com.splunk.UdpInput
Send a string to this UDP input.
synchronizedLog(String, String) - Method in class com.splunk.modularinput.EventWriter
Thread safe version of log.
synchronizedWriteEvent(Event) - Method in class com.splunk.modularinput.EventWriter
Thread safe version of writeEvent.
syntaxError(XMLStreamReader) - Static method in class com.splunk.AtomObject
 

T

Tcp - Static variable in class com.splunk.InputKind
Raw TCP input.
TcpConnections - Class in com.splunk
The TcpConnections class represents a raw or cooked TCP connection.
TcpInput - Class in com.splunk
The TcpInput class represents a raw TCP data input.
TcpSplunk - Static variable in class com.splunk.InputKind
Cooked TCP input.
TcpSplunkInput - Class in com.splunk
The TcpSplunkInput class represents a Splunk-processed "cooked" TCP data input.
time - Variable in class com.splunk.modularinput.Event
 
TIMEOUT - Static variable in exception com.splunk.SplunkException
 
TimestampBinning - Enum in com.splunk
Possible bin sizes for timestamp valued fields in pivots.
TimestampPivotColumnSplit - Class in com.splunk
Represents a column split on a timestamp valued field in a pivot.
TimestampPivotRowSplit - Class in com.splunk
Represents a row split on a timestamp valued field in a pivot.
title - Variable in class com.splunk.AtomObject
The value of the Atom <title> element.
title - Variable in class com.splunk.modularinput.Scheme
 
title - Variable in class com.splunk.Resource
 
token - Variable in class com.splunk.Service
The current session token.
token - Variable in class com.splunk.ServiceArgs
Deprecated. Use ServiceArgs.setToken(String) instead.
toString() - Method in enum com.splunk.CollectionArgs.SortDirection
 
toString() - Method in enum com.splunk.CollectionArgs.SortMode
 
toString() - Method in class com.splunk.InputKind
 
toString() - Method in enum com.splunk.JobArgs.ExecutionMode
 
toString() - Method in enum com.splunk.JobArgs.SearchMode
 
toString() - Method in enum com.splunk.JobEventsArgs.OutputMode
 
toString() - Method in enum com.splunk.JobEventsArgs.TruncationMode
 
toString() - Method in enum com.splunk.JobExportArgs.OutputMode
 
toString() - Method in enum com.splunk.JobExportArgs.SearchMode
 
toString() - Method in enum com.splunk.JobExportArgs.TruncationMode
 
toString() - Method in enum com.splunk.JobResultsArgs.OutputMode
 
toString() - Method in enum com.splunk.JobResultsPreviewArgs.OutputMode
 
totalResults - Variable in class com.splunk.AtomFeed
The value of the Atom feed's <totalResults> element.
toUpdate - Variable in class com.splunk.Entity
 

U

Udp - Static variable in class com.splunk.InputKind
UDP input.
UdpConnections - Class in com.splunk
The UdpConnections class represents a UDP connection.
UdpInput - Class in com.splunk
The UdpInput class represents a UDP data input.
unbroken - Variable in class com.splunk.modularinput.Event
 
Unknown - Static variable in class com.splunk.InputKind
Unknown type of input.
update() - Method in class com.splunk.DataModel
 
update(Map<String, Object>) - Method in class com.splunk.Entity
Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
update() - Method in class com.splunk.Entity
Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
update(Map<String, Object>) - Method in class com.splunk.EventType
Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
update() - Method in class com.splunk.EventType
Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
update(Map<String, Object>) - Method in class com.splunk.OutputDefault
Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
update() - Method in class com.splunk.OutputDefault
Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
update(Map<String, Object>) - Method in class com.splunk.OutputGroup
Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
update() - Method in class com.splunk.OutputGroup
Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
update(Map<String, Object>) - Method in class com.splunk.SavedSearch
Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
update() - Method in class com.splunk.SavedSearch
Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
update(Map<String, Object>) - Method in class com.splunk.Settings
Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
update() - Method in class com.splunk.Settings
Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
update(Map<String, Object>) - Method in class com.splunk.WindowsActiveDirectoryInput
Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
update() - Method in class com.splunk.WindowsActiveDirectoryInput
Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
update(Map<String, Object>) - Method in class com.splunk.WindowsEventLogInput
Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
update() - Method in class com.splunk.WindowsEventLogInput
Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
update(Map<String, Object>) - Method in class com.splunk.WindowsRegistryInput
Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
update() - Method in class com.splunk.WindowsRegistryInput
Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
update(Map<String, Object>) - Method in class com.splunk.WindowsWmiInput
Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.
update() - Method in class com.splunk.WindowsWmiInput
Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
updated - Variable in class com.splunk.AtomObject
The value of the Atom <updated> element.
upload(String) - Method in class com.splunk.Index
Uploads a file to this index as an event stream.
upload(String, Args) - Method in class com.splunk.Index
Uploads a file to this index as an event stream.
Upload - Class in com.splunk
The Upload class represents an in-progress oneshot upload.
useExternalValidation - Variable in class com.splunk.modularinput.Scheme
 
User - Class in com.splunk
The User class represents a Splunk user who is registered on the current Splunk server.
UserCollection - Class in com.splunk
The UserCollection class represents a collection of Splunk users who are registered on the current Splunk server.
username - Variable in class com.splunk.Service
The Splunk account username, which is used to authenticate the Splunk instance.
useSingleInstance - Variable in class com.splunk.modularinput.Scheme
 

V

validate() - Method in class com.splunk.Entity
Ensures that the local state of the resource is current, calling refresh if necessary.
validate() - Method in class com.splunk.Resource
Ensures that the local state of the resource is current, calling refresh if necessary.
validate() - Method in class com.splunk.ResourceCollection
Ensures that the local state of the resource is current, calling refresh if necessary.
validateInput(ValidationDefinition) - Method in class com.splunk.modularinput.Script
Handles external validation for modular input kinds.
validation - Variable in class com.splunk.modularinput.Argument
 
ValidationDefinition - Class in com.splunk.modularinput
The ValidationDefinition class represents the XML sent by Splunk for external validation of a new modular input.
valueOf(String) - Static method in enum com.splunk.BooleanComparison
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.CollectionArgs.SortDirection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.CollectionArgs.SortMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.FieldType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.IPv4Comparison
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.JobArgs.ExecutionMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.JobArgs.SearchMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.JobEventsArgs.OutputMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.JobEventsArgs.TruncationMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.JobExportArgs.OutputMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.JobExportArgs.SearchMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.JobExportArgs.TruncationMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.JobResultsArgs.OutputMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.JobResultsPreviewArgs.OutputMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.modularinput.Argument.DataType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.modularinput.Scheme.StreamingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.ModularInputKindArgument.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.NumberComparison
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.SortDirection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.SSLSecurityProtocol
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.StatsFunction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.StringComparison
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.splunk.TimestampBinning
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.splunk.BooleanComparison
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.CollectionArgs.SortDirection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.CollectionArgs.SortMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class com.splunk.Entity
values() - Static method in enum com.splunk.FieldType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.IPv4Comparison
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.JobArgs.ExecutionMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.JobArgs.SearchMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.JobEventsArgs.OutputMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.JobEventsArgs.TruncationMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.JobExportArgs.OutputMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.JobExportArgs.SearchMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.JobExportArgs.TruncationMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.JobResultsArgs.OutputMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.JobResultsPreviewArgs.OutputMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.modularinput.Argument.DataType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.modularinput.Scheme.StreamingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.ModularInputKindArgument.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.NumberComparison
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class com.splunk.ResourceCollection
values() - Static method in enum com.splunk.SortDirection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.SSLSecurityProtocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.StatsFunction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.StringComparison
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.splunk.TimestampBinning
Returns an array containing the constants of this enum type, in the order they are declared.
valueSize(Object) - Method in class com.splunk.ResourceCollection
Returns the number of values that a specific key represents.
version - Variable in class com.splunk.Service
The version of this Splunk instance, once logged in.
versionCompare(String) - Method in class com.splunk.Service
Returns a value indicating how the version of this Splunk instance compares to a given version: -1 if this version < the given version 0 if this version = the given version 1 if this version > the given version

W

WARN - Static variable in class com.splunk.modularinput.EventWriter
 
WindowsActiveDirectory - Static variable in class com.splunk.InputKind
Windows Active Directory input.
WindowsActiveDirectoryInput - Class in com.splunk
The WindowsActiveDirectoryInput class represents a Windows Active Directory data input.
WindowsEventLog - Static variable in class com.splunk.InputKind
Windows event log input.
WindowsEventLogInput - Class in com.splunk
The WindowsEventLogInput class represents a Windows Event Log data input.
WindowsPerfmon - Static variable in class com.splunk.InputKind
Windows performance monitor input.
WindowsPerfmonInput - Class in com.splunk
The WindowsPerfmonInput class represents a Windows Performance Monitor (Perfmon) data input.
WindowsRegistry - Static variable in class com.splunk.InputKind
Windows Registry input.
WindowsRegistryInput - Class in com.splunk
The WindowsRegistryInput class represents a Windows Registry data input.
WindowsWmi - Static variable in class com.splunk.InputKind
Windows Management Instrumentation (WMI) input.
WindowsWmiInput - Class in com.splunk
The WindowsWmiInput class represents a Windows Management Instrumentation (WMI) data input.
WinEventLog - Static variable in class com.splunk.InputKind
 
WinRegMon - Static variable in class com.splunk.InputKind
 
writeEvent(Event) - Method in class com.splunk.modularinput.EventWriter
Writes an Event object to Splunk.
writeFieldTo(XMLStreamWriter, String, String) - Method in class com.splunk.modularinput.Event
 
writeTo(XMLStreamWriter) - Method in class com.splunk.modularinput.Event
Writes this event to the given XMLStreamWriter.

X

Xml - Class in com.splunk
The Xml class represents a collection of XML utilities.
Xml() - Constructor for class com.splunk.Xml
 

A B C D E F G H I J K L M N O P R S T U V W X