An index contains events that have been logged to Splunk.
| package | Splunk |
|---|
attach(array $args) : resource
It is highly recommended to specify a sourcetype explicitly.
It is slightly faster to use Splunk_Receiver::attach() to accomplish the same task. One fewer network request is needed.
The returned stream should eventually be closed via fclose().
| link | http://docs.splunk.com/Documentation/Splunk/latest/RESTAPI/RESTinput#receivers.2Fstream |
|---|
array(optional) {
host: (optional) The value to populate in the host field
for events from this data input.
host_regex: (optional) A regular expression used to
extract the host value from each event.
source: (optional) The source value to fill in the
metadata for this input's events.
sourcetype: (optional) The sourcetype to apply to
events from this input.
}
\Splunk_IOException |
|---|
resourceA stream that you can write event text to.delete()
getContent() : array
| inherited_from | \Splunk_Entity::getContent() |
|---|
arrayThe properties of this entity.getName() : string
| inherited_from | \Splunk_Entity::getName() |
|---|
stringThe name of this entity.
This name can be used to lookup this entity
from its collection.getNamespace() : \Splunk_Namespace
| inherited_from | \Splunk_Entity::getNamespace() |
|---|
\Splunk_NamespaceThe non-wildcarded namespace in which this
entity resides.offsetExists(string $key) : string
| inherited_from | \Splunk_Entity::offsetExists() |
|---|
stringThe name of an entity property.
stringWhether the specified entity property exists.offsetGet(string $key) : string
| inherited_from | \Splunk_Entity::offsetGet() |
|---|
stringThe name of an entity property.
stringThe value of the specified entity property.refresh() : \Splunk_Entity
| inherited_from | \Splunk_Entity::refresh() |
|---|
\Splunk_IOException |
|---|
\Splunk_EntityThis entity.sendDelete(string $relativePath, array $args) : \Splunk_HttpResponse
| see | \Splunk_Http::delete() |
|---|---|
| inherited_from | \Splunk_Endpoint::sendDelete() |
| inherited_from | \Splunk_Entity::sendDelete() |
stringrelative URL path.
array(optional) query parameters, merged with {
namespace: (optional) namespace to use, or NULL to use
the context's default namespace.
}
\Splunk_IOException |
|---|
\Splunk_HttpResponsesendGet(string $relativePath, array $args) : \Splunk_HttpResponse
| see | \Splunk_Http::get() |
|---|---|
| inherited_from | \Splunk_Endpoint::sendGet() |
| inherited_from | \Splunk_Entity::sendGet() |
stringrelative URL path.
array(optional) query parameters, merged with {
namespace: (optional) namespace to use, or NULL to use
the context's default namespace.
}
\Splunk_IOException |
|---|
\Splunk_HttpResponsesendPost(string $relativePath, array $args) : \Splunk_HttpResponse
| see | \Splunk_Http::post() |
|---|---|
| inherited_from | \Splunk_Endpoint::sendPost() |
| inherited_from | \Splunk_Entity::sendPost() |
stringrelative URL path.
array(optional) form parameters to send in the request
body, merged with {
namespace: (optional) namespace to use, or NULL to use
the context's default namespace.
}
\Splunk_IOException |
|---|
\Splunk_HttpResponsesubmit(string $data, array $args)
It is highly recommended to specify a sourcetype explicitly.
It is slightly faster to use Splunk_Receiver::submit() to accomplish the same task. One fewer network request is needed.
| link | http://docs.splunk.com/Documentation/Splunk/latest/RESTAPI/RESTinput#receivers.2Fsimple |
|---|
stringRaw event text. This may contain data for multiple events. Under the default configuration, line breaks ("\n") can be inserted to separate multiple events.
array(optional) {
host: (optional) The value to populate in the host field
for events from this data input.
host_regex: (optional) A regular expression used to
extract the host value from each event.
source: (optional) The source value to fill in the
metadata for this input's events.
sourcetype: (optional) The sourcetype to apply to
events from this input.
}
\Splunk_IOException |
|---|
update(array $args) : \Splunk_Entity
Note that the "name" property cannot be updated.
| inherited_from | \Splunk_Entity::update() |
|---|
arrayDictionary of properties that will be changed, along with their new values.
\Splunk_IOException |
|---|
\Splunk_EntityThis entity.extractEntryFromRootXmlElement($xml)
| inherited_from | \Splunk_Entity::extractEntryFromRootXmlElement() |
|---|
fetch($fetchArgs)
getSearchNamespace() : \Splunk_Namespace | NULL
| inherited_from | \Splunk_Entity::getSearchNamespace() |
|---|
\Splunk_NamespaceNULLThe namespace in which this endpoint
resides, or NULL to use the context's
default namespace.
Possibly a non-exact namespace.getTitle() : string
| inherited_from | \Splunk_Entity::getTitle() |
|---|
stringThe title of this entity in the REST API.isLoaded()
| inherited_from | \Splunk_Entity::isLoaded() |
|---|
validate($fetchArgs) : \Splunk_Entity
Returns self.
| inherited_from | \Splunk_Entity::validate() |
|---|
\Splunk_IOException |
|---|
\Splunk_EntityThis entity.load($fetchArgs)
parseContentsFromEntry()
| inherited_from | \Splunk_Entity::parseContentsFromEntry() |
|---|
sendSimpleRequest($method, $relativePath, $args)
| inherited_from | \Splunk_Endpoint::sendSimpleRequest() |
|---|---|
| inherited_from | \Splunk_Entity::sendSimpleRequest() |
$path
| inherited_from | \Splunk_Endpoint::$$path |
|---|---|
| inherited_from | \Splunk_Entity::$$path |
$service
| inherited_from | \Splunk_Endpoint::$$service |
|---|---|
| inherited_from | \Splunk_Entity::$$service |
$content
| inherited_from | \Splunk_Entity::$$content |
|---|
$entry
| inherited_from | \Splunk_Entity::$$entry |
|---|
$loaded
| inherited_from | \Splunk_Entity::$$loaded |
|---|
$namespace
| inherited_from | \Splunk_Entity::$$namespace |
|---|