Skip to content

ComponentState

Source code in docs_src/capo_proton/types/component_state.py
class ComponentState(TypedDict, closed=True):
    service_name: NotRequired[
        "capo_proton.types.resource_name_or_empty.ResourceNameOrEmpty"
    ]
    """<p>The name of the service that <code>serviceInstanceName</code> is associated with. Provided when a component is attached to a service instance.</p>"""
    service_instance_name: NotRequired[
        "capo_proton.types.resource_name_or_empty.ResourceNameOrEmpty"
    ]
    """<p>The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.</p>"""
    service_spec: NotRequired["capo_proton.types.spec_contents.SpecContents"]
    """<p>The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.</p>"""
    template_file: NotRequired[
        "capo_proton.types.template_file_contents.TemplateFileContents"
    ]
    """<p>The template file used.</p>"""

service_instance_name instance-attribute

service_instance_name: NotRequired[ResourceNameOrEmpty]

The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

service_name instance-attribute

service_name: NotRequired[ResourceNameOrEmpty]

The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

service_spec instance-attribute

service_spec: NotRequired[SpecContents]

The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

template_file instance-attribute

template_file: NotRequired[TemplateFileContents]

The template file used.