Represents the collection of all search jobs.
| package | Splunk |
|---|
create(string $search, array $args) : \Splunk_Job
stringThe search query for the job to perform.
array(optional) Job-specific creation arguments,
merged with {
namespace: (optional) {Splunk_Namespace} The namespace in which
to create the entity. Defaults to the service's
namespace.
}
For details, see the
"POST search/jobs"
endpoint in the REST API Documentation.
\Splunk_IOException |
|---|
createOneshot(string $search, array $args) : string
stringThe search query for the job to perform.
array(optional) Job-specific creation arguments,
merged with {
namespace: (optional) {Splunk_Namespace} The namespace in which
to create the entity. Defaults to the service's
namespace.
}
For details, see the
"POST search/jobs"
endpoint in the REST API Documentation.
\Splunk_IOException |
|---|
stringThe search results, which can be parsed with
Splunk_ResultsReader.delete(string $name, array $args)
| inherited_from | \Splunk_Collection::delete() |
|---|
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
| see | \Splunk_Collection::get() |
|---|
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.
| inherited_from | \Splunk_Collection::getReference() |
|---|
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').
| inherited_from | \Splunk_Collection::items() |
|---|
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() |
| inherited_from | \Splunk_Collection::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_Collection::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_Collection::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)
| inherited_from | \Splunk_Collection::checkName() |
|---|
checkNamespace($namespace)
| inherited_from | \Splunk_Collection::checkNamespace() |
|---|
getSearchNamespace() : \Splunk_Namespace | NULL
| inherited_from | \Splunk_Collection::getSearchNamespace() |
|---|
\Splunk_NamespaceNULLThe namespace in which this endpoint
resides, or NULL to use the context's
default namespace.
Possibly a non-exact namespace.getEntityPath($name)
| inherited_from | \Splunk_Collection::getEntityPath() |
|---|
getEntityRelativePath($name)
| inherited_from | \Splunk_Collection::getEntityRelativePath() |
|---|
loadEntitiesFromResponse($response) : array
| inherited_from | \Splunk_Collection::loadEntitiesFromResponse() |
|---|
arrayarray of Splunk_Entry.loadEntityFromEntry(\SimpleXMLElement $entry) : \Splunk_Entry
| inherited_from | \Splunk_Collection::loadEntityFromEntry() |
|---|
\Splunk_EntrysendSimpleRequest($method, $relativePath, $args)
| inherited_from | \Splunk_Endpoint::sendSimpleRequest() |
|---|---|
| inherited_from | \Splunk_Collection::sendSimpleRequest() |
$path
| inherited_from | \Splunk_Endpoint::$$path |
|---|---|
| inherited_from | \Splunk_Collection::$$path |
$service
| inherited_from | \Splunk_Endpoint::$$service |
|---|---|
| inherited_from | \Splunk_Collection::$$service |
$entitySubclass
| inherited_from | \Splunk_Collection::$$entitySubclass |
|---|