Represents a collection of entities accessible through Splunk's REST API.
| package | Splunk |
|---|
create(string $name, array $args) : \Splunk_Entity
stringThe name of the entity to create.
array(optional) Entity-specific creation arguments,
merged with {
namespace: (optional) {Splunk_Namespace} The namespace in which
to create the entity. Defaults to the service's
namespace.
}
\Splunk_IOException |
|---|
delete(string $name, array $args)
stringThe name of the entity to delete.
array(optional) Entity-specific deletion arguments,
merged with {
namespace: (optional) {Splunk_Namespace} The namespace in which
to find the entity. Defaults to the service's
namespace.
}
\Splunk_IOException |
|---|
get(string $name, \Splunk_Namespace | NULL $namespace) : \Splunk_Entity
stringThe name of the entity to search for.
\Splunk_NamespaceNULL(optional) {Splunk_Namespace} The namespace in which to search. Defaults to the service's namespace.
\Splunk_NoSuchEntityException |
If no such entity exists. |
|---|---|
\Splunk_AmbiguousEntityNameException |
If multiple entities with the specified name exist in the specified namespace. |
\Splunk_IOException |
getReference(string $name, \Splunk_Namespace | NULL $namespace) : \Splunk_Entity
Loading of the entity is deferred until its first use.
stringThe name of the entity to search for.
\Splunk_NamespaceNULL(optional) {Splunk_Namespace} The namespace in which to search. Defaults to the service's namespace.
items(array $args) : array
By default, all items in the collection are returned. For large collections, it is advisable to fetch items using multiple calls with the paging options (i.e. 'offset' and 'count').
array(optional) {
namespace: (optional) {Splunk_Namespace} The namespace in which
to list entities. Defaults to the service's namespace.
count: (optional) The maximum number of items to return,
or -1 to return as many as possible.
Defaults to returning as many as possible.
offset: (optional) The offset of the first item to return.
Defaults to 0.
search: (optional) The search expression to filter responses
with. For example, "foo" matches any object that has
"foo" in a substring of a field. Similarly the
expression "field_name=field_value" matches only objects
that have a "field_name" field with the value
"field_value".
sort_dir: (optional) The direction to sort returned items.
Valid values:
- "asc": Sort in ascending order.
- "desc": Sort in descending order.
Defaults to "asc".
sort_key: (optional) The field to use for sorting.
Defaults to "name".
sort_mode: (optional) The sorting algorithm to use. Valid values:
- "auto": If all values of the field are numbers,
sort numerically. Otherwise, sort
alphabetically.
- "alpha": Sort alphabetically.
- "alpha_case": Sort alphabetically, case-sensitive.
- "num": Sort numerically.
Defaults to "auto".
}
\Splunk_IOException |
|---|
arraythe entities in the listing.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_HttpResponsecheckName($name)
checkNamespace($namespace)
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.getEntityPath($name)
getEntityRelativePath($name)
loadEntitiesFromResponse($response) : array
arrayarray of Splunk_Entry.loadEntityFromEntry(\SimpleXMLElement $entry) : \Splunk_Entry
sendSimpleRequest($method, $relativePath, $args)
| inherited_from | \Splunk_Endpoint::sendSimpleRequest() |
|---|
$path
| inherited_from | \Splunk_Endpoint::$$path |
|---|
$service
| inherited_from | \Splunk_Endpoint::$$service |
|---|
$entitySubclass