Skip to content

Action

Source code in docs_src/capo_forecast/types/action.py 
15
16
17
18
19
20
21
class Action(TypedDict, closed=True):
    attribute_name: "capo_forecast.types.name.Name"
    """<p>The related time series that you are modifying. This value is case insensitive.</p>"""
    operation: "capo_forecast.types.operation.Operation"
    """<p>The operation that is applied to the provided attribute. Operations include:</p> <ul> <li> <p> <code>ADD</code> - adds <code>Value</code> to all rows of <code>AttributeName</code>.</p> </li> <li> <p> <code>SUBTRACT</code> - subtracts <code>Value</code> from all rows of <code>AttributeName</code>.</p> </li> <li> <p> <code>MULTIPLY</code> - multiplies all rows of <code>AttributeName</code> by <code>Value</code>.</p> </li> <li> <p> <code>DIVIDE</code> - divides all rows of <code>AttributeName</code> by <code>Value</code>.</p> </li> </ul>"""
    value: "capo_forecast.types.double.Double"
    """<p>The value that is applied for the chosen <code>Operation</code>.</p>"""

attribute_name instance-attribute 

attribute_name: Name

The related time series that you are modifying. This value is case insensitive.

operation instance-attribute 

operation: Operation

The operation that is applied to the provided attribute. Operations include:

  • ADD - adds Value to all rows of AttributeName.

  • SUBTRACT - subtracts Value from all rows of AttributeName.

  • MULTIPLY - multiplies all rows of AttributeName by Value.

  • DIVIDE - divides all rows of AttributeName by Value.

value instance-attribute 

value: Double

The value that is applied for the chosen Operation.