ObjectMetadataModel
Important notice: As part of Advanced XML deprecation, the Module System is officially deprecated beginning with Splunk Enterprise 6.3. For more information, see Advanced XML Deprecation. |
create()
The create() method creates a new version of the current object from the settings stored when the object was instantiated.
Synopsis
status = create()
Return Value
Boolean | Object create status: True = Object successfully created. False = Current object already has an ID, or unable to create a new entity. Object not created. |
Example
from splunk.models.base import ObjectMetadataModel
class MyAppModel(ObjectMetadataModel):
if MyAppModel.create():
... elided ...
else:
... elided ...
save()
The save() method saves the current job, which permits the job to persist, indefinitely. Calling this method has no effect if the job has already completed, although the save operation will be considered successful. A saved job cannot be auto-canceled by the UI or by calling setAsAutoCancellable().
Synopsis
save( onSuccess, onFailure)
Parameters
onSuccess | Function | (Optional) Function to execute upon successful operation. |
onFailure | Function | (Optional) Function to execute upon unsuccessful operation. |
Example
var context = this.getContext();
var search = context.get('search');
search.job.save(
function() { console.log('Current job successfully saved!'); },
function() { console.log('Failed to save the current job!'); } );
set_entity_fields()
The set_entity_fields() method sets the current object entity fields to the specified model fields.
Note: Generally, calling SplunkRESTModel.create() is preferred over calling this method.
Synopsis
status = set_entity_fields( entity )
Parameters
entity | Object | Entity from which to copy metadata fields. |
Return Value
Boolean | Set request status. This method always returns True, indicating the fields were successfully set. |
Example
from splunk.models.base import SplunkRESTModel
class MyAppModel(SplunkRESTModel):
def from_entity(self, entity):
self._parse_id(entity)
self._parse_links(entity)
if not self.id:
return False
self.name = entity.name
if 'eai:acl' in entity:
self.owner = entity['eai:acl']['owner']
self.namespace = entity['eai:acl']['app' ]
return self.set_entity_fields(entity)
SplunkAppObjModel | SplunkRESTManager |
This documentation applies to the following versions of Splunk® Enterprise: 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9
Feedback submitted, thanks!