nv_ingest_api.util.control_message package#
Submodules#
nv_ingest_api.util.control_message.validators module#
- nv_ingest_api.util.control_message.validators.cm_ensure_payload_not_null(
- control_message: IngestControlMessage,
Ensures that the payload of a IngestControlMessage is not None.
- Parameters:
control_message (IngestControlMessage) – The IngestControlMessage to check.
- Raises:
ValueError – If the payload is None.
- nv_ingest_api.util.control_message.validators.cm_set_failure(
- control_message: IngestControlMessage,
- reason: str,
Sets the failure metadata on a IngestControlMessage.
- Parameters:
control_message (IngestControlMessage) – The IngestControlMessage to set the failure metadata on.
reason (str) – The reason for the failure.
- Returns:
control_message – The modified IngestControlMessage with the failure metadata set.
- Return type: