Represents an entity accessible through Splunk's REST API.
| package | Splunk |
|---|
getContent() : array
arrayThe properties of this entity.getName() : string
stringThe name of this entity.
This name can be used to lookup this entity
from its collection.getNamespace() : \Splunk_Namespace
\Splunk_NamespaceThe non-wildcarded namespace in which this
entity resides.offsetExists(string $key) : string
stringThe name of an entity property.
stringWhether the specified entity property exists.offsetGet(string $key) : string
stringThe name of an entity property.
stringThe value of the specified entity property.sendDelete(string $relativePath, array $args) : \Splunk_HttpResponse
| see | \Splunk_Http::delete() |
|---|---|
| inherited_from | \Splunk_Endpoint::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() |
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() |
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_HttpResponseupdate(array $args) : \Splunk_Entity
Note that the "name" property cannot be updated.
arrayDictionary of properties that will be changed, along with their new values.
\Splunk_IOException |
|---|
\Splunk_EntityThis entity.extractEntryFromRootXmlElement($xml)
fetch($fetchArgs)
getSearchNamespace() : \Splunk_Namespace | NULL
\Splunk_NamespaceNULLThe namespace in which this endpoint
resides, or NULL to use the context's
default namespace.
Possibly a non-exact namespace.getTitle() : string
stringThe title of this entity in the REST API.isLoaded()
validate($fetchArgs) : \Splunk_Entity
Returns self.
\Splunk_IOException |
|---|
\Splunk_EntityThis entity.parseContentsFromEntry()
sendSimpleRequest($method, $relativePath, $args)
| inherited_from | \Splunk_Endpoint::sendSimpleRequest() |
|---|
$path
| inherited_from | \Splunk_Endpoint::$$path |
|---|
$service
| inherited_from | \Splunk_Endpoint::$$service |
|---|
$content
$entry
$loaded
$namespace