Skip to content

DocumentParameter

Source code in docs_src/capo_iot/types/document_parameter.py 
15
16
17
18
19
20
21
22
23
24
25
class DocumentParameter(TypedDict, closed=True):
    key: NotRequired["capo_iot.types.parameter_key.ParameterKey"]
    """<p>Key of the map field containing the patterns that need to be replaced in a managed template job document schema.</p>"""
    description: NotRequired["capo_iot.types.job_description.JobDescription"]
    """<p>Description of the map field containing the patterns that need to be replaced in a managed template job document schema.</p>"""
    regex: NotRequired["capo_iot.types.regex.Regex"]
    """<p>A regular expression of the patterns that need to be replaced in a managed template job document schema.</p>"""
    example: NotRequired["capo_iot.types.example.Example"]
    """<p>An example illustrating a pattern that need to be replaced in a managed template job document schema.</p>"""
    optional: "capo_iot.types.optional.Optional"
    """<p>Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.</p>"""

description instance-attribute 

description: NotRequired[JobDescription]

Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

example instance-attribute 

example: NotRequired[Example]

An example illustrating a pattern that need to be replaced in a managed template job document schema.

key instance-attribute 

key: NotRequired[ParameterKey]

Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

optional instance-attribute 

optional: Optional

Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

regex instance-attribute 

regex: NotRequired[Regex]

A regular expression of the patterns that need to be replaced in a managed template job document schema.