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)