phpDocumentor
Back to top  

Represents a saved search.

package Splunk

 Methods

Deletes this entity.

delete() 
Inherited
inherited_from \Splunk_Entity::delete()

Exceptions

\Splunk_IOException

Runs this saved search and returns the resulting search job.

dispatch(array $args) : \Splunk_Job

Parameters

$args

array

(optional) Additional arguments. For details, see the "POST saved/searches/{name}/dispatch" endpoint in the REST API Documentation.

Returns

\Splunk_JobThe created search job.

Gets an array that contains the properties of this entity.

getContent() : array
Inherited
inherited_from \Splunk_Entity::getContent()

Returns

arrayThe properties of this entity.

Gets the name of this entity.

getName() : string
Inherited
inherited_from \Splunk_Entity::getName()

Returns

stringThe name of this entity. This name can be used to lookup this entity from its collection.

Gets the non-wildcarded namespace in which this entity resides.

getNamespace() : \Splunk_Namespace
Inherited
inherited_from \Splunk_Entity::getNamespace()

Returns

\Splunk_NamespaceThe non-wildcarded namespace in which this entity resides.

Gets a value that indicates whether the specified entity property exists.

offsetExists(string $key) : string
Inherited
inherited_from \Splunk_Entity::offsetExists()

Parameters

$key

string

The name of an entity property.

Returns

stringWhether the specified entity property exists.

Gets the value of the specified entity property.

offsetGet(string $key) : string
Inherited
inherited_from \Splunk_Entity::offsetGet()

Parameters

$key

string

The name of an entity property.

Returns

stringThe value of the specified entity property.

Refreshes this entity's properties from the Splunk server.

refresh() : \Splunk_Entity
Inherited
inherited_from \Splunk_Entity::refresh()

Exceptions

\Splunk_IOException

Returns

\Splunk_EntityThis entity.

Sends an HTTP DELETE request relative to this endpoint.

sendDelete(string $relativePath, array $args) : \Splunk_HttpResponse
Inherited
see \Splunk_Http::delete()
inherited_from \Splunk_Endpoint::sendDelete()
inherited_from \Splunk_Entity::sendDelete()

Parameters

$relativePath

string

relative URL path.

$args

array

(optional) query parameters, merged with {
namespace: (optional) namespace to use, or NULL to use the context's default namespace.
}

Exceptions

\Splunk_IOException

Returns

\Splunk_HttpResponse

Sends an HTTP GET request relative to this endpoint.

sendGet(string $relativePath, array $args) : \Splunk_HttpResponse
Inherited
see \Splunk_Http::get()
inherited_from \Splunk_Endpoint::sendGet()
inherited_from \Splunk_Entity::sendGet()

Parameters

$relativePath

string

relative URL path.

$args

array

(optional) query parameters, merged with {
namespace: (optional) namespace to use, or NULL to use the context's default namespace.
}

Exceptions

\Splunk_IOException

Returns

\Splunk_HttpResponse

Sends an HTTP POST request relative to this endpoint.

sendPost(string $relativePath, array $args) : \Splunk_HttpResponse
Inherited
see \Splunk_Http::post()
inherited_from \Splunk_Endpoint::sendPost()
inherited_from \Splunk_Entity::sendPost()

Parameters

$relativePath

string

relative URL path.

$args

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.
}

Exceptions

\Splunk_IOException

Returns

\Splunk_HttpResponse

Updates this entity's properties.

update(array $args) : \Splunk_Entity
Inherited

Note that the "name" property cannot be updated.

inherited_from \Splunk_Entity::update()

Parameters

$args

array

Dictionary of properties that will be changed, along with their new values.

Exceptions

\Splunk_IOException

Returns

\Splunk_EntityThis entity.

Returns the <entry> element inside the root element.

extractEntryFromRootXmlElement($xml) 
Inherited
inherited_from \Splunk_Entity::extractEntryFromRootXmlElement()

Parameters

$xml

Fetches this entity's Atom feed from the Splunk server.

fetch($fetchArgs) 
Inherited
inherited_from \Splunk_Entity::fetch()

Parameters

$fetchArgs

Exceptions

\Splunk_IOException

Gets the namespace in which this entity resides.

getSearchNamespace() : \Splunk_Namespace | NULL
Inherited
inherited_from \Splunk_Entity::getSearchNamespace()

Returns

\Splunk_NamespaceNULLThe namespace in which this endpoint resides, or NULL to use the context's default namespace. Possibly a non-exact namespace.

Gets the title of this entity in the REST API.

getTitle() : string
Inherited
inherited_from \Splunk_Entity::getTitle()

Returns

stringThe title of this entity in the REST API.

Returns a value that indicates whether the entity has been loaded.

isLoaded() 
Inherited
inherited_from \Splunk_Entity::isLoaded()

Loads this resource if not already done.

validate($fetchArgs) : \Splunk_Entity
Inherited

Returns self.

inherited_from \Splunk_Entity::validate()

Parameters

$fetchArgs

Exceptions

\Splunk_IOException

Returns

\Splunk_EntityThis entity.

Loads this resource.

load($fetchArgs) 
Inherited
inherited_from \Splunk_Entity::load()

Parameters

$fetchArgs

Exceptions

\Splunk_IOException

Parses the entry's contents.

parseContentsFromEntry() 
Inherited
inherited_from \Splunk_Entity::parseContentsFromEntry()

Sends a simple request relative to this endpoint.

sendSimpleRequest($method, $relativePath, $args) 
Inherited
inherited_from \Splunk_Endpoint::sendSimpleRequest()
inherited_from \Splunk_Entity::sendSimpleRequest()

Parameters

$method

$relativePath

$args

 Properties

 

$path 
Inherited
inherited_from \Splunk_Endpoint::$$path
inherited_from \Splunk_Entity::$$path
 

$service 
Inherited
inherited_from \Splunk_Endpoint::$$service
inherited_from \Splunk_Entity::$$service
 

$content 
Inherited
inherited_from \Splunk_Entity::$$content
 

$entry 
Inherited
inherited_from \Splunk_Entity::$$entry
 

$loaded 
Inherited
inherited_from \Splunk_Entity::$$loaded
 

$namespace 
Inherited
inherited_from \Splunk_Entity::$$namespace