Skip to content

PipelineBlueprint

Source code in docs_src/capo_osis/types/pipeline_blueprint.py
class PipelineBlueprint(TypedDict, closed=True):
    blueprint_name: NotRequired["capo_osis.types.string.String"]
    """<p>The name of the blueprint.</p>"""
    pipeline_configuration_body: NotRequired["capo_osis.types.string.String"]
    """<p>The YAML configuration of the blueprint.</p>"""
    display_name: NotRequired["capo_osis.types.string.String"]
    """<p>The display name of the blueprint.</p>"""
    display_description: NotRequired["capo_osis.types.string.String"]
    """<p>A description of the blueprint.</p>"""
    service: NotRequired["capo_osis.types.string.String"]
    """<p>The name of the service that the blueprint is associated with.</p>"""
    use_case: NotRequired["capo_osis.types.string.String"]
    """<p>The use case that the blueprint relates to.</p>"""

blueprint_name instance-attribute

blueprint_name: NotRequired[String]

The name of the blueprint.

display_description instance-attribute

display_description: NotRequired[String]

A description of the blueprint.

display_name instance-attribute

display_name: NotRequired[String]

The display name of the blueprint.

pipeline_configuration_body instance-attribute

pipeline_configuration_body: NotRequired[String]

The YAML configuration of the blueprint.

service instance-attribute

service: NotRequired[String]

The name of the service that the blueprint is associated with.

use_case instance-attribute

use_case: NotRequired[String]

The use case that the blueprint relates to.