Skip to content

UploadEntityDefinitionsRequest

Source code in docs_src/capo_iotthingsgraph/types/upload_entity_definitions_request.py 
13
14
15
16
17
18
19
20
21
22
23
class UploadEntityDefinitionsRequest(TypedDict, closed=True):
    document: NotRequired[
        "capo_iotthingsgraph.types.definition_document.DefinitionDocument"
    ]
    """<p>The <code>DefinitionDocument</code> that defines the updated entities.</p>"""
    sync_with_public_namespace: (
        "capo_iotthingsgraph.types.sync_with_public_namespace.SyncWithPublicNamespace"
    )
    """<p>A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to <code>true</code>, the upload will create a new namespace version.</p>"""
    deprecate_existing_entities: "capo_iotthingsgraph.types.deprecate_existing_entities.DeprecateExistingEntities"
    """<p>A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new <code>DefinitionDocument</code>. If set to <code>true</code>, the upload will create a new namespace version.</p>"""

deprecate_existing_entities instance-attribute 

deprecate_existing_entities: DeprecateExistingEntities

A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument. If set to true, the upload will create a new namespace version.

document instance-attribute 

document: NotRequired[DefinitionDocument]

The DefinitionDocument that defines the updated entities.

sync_with_public_namespace instance-attribute 

sync_with_public_namespace: SyncWithPublicNamespace

A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.