Skip to content

Entity

Source code in docs_src/capo_glue/types/entity.py
class Entity(TypedDict, closed=True):
    entity_name: NotRequired["capo_glue.types.entity_name.EntityName"]
    """<p>The name of the entity.</p>"""
    label: NotRequired["capo_glue.types.entity_label.EntityLabel"]
    """<p>Label used for the entity.</p>"""
    is_parent_entity: NotRequired["capo_glue.types.is_parent_entity.IsParentEntity"]
    """<p>A Boolean value which helps to determine whether there are sub objects that can be listed.</p>"""
    description: NotRequired["capo_glue.types.entity_description.EntityDescription"]
    """<p>A description of the entity.</p>"""
    category: NotRequired["capo_glue.types.category.Category"]
    """<p>The type of entities that are present in the response. This value depends on the source connection. For example this is <code>SObjects</code> for Salesforce and <code>databases</code> or <code>schemas</code> or <code>tables</code> for sources like Amazon Redshift.</p>"""
    custom_properties: NotRequired["capo_glue.types.custom_properties.CustomProperties"]
    """<p>An optional map of keys which may be returned for an entity by a connector.</p>"""

category instance-attribute

category: NotRequired[Category]

The type of entities that are present in the response. This value depends on the source connection. For example this is SObjects for Salesforce and databases or schemas or tables for sources like Amazon Redshift.

custom_properties instance-attribute

custom_properties: NotRequired[CustomProperties]

An optional map of keys which may be returned for an entity by a connector.

description instance-attribute

description: NotRequired[EntityDescription]

A description of the entity.

entity_name instance-attribute

entity_name: NotRequired[EntityName]

The name of the entity.

is_parent_entity instance-attribute

is_parent_entity: NotRequired[IsParentEntity]

A Boolean value which helps to determine whether there are sub objects that can be listed.

label instance-attribute

label: NotRequired[EntityLabel]

Label used for the entity.