Class: Processor
Properties
arguments
arguments: dict
Returns arguments which you have configured via the UI as part of a Python Asset. The list of provided arguments are in JSON-Format. You enter them using the Python Asset editor and then retrieve them using this method.
Example
# Get the Processor's configured arguments:
args = processor.arguments
# Now access the individual arguments like this:
my_prop = args['myProp']
name
name: str
Get the name of the current Processor. Same as getName
Example
# Get the Processor's name:
name = processor.name # Returns the name of the Processor, e.g. 'My-Processor'.
Methods
expandString()
expandString(to_expand: str) -> str
Expands all macros contained in a string.
For example, if you want to use the USERNAME
environment variable, which you have defined in an Environment Resource you can do so like this:
Parameters
- to_expand: str
Returns
str - Expanded string
Example
# Get the username which is defined in one of your environment resources:
username = processor.expandString('The username is ${lay:USERNAME}.')
# Output: "The username is layline.", where "layline" is the value of the USERNAME environment variable.
Check out the macro documentation for more information on how to address expandable strings.
getArguments()
getArguments() -> dict
Returns arguments which you have configured via the UI as part of a Python Asset. The list of provided arguments are in JSON-Format. You enter them using the Python Asset editor and then retrieve them using this method.
Returns
dict - Configured arguments as a Python dictionary
Example
# Get the Processor's configured arguments:
args = processor.getArguments()
# Now access the individual arguments like this:
my_prop = args['myProp']
getName()
getName() -> str
Get the name of the current Processor. Same as name
Returns
str - Processor name
Example
# Get the Processor's name:
processor.getName()
getOutputPort()
getOutputPort(port_name: str) -> OutputPort
Get the OutputPort information for a given output port.
Parameters
- port_name: str
Returns
OutputPort - Output port instance information.
Example
# Set stream output name:
OUTPUT_PORT = processor.getOutputPort('Output') # Returns the OutputPort instance for the output port named 'Output'.
logError()
logError(msg: str) -> None
Logs a message with Severity.ERROR to the processor log. You can view this both via the Audit Trail in the UI and output in the process terminal output.
Parameters
- msg: str - Information you want to log.
Returns
None
Example
processor.logError(f'Ran into the following problem: {problem}')
logFatal()
logFatal(msg: str) -> None
Logs a message with Severity.FATAL to the processor log. You can view this both via the Audit Trail in the UI and output in the process terminal output.
Parameters
- msg: str - Information you want to log.
Returns
None
Example
processor.logFatal(f'Ran into the following problem: {problem}')
logInfo()
logInfo(msg: str) -> None
Logs a message with Severity.INFO to the processor log. You can view this both via the Audit Trail in the UI and output in the process terminal output.
Parameters
- msg: str - Information you want to log.
Returns
None
Example
processor.logInfo(f'Here is some interesting information: {info}')
logWarning()
logWarning(msg: str) -> None
Logs a message with Severity.WARNING to the processor log. You can view this both via the Audit Trail in the UI and output in the process terminal output.
Parameters
- msg: str - Information you want to log.
Returns
None
Example
processor.logWarning(f'Here is a warning: {warning}')