Skip to content

Builders

builders

Map our domain signals onto OCSF event models (one typed builder per class).

Each build_* returns a typed, already-valid model instance. All OCSF-specific knowledge (field names, *_id integers, defaults) is confined to this module, defaults, and the generated _catalog (per-class activity enums).

build_observable 

build_observable(observable: Observable) -> Observable

Map one domain Observable to an OCSF observable model.

OCSF observable.name is the attribute name/path and is required. When the caller does not supply one we fall back to the observable type's label (e.g. "ip_address").

Source code in src/ocsf_emitter/builders.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
def build_observable(observable: Observable) -> _m.Observable:
    """Map one domain Observable to an OCSF observable model.

    OCSF ``observable.name`` is the attribute name/path and is required. When the
    caller does not supply one we fall back to the observable type's label (e.g.
    ``"ip_address"``).
    """
    return _m.Observable(
        name=observable.name if observable.name is not None else observable.type.value,
        value=observable.value,
        # Pass the plain int; Pydantic coerces it into whichever per-object enum
        # the generated ``type_id`` field uses. Do NOT hardcode ``_m.TypeIdN`` --
        # datamodel-codegen renumbers those names across schema versions, and the
        # observable type enum is a wide one (0-10, 20-30, 99).
        type_id=_OBSERVABLE_TYPE_TO_ID[observable.type],
    )

build_attack 

build_attack(attack: MitreAttack) -> Attack

Map a MitreAttack to an OCSF attack object (technique [+ tactic]).

Source code in src/ocsf_emitter/builders.py 
210
211
212
213
214
215
216
def build_attack(attack: MitreAttack) -> _m.Attack:
    """Map a MitreAttack to an OCSF attack object (technique [+ tactic])."""
    technique = _m.Technique(uid=attack.technique_uid, name=attack.technique_name)
    tactics = None
    if attack.tactic_uid is not None:
        tactics = [_m.Tactic(uid=attack.tactic_uid, name=attack.tactic_name)]
    return _m.Attack(technique=technique, tactics=tactics)

build_user 

build_user(user: UserRef) -> User

Map a domain UserRef to an OCSF user object (requires name or uid).

Source code in src/ocsf_emitter/builders.py 
219
220
221
222
223
224
225
226
227
228
def build_user(user: UserRef) -> _m.User:
    """Map a domain UserRef to an OCSF user object (requires name or uid)."""
    _at_least_one("user.name / user.uid", name=user.name, uid=user.uid)
    return _m.User(
        name=user.name,
        uid=user.uid,
        email_addr=user.email,
        domain=user.domain,
        full_name=user.full_name,
    )

build_device 

build_device(device: DeviceRef) -> Device

Map a domain DeviceRef to an OCSF device object (requires hostname or uid).

Source code in src/ocsf_emitter/builders.py 
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
def build_device(device: DeviceRef) -> _m.Device:
    """Map a domain DeviceRef to an OCSF device object (requires hostname or uid)."""
    _at_least_one("device.hostname / device.uid", hostname=device.hostname, uid=device.uid)
    os = None
    if device.os_name or device.os_version or device.os_sp_name or device.os_sp_ver:
        os = _m.Os(
            name=device.os_name if device.os_name is not None else "unknown",
            # Plain ints; Pydantic coerces into the field's per-object enum (see
            # build_observable -- generated enum names are not version-stable).
            type_id=device.os_type_id,
            version=device.os_version,
            sp_name=device.os_sp_name,
            sp_ver=device.os_sp_ver,
        )
    return _m.Device(
        hostname=device.hostname,
        uid=device.uid,
        type_id=device.type_id,
        os=os,
    )

build_file 

build_file(file: FileRef) -> File

Map a domain FileRef to an OCSF file object.

Source code in src/ocsf_emitter/builders.py 
253
254
255
256
257
258
259
260
261
def build_file(file: FileRef) -> _m.File:
    """Map a domain FileRef to an OCSF file object."""
    return _m.File(
        name=file.name,
        type_id=file.type_id,  # plain int; Pydantic coerces (see build_observable)
        mime_type=file.mime_type,
        uid=file.uid,
        path=file.path,
    )

build_api 

build_api(api: ApiCall) -> Api

Map a domain ApiCall to an OCSF api object.

Source code in src/ocsf_emitter/builders.py 
264
265
266
267
def build_api(api: ApiCall) -> _m.Api:
    """Map a domain ApiCall to an OCSF api object."""
    service = _m.Service(name=api.service) if api.service is not None else None
    return _m.Api(operation=api.operation, service=service, version=api.version)

build_web_resource 

build_web_resource(resource: WebResourceRef) -> WebResource

Map a domain WebResourceRef to an OCSF web_resource object (requires name or uid).

Source code in src/ocsf_emitter/builders.py 
270
271
272
273
274
275
276
277
278
def build_web_resource(resource: WebResourceRef) -> _m.WebResource:
    """Map a domain WebResourceRef to an OCSF web_resource object (requires name or uid)."""
    _at_least_one("web_resource.name / .uid", name=resource.name, uid=resource.uid)
    return _m.WebResource(
        name=resource.name,
        type=resource.type,
        uid=resource.uid,
        url_string=resource.url_string,
    )

build_endpoint 

build_endpoint(endpoint: EndpointRef) -> NetworkEndpoint

Map a domain EndpointRef to an OCSF network_endpoint (requires ip/hostname/uid).

Source code in src/ocsf_emitter/builders.py 
281
282
283
284
285
286
287
288
289
290
291
292
293
294
def build_endpoint(endpoint: EndpointRef) -> _m.NetworkEndpoint:
    """Map a domain EndpointRef to an OCSF network_endpoint (requires ip/hostname/uid)."""
    _at_least_one(
        "network_endpoint.ip / .hostname / .uid",
        ip=endpoint.ip,
        hostname=endpoint.hostname,
        uid=endpoint.uid,
    )
    return _m.NetworkEndpoint(
        ip=endpoint.ip,
        hostname=endpoint.hostname,
        port=endpoint.port,
        uid=endpoint.uid,
    )

build_compliance 

build_compliance(compliance: ComplianceRef) -> Compliance

Map a domain ComplianceRef to an OCSF compliance object.

Source code in src/ocsf_emitter/builders.py 
297
298
299
300
301
302
303
def build_compliance(compliance: ComplianceRef) -> _m.Compliance:
    """Map a domain ComplianceRef to an OCSF compliance object."""
    return _m.Compliance(
        standards=list(compliance.standards),
        control=compliance.control,
        status=compliance.status,
    )

build_process 

build_process(process: ProcessRef) -> Process

Map a domain ProcessRef to an OCSF process object (requires pid or uid).

Source code in src/ocsf_emitter/builders.py 
306
307
308
309
310
311
def build_process(process: ProcessRef) -> _m.Process:
    """Map a domain ProcessRef to an OCSF process object (requires pid or uid)."""
    _at_least_one("process.pid / process.uid", pid=process.pid, uid=process.uid)
    return _m.Process(
        name=process.name, pid=process.pid, cmd_line=process.cmd_line, uid=process.uid
    )

build_email 

build_email(email: EmailRef) -> Email

Map a domain EmailRef to an OCSF email object (requires from or to; from is aliased).

Source code in src/ocsf_emitter/builders.py 
314
315
316
317
318
319
320
321
322
323
324
325
326
def build_email(email: EmailRef) -> _m.Email:
    """Map a domain EmailRef to an OCSF email object (requires from or to; ``from`` is aliased)."""
    _at_least_one("email.from / email.to", from_addr=email.from_addr, to=email.to)
    data: dict[str, object] = {}
    if email.from_addr is not None:
        data["from"] = email.from_addr
    if email.to is not None:
        data["to"] = list(email.to)
    if email.subject is not None:
        data["subject"] = email.subject
    if email.uid is not None:
        data["uid"] = email.uid
    return _m.Email.model_validate(data)

build_vulnerability 

build_vulnerability(
    vuln: VulnerabilityRef,
) -> Vulnerability

Map a domain VulnerabilityRef to an OCSF vulnerability (just one of cve/cwe/advisory).

Source code in src/ocsf_emitter/builders.py 
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
def build_vulnerability(vuln: VulnerabilityRef) -> _m.Vulnerability:
    """Map a domain VulnerabilityRef to an OCSF vulnerability (just one of cve/cwe/advisory)."""
    _just_one(
        "vulnerability.cve / .cwe / .advisory",
        cve_uid=vuln.cve_uid,
        cwe_uid=vuln.cwe_uid,
        advisory_uid=vuln.advisory_uid,
    )
    cve = _m.Cve(uid=vuln.cve_uid) if vuln.cve_uid is not None else None
    cwe = _m.Cwe(uid=vuln.cwe_uid) if vuln.cwe_uid is not None else None
    advisory = _m.Advisory(uid=vuln.advisory_uid) if vuln.advisory_uid is not None else None
    return _m.Vulnerability(
        title=vuln.title,
        severity=vuln.severity,
        desc=vuln.desc,
        cve=cve,
        cwe=cwe,
        advisory=advisory,
    )

build_connection_info 

build_connection_info(
    conn: ConnectionInfoRef,
) -> NetworkConnectionInfo

Map a domain ConnectionInfoRef to an OCSF network_connection_info object.

Source code in src/ocsf_emitter/builders.py 
350
351
352
353
354
def build_connection_info(conn: ConnectionInfoRef) -> _m.NetworkConnectionInfo:
    """Map a domain ConnectionInfoRef to an OCSF network_connection_info object."""
    return _m.NetworkConnectionInfo(
        direction_id=conn.direction_id, protocol_name=conn.protocol_name, uid=conn.uid
    )

build_group 

build_group(group: GroupRef) -> Group

Map a domain GroupRef to an OCSF group object (requires name or uid).

Source code in src/ocsf_emitter/builders.py 
357
358
359
360
def build_group(group: GroupRef) -> _m.Group:
    """Map a domain GroupRef to an OCSF group object (requires name or uid)."""
    _at_least_one("group.name / group.uid", name=group.name, uid=group.uid)
    return _m.Group(name=group.name, uid=group.uid, type=group.type)

build_database 

build_database(database: DatabaseRef) -> Database

Map a domain DatabaseRef to an OCSF database object (requires name or uid).

Source code in src/ocsf_emitter/builders.py 
363
364
365
366
def build_database(database: DatabaseRef) -> _m.Database:
    """Map a domain DatabaseRef to an OCSF database object (requires name or uid)."""
    _at_least_one("database.name / database.uid", name=database.name, uid=database.uid)
    return _m.Database(name=database.name, uid=database.uid, type_id=database.type_id)

build_resource_details 

build_resource_details(
    resource: ResourceDetailsRef,
) -> ResourceDetails

Map a domain ResourceDetailsRef to an OCSF resource_details (requires name or uid).

Source code in src/ocsf_emitter/builders.py 
369
370
371
372
def build_resource_details(resource: ResourceDetailsRef) -> _m.ResourceDetails:
    """Map a domain ResourceDetailsRef to an OCSF resource_details (requires name or uid)."""
    _at_least_one("resource_details.name / .uid", name=resource.name, uid=resource.uid)
    return _m.ResourceDetails(name=resource.name, uid=resource.uid, type=resource.type)

build_job 

build_job(job: JobRef) -> Job

Map a domain JobRef to an OCSF job object (requires name + file).

Source code in src/ocsf_emitter/builders.py 
375
376
377
def build_job(job: JobRef) -> _m.Job:
    """Map a domain JobRef to an OCSF job object (requires name + file)."""
    return _m.Job(name=job.name, file=build_file(job.file), cmd_line=job.cmd_line, desc=job.desc)

build_kernel 

build_kernel(kernel: KernelRef) -> Kernel

Map a domain KernelRef to an OCSF kernel object (requires name + type_id).

Source code in src/ocsf_emitter/builders.py 
380
381
382
def build_kernel(kernel: KernelRef) -> _m.Kernel:
    """Map a domain KernelRef to an OCSF kernel object (requires name + type_id)."""
    return _m.Kernel(name=kernel.name, type_id=kernel.type_id, path=kernel.path)

build_module 

build_module(module: ModuleRef) -> Module

Map a domain ModuleRef to an OCSF module object (requires load_type_id).

Source code in src/ocsf_emitter/builders.py 
385
386
387
388
def build_module(module: ModuleRef) -> _m.Module:
    """Map a domain ModuleRef to an OCSF module object (requires load_type_id)."""
    file = build_file(module.file) if module.file is not None else None
    return _m.Module(load_type_id=module.load_type_id, base_address=module.base_address, file=file)

build_script 

build_script(script: ScriptRef) -> Script

Map a domain ScriptRef to an OCSF script object (requires script_content + type_id).

Source code in src/ocsf_emitter/builders.py 
391
392
393
394
395
396
397
def build_script(script: ScriptRef) -> _m.Script:
    """Map a domain ScriptRef to an OCSF script object (requires script_content + type_id)."""
    return _m.Script(
        type_id=script.type_id,
        script_content=_m.LongString(value=script.script_content),
        name=script.name,
    )

build_scan 

build_scan(scan: ScanRef) -> Scan

Map a domain ScanRef to an OCSF scan object (requires type_id, and name or uid).

Source code in src/ocsf_emitter/builders.py 
400
401
402
403
def build_scan(scan: ScanRef) -> _m.Scan:
    """Map a domain ScanRef to an OCSF scan object (requires type_id, and name or uid)."""
    _at_least_one("scan.name / scan.uid", name=scan.name, uid=scan.uid)
    return _m.Scan(type_id=scan.type_id, name=scan.name, uid=scan.uid)

build_osint 

build_osint(osint: OsintRef) -> Osint

Map a domain OsintRef to an OCSF osint object (requires type_id + value).

Source code in src/ocsf_emitter/builders.py 
406
407
408
def build_osint(osint: OsintRef) -> _m.Osint:
    """Map a domain OsintRef to an OCSF osint object (requires type_id + value)."""
    return _m.Osint(type_id=osint.type_id, value=osint.value, desc=osint.desc)

build_managed_entity 

build_managed_entity(
    entity: ManagedEntityRef,
) -> ManagedEntity

Map a domain ManagedEntityRef to an OCSF managed_entity object (requires name or uid).

Source code in src/ocsf_emitter/builders.py 
411
412
413
414
415
416
def build_managed_entity(entity: ManagedEntityRef) -> _m.ManagedEntity:
    """Map a domain ManagedEntityRef to an OCSF managed_entity object (requires name or uid)."""
    _at_least_one("managed_entity.name / .uid", name=entity.name, uid=entity.uid)
    return _m.ManagedEntity(
        name=entity.name, uid=entity.uid, type=entity.type, type_id=entity.type_id
    )

build_query_evidence 

build_query_evidence(
    query: QueryEvidenceRef,
) -> QueryEvidence

Map a domain QueryEvidenceRef to an OCSF query_evidence (just one queried object).

Source code in src/ocsf_emitter/builders.py 
419
420
421
422
423
424
425
426
427
def build_query_evidence(query: QueryEvidenceRef) -> _m.QueryEvidence:
    """Map a domain QueryEvidenceRef to an OCSF query_evidence (just one queried object)."""
    _just_one("query_evidence.user / .process", user=query.user, process=query.process)
    return _m.QueryEvidence(
        query_type_id=query.query_type_id,
        query_type=query.query_type,
        user=build_user(query.user) if query.user is not None else None,
        process=build_process(query.process) if query.process is not None else None,
    )

build_kernel_driver 

build_kernel_driver(
    driver: KernelDriverRef,
) -> KernelDriver

Map a domain KernelDriverRef to an OCSF kernel_driver object (requires file).

Source code in src/ocsf_emitter/builders.py 
430
431
432
def build_kernel_driver(driver: KernelDriverRef) -> _m.KernelDriver:
    """Map a domain KernelDriverRef to an OCSF kernel_driver object (requires file)."""
    return _m.KernelDriver(file=build_file(driver.file))

build_uas 

build_uas(uas: UasRef) -> UnmannedAerialSystem

Map a domain UasRef to an OCSF unmanned_aerial_system (requires name/serial_number/uid).

Source code in src/ocsf_emitter/builders.py 
435
436
437
438
439
440
441
442
443
444
445
def build_uas(uas: UasRef) -> _m.UnmannedAerialSystem:
    """Map a domain UasRef to an OCSF unmanned_aerial_system (requires name/serial_number/uid)."""
    _at_least_one(
        "unmanned_aerial_system.name / .serial_number / .uid",
        name=uas.name,
        serial_number=uas.serial_number,
        uid=uas.uid,
    )
    return _m.UnmannedAerialSystem(
        uid=uas.uid, name=uas.name, model=uas.model, serial_number=uas.serial_number
    )

build_detection_finding 

build_detection_finding(
    *,
    title: str,
    severity: Severity,
    message: str,
    uid: str | None = None,
    observables: Sequence[Observable] | None = None,
    activity: Activity = CREATE,
    status: Status = NEW,
    description: str | None = None,
    time_ms: int | None = None,
    data_sources: Sequence[str] | None = None,
    confidence: Confidence | None = None,
    confidence_score: int | None = None,
    risk_level: RiskLevel | None = None,
    risk_score: int | None = None,
    attacks: Sequence[MitreAttack] | None = None,
    count: int | None = None,
    first_seen_ms: int | None = None,
    last_seen_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> DetectionFinding

Build a typed, valid OCSF Detection Finding from our fields.

This is the primary entry point. It stamps house defaults (metadata, product, schema version, activity/severity/status mappings, event time) so every finding leaves with a consistent shape.

Parameters:

Name Type Description Default
title str

Short human-facing finding title.

 required
severity Severity

Our severity; mapped to OCSF severity_id.

 required
message str

Human-readable description of the detection.

 required
uid str | None

Stable unique id (OCSF finding_info.uid). Auto-generated via uid_factory (uuid4 by default) when omitted -- prefer passing a stable id so downstream systems can deduplicate.

 None
observables Sequence[Observable] | None

Entities the finding refers to.

 None
activity Activity

Lifecycle activity; drives activity_id and type_uid.

 CREATE
status Status

Triage status; mapped to OCSF status_id.

 NEW
description str | None

Longer detail, stored on finding_info.desc.

 None
time_ms int | None

Event time (epoch ms). Defaults to clock().

 None
data_sources Sequence[str] | None

Provenance, stored on finding_info.data_sources.

 None
confidence Confidence | None

Detector confidence; mapped to confidence_id.

 None
confidence_score int | None

Numeric confidence (0-100), stored on confidence_score.

 None
risk_level RiskLevel | None

Risk assessment; mapped to risk_level_id.

 None
risk_score int | None

Numeric risk score, stored on risk_score.

 None
attacks Sequence[MitreAttack] | None

MITRE ATT&CK references, stored on finding_info.attacks.

 None
count int | None

Observation count, stored on count.

 None
first_seen_ms int | None

First observation time (epoch ms) -> finding_info.first_seen_time.

 None
last_seen_ms int | None

Last observation time (epoch ms) -> finding_info.last_seen_time.

 None
product Product | None

OCSF Product to stamp; defaults to the process-wide product set via defaults.configure_product (see :func:build_from_signal).

 None
clock Callable[[], int]

Injectable time source (epoch ms) for deterministic tests.

 _now_ms
uid_factory Callable[[], str]

Injectable uid source for deterministic tests.

 _new_uid

Returns:

Type Description
DetectionFinding

A DetectionFinding model instance. Pydantic validates field types at
DetectionFinding

construction; call :func:ocsf_emitter.validate.validate (or emit)
DetectionFinding

for the full pre-flight check.
Source code in src/ocsf_emitter/builders.py 
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
def build_detection_finding(
    *,
    title: str,
    severity: Severity,
    message: str,
    uid: str | None = None,
    observables: Sequence[Observable] | None = None,
    activity: Activity = Activity.CREATE,
    status: Status = Status.NEW,
    description: str | None = None,
    time_ms: int | None = None,
    data_sources: Sequence[str] | None = None,
    confidence: Confidence | None = None,
    confidence_score: int | None = None,
    risk_level: RiskLevel | None = None,
    risk_score: int | None = None,
    attacks: Sequence[MitreAttack] | None = None,
    count: int | None = None,
    first_seen_ms: int | None = None,
    last_seen_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> _m.DetectionFinding:
    """Build a typed, valid OCSF Detection Finding from our fields.

    This is the primary entry point. It stamps house defaults (metadata,
    product, schema version, activity/severity/status mappings, event time) so
    every finding leaves with a consistent shape.

    Args:
        title: Short human-facing finding title.
        severity: Our severity; mapped to OCSF ``severity_id``.
        message: Human-readable description of the detection.
        uid: Stable unique id (OCSF ``finding_info.uid``). Auto-generated via
            ``uid_factory`` (uuid4 by default) when omitted -- prefer passing a
            stable id so downstream systems can deduplicate.
        observables: Entities the finding refers to.
        activity: Lifecycle activity; drives ``activity_id`` and ``type_uid``.
        status: Triage status; mapped to OCSF ``status_id``.
        description: Longer detail, stored on ``finding_info.desc``.
        time_ms: Event time (epoch ms). Defaults to ``clock()``.
        data_sources: Provenance, stored on ``finding_info.data_sources``.
        confidence: Detector confidence; mapped to ``confidence_id``.
        confidence_score: Numeric confidence (0-100), stored on ``confidence_score``.
        risk_level: Risk assessment; mapped to ``risk_level_id``.
        risk_score: Numeric risk score, stored on ``risk_score``.
        attacks: MITRE ATT&CK references, stored on ``finding_info.attacks``.
        count: Observation count, stored on ``count``.
        first_seen_ms: First observation time (epoch ms) -> finding_info.first_seen_time.
        last_seen_ms: Last observation time (epoch ms) -> finding_info.last_seen_time.
        product: OCSF Product to stamp; defaults to the process-wide product set
            via ``defaults.configure_product`` (see :func:`build_from_signal`).
        clock: Injectable time source (epoch ms) for deterministic tests.
        uid_factory: Injectable uid source for deterministic tests.

    Returns:
        A ``DetectionFinding`` model instance. Pydantic validates field types at
        construction; call :func:`ocsf_emitter.validate.validate` (or ``emit``)
        for the full pre-flight check.
    """
    signal = DetectionSignal(
        uid=uid if uid is not None else uid_factory(),
        title=title,
        severity=severity,
        message=message,
        activity=activity,
        status=status,
        observables=list(observables or []),
        description=description,
        time_ms=time_ms,
        data_sources=list(data_sources or []),
        confidence=confidence,
        confidence_score=confidence_score,
        risk_level=risk_level,
        risk_score=risk_score,
        attacks=list(attacks or []),
        count=count,
        first_seen_ms=first_seen_ms,
        last_seen_ms=last_seen_ms,
    )
    return build_from_signal(signal, product=product, clock=clock)

build_from_signal 

build_from_signal(
    signal: DetectionSignal,
    *,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> DetectionFinding

Build an OCSF Detection Finding from a fully-formed domain signal.

product overrides the process-wide default set via defaults.configure_product. If neither is set, raises :class:OcsfEmitterError rather than emitting an unattributed finding.

Source code in src/ocsf_emitter/builders.py 
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
def build_from_signal(
    signal: DetectionSignal,
    *,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.DetectionFinding:
    """Build an OCSF Detection Finding from a fully-formed domain signal.

    ``product`` overrides the process-wide default set via
    ``defaults.configure_product``. If neither is set, raises
    :class:`OcsfEmitterError` rather than emitting an unattributed finding.
    """
    resolved_product = product if product is not None else defaults.default_product()
    if resolved_product is None:
        raise OcsfEmitterError(
            "No product configured. Call ocsf_emitter.configure_product(name=..., "
            "vendor_name=...) once at startup, or pass product= to the builder."
        )

    event_time = signal.time_ms if signal.time_ms is not None else clock()

    finding_info = _m.FindingInfo(
        uid=signal.uid,
        title=signal.title,
        desc=signal.description,
        data_sources=list(signal.data_sources) or None,
        attacks=[build_attack(a) for a in signal.attacks] or None,
        first_seen_time=signal.first_seen_ms,
        last_seen_time=signal.last_seen_ms,
    )

    ocsf_observables = [build_observable(o) for o in signal.observables] or None

    return _m.DetectionFinding(
        # Class identity (fixed for class_uid 2004).
        class_uid=defaults.class_uid(),
        category_uid=defaults.category_uid(),
        class_name=defaults.CLASS_NAME,
        category_name=defaults.CATEGORY_NAME,
        type_uid=defaults.type_uid(signal.activity),
        # Mapped enums.
        activity_id=defaults.activity_id(signal.activity),
        severity_id=defaults.severity_id(signal.severity),
        status_id=defaults.status_id(signal.status),
        confidence_id=(
            defaults.confidence_id(signal.confidence) if signal.confidence is not None else None
        ),
        risk_level_id=(
            defaults.risk_level_id(signal.risk_level) if signal.risk_level is not None else None
        ),
        # House defaults.
        metadata=defaults.default_metadata(resolved_product),
        # Payload.
        time=event_time,
        message=signal.message,
        finding_info=finding_info,
        observables=ocsf_observables,
        confidence_score=signal.confidence_score,
        risk_score=signal.risk_score,
        count=signal.count,
    )

build_authentication 

build_authentication(
    *,
    user: UserRef,
    severity: Severity,
    activity: AuthenticationAction = LOGON,
    message: str | None = None,
    service_name: str | None = None,
    dst_endpoint: EndpointRef | None = None,
    is_mfa: bool | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> Authentication

Build an OCSF Authentication (3002) event.

OCSF requires user and at least one of service/dst_endpoint; a default service is synthesized from service_name (or "unknown") when neither is supplied so the constraint always holds.

Source code in src/ocsf_emitter/builders.py 
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
def build_authentication(
    *,
    user: UserRef,
    severity: Severity,
    activity: AuthenticationAction = AuthenticationAction.LOGON,
    message: str | None = None,
    service_name: str | None = None,
    dst_endpoint: EndpointRef | None = None,
    is_mfa: bool | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.Authentication:
    """Build an OCSF Authentication (3002) event.

    OCSF requires ``user`` and at least one of ``service``/``dst_endpoint``; a
    default ``service`` is synthesized from ``service_name`` (or "unknown") when
    neither is supplied so the constraint always holds.
    """
    core = _core_fields(
        OcsfClass.AUTHENTICATION,
        activity_id_value=int(activity),
        severity=severity,
        message=message,
        time_ms=time_ms,
        observables=observables,
        product=product,
        clock=clock,
    )
    service = None
    endpoint = build_endpoint(dst_endpoint) if dst_endpoint is not None else None
    if endpoint is None:
        service = _m.Service(name=service_name if service_name is not None else "unknown")
    return _m.Authentication(
        **core,
        user=build_user(user),
        service=service,
        dst_endpoint=endpoint,
        is_mfa=is_mfa,
    )

build_account_change 

build_account_change(
    *,
    user: UserRef,
    severity: Severity,
    activity: AccountChangeAction = CREATE,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> AccountChange

Build an OCSF Account Change (3001) event. Requires user.

Source code in src/ocsf_emitter/builders.py 
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
def build_account_change(
    *,
    user: UserRef,
    severity: Severity,
    activity: AccountChangeAction = AccountChangeAction.CREATE,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.AccountChange:
    """Build an OCSF Account Change (3001) event. Requires ``user``."""
    core = _core_fields(
        OcsfClass.ACCOUNT_CHANGE,
        activity_id_value=int(activity),
        severity=severity,
        message=message,
        time_ms=time_ms,
        observables=observables,
        product=product,
        clock=clock,
    )
    return _m.AccountChange(**core, user=build_user(user))

build_patch_state 

build_patch_state(
    *,
    device: DeviceRef,
    severity: Severity,
    activity: PatchStateAction = LOG,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> PatchState

Build an OCSF Operating System Patch State (5004) event.

Requires device; OCSF also constrains "at least one of os.sp_name / os.sp_ver / os.version", so populate one of the os_* fields on the :class:DeviceRef.

Source code in src/ocsf_emitter/builders.py 
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
def build_patch_state(
    *,
    device: DeviceRef,
    severity: Severity,
    activity: PatchStateAction = PatchStateAction.LOG,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.PatchState:
    """Build an OCSF Operating System Patch State (5004) event.

    Requires ``device``; OCSF also constrains "at least one of os.sp_name /
    os.sp_ver / os.version", so populate one of the ``os_*`` fields on the
    :class:`DeviceRef`.
    """
    core = _core_fields(
        OcsfClass.PATCH_STATE,
        activity_id_value=int(activity),
        severity=severity,
        message=message,
        time_ms=time_ms,
        observables=observables,
        product=product,
        clock=clock,
    )
    return _m.PatchState(**core, device=build_device(device))

build_api_activity 

build_api_activity(
    *,
    api: ApiCall,
    severity: Severity,
    activity: ApiActivityAction = READ,
    src_endpoint: EndpointRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> ApiActivity

Build an OCSF API Activity (6003) event.

Requires api, actor, and src_endpoint -- an empty src_endpoint/actor is synthesized when not supplied so the OCSF base requirements hold; pass actor_user / src_endpoint to populate them.

Source code in src/ocsf_emitter/builders.py 
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
def build_api_activity(
    *,
    api: ApiCall,
    severity: Severity,
    activity: ApiActivityAction = ApiActivityAction.READ,
    src_endpoint: EndpointRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.ApiActivity:
    """Build an OCSF API Activity (6003) event.

    Requires ``api``, ``actor``, and ``src_endpoint`` -- an empty
    ``src_endpoint``/``actor`` is synthesized when not supplied so the OCSF base
    requirements hold; pass ``actor_user`` / ``src_endpoint`` to populate them.
    """
    core = _core_fields(
        OcsfClass.API_ACTIVITY,
        activity_id_value=int(activity),
        severity=severity,
        message=message,
        time_ms=time_ms,
        observables=observables,
        product=product,
        clock=clock,
    )
    return _m.ApiActivity(
        **core,
        api=build_api(api),
        actor=_actor(actor_user, product),
        src_endpoint=build_endpoint(src_endpoint),
    )

build_web_resources_activity 

build_web_resources_activity(
    *,
    web_resources: Sequence[WebResourceRef],
    severity: Severity,
    activity: WebResourcesActivityAction = READ,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> WebResourcesActivity

Build an OCSF Web Resources Activity (6001) event.

Requires web_resources (a non-empty list).

Source code in src/ocsf_emitter/builders.py 
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
def build_web_resources_activity(
    *,
    web_resources: Sequence[WebResourceRef],
    severity: Severity,
    activity: WebResourcesActivityAction = WebResourcesActivityAction.READ,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.WebResourcesActivity:
    """Build an OCSF Web Resources Activity (6001) event.

    Requires ``web_resources`` (a non-empty list).
    """
    core = _core_fields(
        OcsfClass.WEB_RESOURCES_ACTIVITY,
        activity_id_value=int(activity),
        severity=severity,
        message=message,
        time_ms=time_ms,
        observables=observables,
        product=product,
        clock=clock,
    )
    return _m.WebResourcesActivity(
        **core,
        web_resources=[build_web_resource(r) for r in web_resources],
    )

build_file_hosting 

build_file_hosting(
    *,
    file: FileRef,
    severity: Severity,
    activity: FileHostingAction = SHARE,
    src_endpoint: EndpointRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> FileHosting

Build an OCSF File Hosting Activity (6006) event.

Requires file, actor, and src_endpoint -- an empty actor/src_endpoint is synthesized when not supplied so the OCSF base requirements hold; pass actor_user / src_endpoint to populate them.

Source code in src/ocsf_emitter/builders.py 
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
def build_file_hosting(
    *,
    file: FileRef,
    severity: Severity,
    activity: FileHostingAction = FileHostingAction.SHARE,
    src_endpoint: EndpointRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.FileHosting:
    """Build an OCSF File Hosting Activity (6006) event.

    Requires ``file``, ``actor``, and ``src_endpoint`` -- an empty
    ``actor``/``src_endpoint`` is synthesized when not supplied so the OCSF base
    requirements hold; pass ``actor_user`` / ``src_endpoint`` to populate them.
    """
    core = _core_fields(
        OcsfClass.FILE_HOSTING,
        activity_id_value=int(activity),
        severity=severity,
        message=message,
        time_ms=time_ms,
        observables=observables,
        product=product,
        clock=clock,
    )
    return _m.FileHosting(
        **core,
        file=build_file(file),
        actor=_actor(actor_user, product),
        src_endpoint=build_endpoint(src_endpoint),
    )

build_compliance_finding 

build_compliance_finding(
    *,
    title: str,
    compliance: ComplianceRef,
    severity: Severity,
    activity: Activity = CREATE,
    uid: str | None = None,
    message: str | None = None,
    description: str | None = None,
    observables: Sequence[Observable] | None = None,
    data_sources: Sequence[str] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> ComplianceFinding

Build an OCSF Compliance Finding (2003) event.

Requires compliance (with at least one standard) and finding_info. Shares the Findings Activity vocabulary (Create/Update/Close).

Source code in src/ocsf_emitter/builders.py 
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
def build_compliance_finding(
    *,
    title: str,
    compliance: ComplianceRef,
    severity: Severity,
    activity: Activity = Activity.CREATE,
    uid: str | None = None,
    message: str | None = None,
    description: str | None = None,
    observables: Sequence[Observable] | None = None,
    data_sources: Sequence[str] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> _m.ComplianceFinding:
    """Build an OCSF Compliance Finding (2003) event.

    Requires ``compliance`` (with at least one standard) and ``finding_info``.
    Shares the Findings ``Activity`` vocabulary (Create/Update/Close).
    """
    core = _core_fields(
        OcsfClass.COMPLIANCE_FINDING,
        activity_id_value=defaults.activity_id_int(activity),
        severity=severity,
        message=message,
        time_ms=time_ms,
        observables=observables,
        product=product,
        clock=clock,
    )
    finding_info = _m.FindingInfo(
        uid=uid if uid is not None else uid_factory(),
        title=title,
        desc=description,
        data_sources=list(data_sources or []) or None,
    )
    return _m.ComplianceFinding(
        **core,
        finding_info=finding_info,
        compliance=build_compliance(compliance),
    )

build_file_activity 

build_file_activity(
    *,
    file: FileRef,
    severity: Severity,
    activity: FileActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> FileActivity

Build an OCSF File System Activity (1001) event.

Source code in src/ocsf_emitter/builders.py 
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
def build_file_activity(
    *,
    file: FileRef,
    severity: Severity,
    activity: FileActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.FileActivity:
    """Build an OCSF File System Activity (1001) event."""
    core = _core(
        OcsfClass.FILE_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.FileActivity(
        **core,
        actor=_actor(actor_user, product),
        device=build_device(device),
        file=build_file(file),
    )

build_kernel_extension_activity 

build_kernel_extension_activity(
    *,
    driver: KernelDriverRef,
    severity: Severity,
    activity: KernelExtensionActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> KernelExtensionActivity

Build an OCSF Kernel Extension Activity (1002) event.

Source code in src/ocsf_emitter/builders.py 
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
def build_kernel_extension_activity(
    *,
    driver: KernelDriverRef,
    severity: Severity,
    activity: KernelExtensionActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.KernelExtensionActivity:
    """Build an OCSF Kernel Extension Activity (1002) event."""
    core = _core(
        OcsfClass.KERNEL_EXTENSION_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.KernelExtensionActivity(
        **core,
        actor=_actor(actor_user, product),
        device=build_device(device),
        driver=build_kernel_driver(driver),
    )

build_kernel_activity 

build_kernel_activity(
    *,
    kernel: KernelRef,
    severity: Severity,
    activity: KernelActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> KernelActivity

Build an OCSF Kernel Activity (1003) event.

Source code in src/ocsf_emitter/builders.py 
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
def build_kernel_activity(
    *,
    kernel: KernelRef,
    severity: Severity,
    activity: KernelActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.KernelActivity:
    """Build an OCSF Kernel Activity (1003) event."""
    core = _core(
        OcsfClass.KERNEL_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.KernelActivity(
        **core,
        actor=_actor(actor_user, product),
        device=build_device(device),
        kernel=build_kernel(kernel),
    )

build_memory_activity 

build_memory_activity(
    *,
    process: ProcessRef,
    severity: Severity,
    activity: MemoryActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> MemoryActivity

Build an OCSF Memory Activity (1004) event.

Source code in src/ocsf_emitter/builders.py 
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
def build_memory_activity(
    *,
    process: ProcessRef,
    severity: Severity,
    activity: MemoryActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.MemoryActivity:
    """Build an OCSF Memory Activity (1004) event."""
    core = _core(
        OcsfClass.MEMORY_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.MemoryActivity(
        **core,
        actor=_actor(actor_user, product),
        device=build_device(device),
        process=build_process(process),
    )

build_module_activity 

build_module_activity(
    *,
    module: ModuleRef,
    severity: Severity,
    activity: ModuleActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> ModuleActivity

Build an OCSF Module Activity (1005) event.

Source code in src/ocsf_emitter/builders.py 
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
def build_module_activity(
    *,
    module: ModuleRef,
    severity: Severity,
    activity: ModuleActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.ModuleActivity:
    """Build an OCSF Module Activity (1005) event."""
    core = _core(
        OcsfClass.MODULE_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.ModuleActivity(
        **core,
        actor=_actor(actor_user, product),
        device=build_device(device),
        module=build_module(module),
    )

build_scheduled_job_activity 

build_scheduled_job_activity(
    *,
    job: JobRef,
    severity: Severity,
    activity: ScheduledJobActivityAction,
    device: DeviceRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> ScheduledJobActivity

Build an OCSF Scheduled Job Activity (1006) event.

Source code in src/ocsf_emitter/builders.py 
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
def build_scheduled_job_activity(
    *,
    job: JobRef,
    severity: Severity,
    activity: ScheduledJobActivityAction,
    device: DeviceRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.ScheduledJobActivity:
    """Build an OCSF Scheduled Job Activity (1006) event."""
    core = _core(
        OcsfClass.SCHEDULED_JOB_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.ScheduledJobActivity(**core, device=build_device(device), job=build_job(job))

build_process_activity 

build_process_activity(
    *,
    process: ProcessRef,
    severity: Severity,
    activity: ProcessActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> ProcessActivity

Build an OCSF Process Activity (1007) event.

Source code in src/ocsf_emitter/builders.py 
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
def build_process_activity(
    *,
    process: ProcessRef,
    severity: Severity,
    activity: ProcessActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.ProcessActivity:
    """Build an OCSF Process Activity (1007) event."""
    core = _core(
        OcsfClass.PROCESS_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.ProcessActivity(
        **core,
        actor=_actor(actor_user, product),
        device=build_device(device),
        process=build_process(process),
    )

build_event_log_activity 

build_event_log_activity(
    *,
    log_name: str,
    severity: Severity,
    activity: EventLogActvityAction,
    log_provider: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> EventLogActvity

Build an OCSF Event Log Activity (1008) event (requires a log identifier).

Source code in src/ocsf_emitter/builders.py 
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
def build_event_log_activity(
    *,
    log_name: str,
    severity: Severity,
    activity: EventLogActvityAction,
    log_provider: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.EventLogActvity:
    """Build an OCSF Event Log Activity (1008) event (requires a log identifier)."""
    core = _core(
        OcsfClass.EVENT_LOG_ACTVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.EventLogActvity(**core, log_name=log_name, log_provider=log_provider)

build_script_activity 

build_script_activity(
    *,
    script: ScriptRef,
    severity: Severity,
    activity: ScriptActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> ScriptActivity

Build an OCSF Script Activity (1009) event.

Source code in src/ocsf_emitter/builders.py 
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
def build_script_activity(
    *,
    script: ScriptRef,
    severity: Severity,
    activity: ScriptActivityAction,
    device: DeviceRef,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.ScriptActivity:
    """Build an OCSF Script Activity (1009) event."""
    core = _core(
        OcsfClass.SCRIPT_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.ScriptActivity(
        **core,
        actor=_actor(actor_user, product),
        device=build_device(device),
        script=build_script(script),
    )

build_vulnerability_finding 

build_vulnerability_finding(
    *,
    title: str,
    vulnerabilities: Sequence[VulnerabilityRef],
    severity: Severity,
    activity: VulnerabilityFindingAction,
    uid: str | None = None,
    description: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> VulnerabilityFinding

Build an OCSF Vulnerability Finding (2002) event.

Source code in src/ocsf_emitter/builders.py 
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
def build_vulnerability_finding(
    *,
    title: str,
    vulnerabilities: Sequence[VulnerabilityRef],
    severity: Severity,
    activity: VulnerabilityFindingAction,
    uid: str | None = None,
    description: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> _m.VulnerabilityFinding:
    """Build an OCSF Vulnerability Finding (2002) event."""
    core = _core(
        OcsfClass.VULNERABILITY_FINDING,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.VulnerabilityFinding(
        **core,
        finding_info=_finding_info(uid, title, description, uid_factory),
        vulnerabilities=[build_vulnerability(v) for v in vulnerabilities],
    )

build_incident_finding 

build_incident_finding(
    *,
    title: str,
    severity: Severity,
    activity: IncidentFindingAction,
    assignee: UserRef | None = None,
    assignee_group: GroupRef | None = None,
    status: Status = NEW,
    uid: str | None = None,
    description: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> IncidentFinding

Build an OCSF Incident Finding (2005) event (requires an assignee or assignee_group).

Source code in src/ocsf_emitter/builders.py 
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
def build_incident_finding(
    *,
    title: str,
    severity: Severity,
    activity: IncidentFindingAction,
    assignee: UserRef | None = None,
    assignee_group: GroupRef | None = None,
    status: Status = Status.NEW,
    uid: str | None = None,
    description: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> _m.IncidentFinding:
    """Build an OCSF Incident Finding (2005) event (requires an assignee or assignee_group)."""
    _at_least_one("assignee / assignee_group", assignee=assignee, assignee_group=assignee_group)
    core = _core(
        OcsfClass.INCIDENT_FINDING,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.IncidentFinding(
        **core,
        finding_info_list=[_finding_info(uid, title, description, uid_factory)],
        status_id=int(defaults.status_id(status)),
        assignee=build_user(assignee) if assignee is not None else None,
        assignee_group=build_group(assignee_group) if assignee_group is not None else None,
    )

build_data_security_finding 

build_data_security_finding(
    *,
    title: str,
    severity: Severity,
    activity: DataSecurityFindingAction,
    uid: str | None = None,
    description: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> DataSecurityFinding

Build an OCSF Data Security Finding (2006) event.

Source code in src/ocsf_emitter/builders.py 
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
def build_data_security_finding(
    *,
    title: str,
    severity: Severity,
    activity: DataSecurityFindingAction,
    uid: str | None = None,
    description: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> _m.DataSecurityFinding:
    """Build an OCSF Data Security Finding (2006) event."""
    core = _core(
        OcsfClass.DATA_SECURITY_FINDING,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.DataSecurityFinding(
        **core, finding_info=_finding_info(uid, title, description, uid_factory)
    )

build_application_security_posture_finding 

build_application_security_posture_finding(
    *,
    title: str,
    severity: Severity,
    activity: ApplicationSecurityPostureFindingAction,
    compliance: ComplianceRef | None = None,
    vulnerabilities: Sequence[VulnerabilityRef]
    | None = None,
    uid: str | None = None,
    description: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> ApplicationSecurityPostureFinding

Build an OCSF App Security Posture Finding (2007); needs compliance or vulnerabilities.

Source code in src/ocsf_emitter/builders.py 
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
def build_application_security_posture_finding(
    *,
    title: str,
    severity: Severity,
    activity: ApplicationSecurityPostureFindingAction,
    compliance: ComplianceRef | None = None,
    vulnerabilities: Sequence[VulnerabilityRef] | None = None,
    uid: str | None = None,
    description: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
    uid_factory: Callable[[], str] = _new_uid,
) -> _m.ApplicationSecurityPostureFinding:
    """Build an OCSF App Security Posture Finding (2007); needs compliance or vulnerabilities."""
    _at_least_one(
        "compliance / vulnerabilities", compliance=compliance, vulnerabilities=vulnerabilities
    )
    core = _core(
        OcsfClass.APPLICATION_SECURITY_POSTURE_FINDING,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.ApplicationSecurityPostureFinding(
        **core,
        finding_info=_finding_info(uid, title, description, uid_factory),
        compliance=build_compliance(compliance) if compliance is not None else None,
        vulnerabilities=(
            [build_vulnerability(v) for v in vulnerabilities] if vulnerabilities else None
        ),
    )

build_authorize_session 

build_authorize_session(
    *,
    user: UserRef,
    severity: Severity,
    activity: AuthorizeSessionAction,
    privileges: Sequence[str] | None = None,
    group: GroupRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> AuthorizeSession

Build an OCSF Authorize Session (3003) event (requires exactly one of privileges/group).

Source code in src/ocsf_emitter/builders.py 
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
def build_authorize_session(
    *,
    user: UserRef,
    severity: Severity,
    activity: AuthorizeSessionAction,
    privileges: Sequence[str] | None = None,
    group: GroupRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.AuthorizeSession:
    """Build an OCSF Authorize Session (3003) event (requires exactly one of privileges/group)."""
    _just_one("privileges / group", privileges=privileges, group=group)
    core = _core(
        OcsfClass.AUTHORIZE_SESSION,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.AuthorizeSession(
        **core,
        user=build_user(user),
        privileges=list(privileges) if privileges else None,
        group=build_group(group) if group is not None else None,
    )

build_entity_management 

build_entity_management(
    *,
    entity: ManagedEntityRef,
    severity: Severity,
    activity: EntityManagementAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> EntityManagement

Build an OCSF Entity Management (3004) event.

Source code in src/ocsf_emitter/builders.py 
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
def build_entity_management(
    *,
    entity: ManagedEntityRef,
    severity: Severity,
    activity: EntityManagementAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.EntityManagement:
    """Build an OCSF Entity Management (3004) event."""
    core = _core(
        OcsfClass.ENTITY_MANAGEMENT,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.EntityManagement(**core, entity=build_managed_entity(entity))

build_user_access 

build_user_access(
    *,
    user: UserRef,
    privileges: Sequence[str],
    severity: Severity,
    activity: UserAccessAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> UserAccess

Build an OCSF User Access Management (3005) event.

Source code in src/ocsf_emitter/builders.py 
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
def build_user_access(
    *,
    user: UserRef,
    privileges: Sequence[str],
    severity: Severity,
    activity: UserAccessAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.UserAccess:
    """Build an OCSF User Access Management (3005) event."""
    core = _core(
        OcsfClass.USER_ACCESS, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.UserAccess(**core, user=build_user(user), privileges=list(privileges))

build_group_management 

build_group_management(
    *,
    group: GroupRef,
    severity: Severity,
    activity: GroupManagementAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> GroupManagement

Build an OCSF Group Management (3006) event.

Source code in src/ocsf_emitter/builders.py 
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
def build_group_management(
    *,
    group: GroupRef,
    severity: Severity,
    activity: GroupManagementAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.GroupManagement:
    """Build an OCSF Group Management (3006) event."""
    core = _core(
        OcsfClass.GROUP_MANAGEMENT,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.GroupManagement(**core, group=build_group(group))

build_network_activity 

build_network_activity(
    *,
    severity: Severity,
    activity: NetworkActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> NetworkActivity

Build an OCSF Network Activity (4001) event (requires src or dst endpoint).

Source code in src/ocsf_emitter/builders.py 
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
def build_network_activity(
    *,
    severity: Severity,
    activity: NetworkActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.NetworkActivity:
    """Build an OCSF Network Activity (4001) event (requires src or dst endpoint)."""
    core = _core(
        OcsfClass.NETWORK_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.NetworkActivity(**core, src_endpoint=build_endpoint(src_endpoint))

build_http_activity 

build_http_activity(
    *,
    severity: Severity,
    activity: HttpActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> HttpActivity

Build an OCSF HTTP Activity (4002) event.

Source code in src/ocsf_emitter/builders.py 
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
def build_http_activity(
    *,
    severity: Severity,
    activity: HttpActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.HttpActivity:
    """Build an OCSF HTTP Activity (4002) event."""
    core = _core(
        OcsfClass.HTTP_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.HttpActivity(**core, http_request=_m.HttpRequest())

build_dns_activity 

build_dns_activity(
    *,
    severity: Severity,
    activity: DnsActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> DnsActivity

Build an OCSF DNS Activity (4003) event (requires src or dst endpoint).

Source code in src/ocsf_emitter/builders.py 
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
def build_dns_activity(
    *,
    severity: Severity,
    activity: DnsActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.DnsActivity:
    """Build an OCSF DNS Activity (4003) event (requires src or dst endpoint)."""
    core = _core(
        OcsfClass.DNS_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.DnsActivity(**core, src_endpoint=build_endpoint(src_endpoint))

build_dhcp_activity 

build_dhcp_activity(
    *,
    severity: Severity,
    activity: DhcpActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> DhcpActivity

Build an OCSF DHCP Activity (4004) event (requires src or dst endpoint).

Source code in src/ocsf_emitter/builders.py 
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
def build_dhcp_activity(
    *,
    severity: Severity,
    activity: DhcpActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.DhcpActivity:
    """Build an OCSF DHCP Activity (4004) event (requires src or dst endpoint)."""
    core = _core(
        OcsfClass.DHCP_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.DhcpActivity(**core, src_endpoint=build_endpoint(src_endpoint))

build_rdp_activity 

build_rdp_activity(
    *,
    severity: Severity,
    activity: RdpActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> RdpActivity

Build an OCSF RDP Activity (4005) event (requires src or dst endpoint).

Source code in src/ocsf_emitter/builders.py 
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
def build_rdp_activity(
    *,
    severity: Severity,
    activity: RdpActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.RdpActivity:
    """Build an OCSF RDP Activity (4005) event (requires src or dst endpoint)."""
    core = _core(
        OcsfClass.RDP_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.RdpActivity(**core, src_endpoint=build_endpoint(src_endpoint))

build_smb_activity 

build_smb_activity(
    *,
    severity: Severity,
    activity: SmbActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> SmbActivity

Build an OCSF SMB Activity (4006) event (requires src or dst endpoint).

Source code in src/ocsf_emitter/builders.py 
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
def build_smb_activity(
    *,
    severity: Severity,
    activity: SmbActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.SmbActivity:
    """Build an OCSF SMB Activity (4006) event (requires src or dst endpoint)."""
    core = _core(
        OcsfClass.SMB_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.SmbActivity(**core, src_endpoint=build_endpoint(src_endpoint))

build_ssh_activity 

build_ssh_activity(
    *,
    severity: Severity,
    activity: SshActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> SshActivity

Build an OCSF SSH Activity (4007) event (requires src or dst endpoint).

Source code in src/ocsf_emitter/builders.py 
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
def build_ssh_activity(
    *,
    severity: Severity,
    activity: SshActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.SshActivity:
    """Build an OCSF SSH Activity (4007) event (requires src or dst endpoint)."""
    core = _core(
        OcsfClass.SSH_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.SshActivity(**core, src_endpoint=build_endpoint(src_endpoint))

build_ftp_activity 

build_ftp_activity(
    *,
    severity: Severity,
    activity: FtpActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> FtpActivity

Build an OCSF FTP Activity (4008) event (requires src or dst endpoint).

Source code in src/ocsf_emitter/builders.py 
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
def build_ftp_activity(
    *,
    severity: Severity,
    activity: FtpActivityAction,
    src_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.FtpActivity:
    """Build an OCSF FTP Activity (4008) event (requires src or dst endpoint)."""
    core = _core(
        OcsfClass.FTP_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.FtpActivity(**core, src_endpoint=build_endpoint(src_endpoint))

build_email_activity 

build_email_activity(
    *,
    email: EmailRef,
    direction_id: int,
    severity: Severity,
    activity: EmailActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> EmailActivity

Build an OCSF Email Activity (4009) event (requires email + direction_id).

Source code in src/ocsf_emitter/builders.py 
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
def build_email_activity(
    *,
    email: EmailRef,
    direction_id: int,
    severity: Severity,
    activity: EmailActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.EmailActivity:
    """Build an OCSF Email Activity (4009) event (requires email + direction_id)."""
    core = _core(
        OcsfClass.EMAIL_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.EmailActivity(**core, email=build_email(email), direction_id=direction_id)

build_ntp_activity 

build_ntp_activity(
    *,
    version: str,
    src_endpoint: EndpointRef,
    severity: Severity,
    activity: NtpActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> NtpActivity

Build an OCSF NTP Activity (4013) event (requires version + src or dst endpoint).

Source code in src/ocsf_emitter/builders.py 
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
def build_ntp_activity(
    *,
    version: str,
    src_endpoint: EndpointRef,
    severity: Severity,
    activity: NtpActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.NtpActivity:
    """Build an OCSF NTP Activity (4013) event (requires version + src or dst endpoint)."""
    core = _core(
        OcsfClass.NTP_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.NtpActivity(**core, version=version, src_endpoint=build_endpoint(src_endpoint))

build_tunnel_activity 

build_tunnel_activity(
    *,
    src_endpoint: EndpointRef,
    severity: Severity,
    activity: TunnelActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> TunnelActivity

Build an OCSF Tunnel Activity (4014) event (requires a src_endpoint/session/…).

Source code in src/ocsf_emitter/builders.py 
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
def build_tunnel_activity(
    *,
    src_endpoint: EndpointRef,
    severity: Severity,
    activity: TunnelActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.TunnelActivity:
    """Build an OCSF Tunnel Activity (4014) event (requires a src_endpoint/session/…)."""
    core = _core(
        OcsfClass.TUNNEL_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.TunnelActivity(**core, src_endpoint=build_endpoint(src_endpoint))

build_inventory_info 

build_inventory_info(
    *,
    device: DeviceRef,
    severity: Severity,
    activity: InventoryInfoAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> InventoryInfo

Build an OCSF Device Inventory Info (5001) event.

Source code in src/ocsf_emitter/builders.py 
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
def build_inventory_info(
    *,
    device: DeviceRef,
    severity: Severity,
    activity: InventoryInfoAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.InventoryInfo:
    """Build an OCSF Device Inventory Info (5001) event."""
    core = _core(
        OcsfClass.INVENTORY_INFO, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.InventoryInfo(**core, device=build_device(device))

build_user_inventory 

build_user_inventory(
    *,
    user: UserRef,
    severity: Severity,
    activity: UserInventoryAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> UserInventory

Build an OCSF User Inventory Info (5003) event.

Source code in src/ocsf_emitter/builders.py 
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
def build_user_inventory(
    *,
    user: UserRef,
    severity: Severity,
    activity: UserInventoryAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.UserInventory:
    """Build an OCSF User Inventory Info (5003) event."""
    core = _core(
        OcsfClass.USER_INVENTORY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.UserInventory(**core, user=build_user(user))

build_device_config_state_change 

build_device_config_state_change(
    *,
    device: DeviceRef,
    severity: Severity,
    activity: DeviceConfigStateChangeAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> DeviceConfigStateChange

Build an OCSF Device Config State Change (5019) event.

Source code in src/ocsf_emitter/builders.py 
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
def build_device_config_state_change(
    *,
    device: DeviceRef,
    severity: Severity,
    activity: DeviceConfigStateChangeAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.DeviceConfigStateChange:
    """Build an OCSF Device Config State Change (5019) event."""
    core = _core(
        OcsfClass.DEVICE_CONFIG_STATE_CHANGE,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.DeviceConfigStateChange(**core, device=build_device(device))

build_software_info 

build_software_info(
    *,
    device: DeviceRef,
    severity: Severity,
    activity: SoftwareInfoAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> SoftwareInfo

Build an OCSF Software Inventory Info (5020) event.

Source code in src/ocsf_emitter/builders.py 
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
def build_software_info(
    *,
    device: DeviceRef,
    severity: Severity,
    activity: SoftwareInfoAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.SoftwareInfo:
    """Build an OCSF Software Inventory Info (5020) event."""
    core = _core(
        OcsfClass.SOFTWARE_INFO, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.SoftwareInfo(**core, device=build_device(device))

build_osint_inventory_info 

build_osint_inventory_info(
    *,
    osint: Sequence[OsintRef],
    severity: Severity,
    activity: OsintInventoryInfoAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> OsintInventoryInfo

Build an OCSF OSINT Inventory Info (5021) event.

Source code in src/ocsf_emitter/builders.py 
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
def build_osint_inventory_info(
    *,
    osint: Sequence[OsintRef],
    severity: Severity,
    activity: OsintInventoryInfoAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.OsintInventoryInfo:
    """Build an OCSF OSINT Inventory Info (5021) event."""
    core = _core(
        OcsfClass.OSINT_INVENTORY_INFO,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.OsintInventoryInfo(**core, osint=[build_osint(o) for o in osint])

build_cloud_resources_inventory_info 

build_cloud_resources_inventory_info(
    *,
    resources: Sequence[ResourceDetailsRef],
    severity: Severity,
    activity: CloudResourcesInventoryInfoAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> CloudResourcesInventoryInfo

Build an OCSF Cloud Resources Inventory Info (5023) event (requires resources/…).

Source code in src/ocsf_emitter/builders.py 
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
def build_cloud_resources_inventory_info(
    *,
    resources: Sequence[ResourceDetailsRef],
    severity: Severity,
    activity: CloudResourcesInventoryInfoAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.CloudResourcesInventoryInfo:
    """Build an OCSF Cloud Resources Inventory Info (5023) event (requires resources/…)."""
    _at_least_one("cloud_resources.resources", resources=list(resources))
    core = _core(
        OcsfClass.CLOUD_RESOURCES_INVENTORY_INFO,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.CloudResourcesInventoryInfo(
        **core, resources=[build_resource_details(r) for r in resources]
    )

build_evidence_info 

build_evidence_info(
    *,
    query_evidence: QueryEvidenceRef,
    query_result_id: int,
    severity: Severity,
    activity: EvidenceInfoAction,
    device: DeviceRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> EvidenceInfo

Build an OCSF Live Evidence Info (5040) event.

Source code in src/ocsf_emitter/builders.py 
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
def build_evidence_info(
    *,
    query_evidence: QueryEvidenceRef,
    query_result_id: int,
    severity: Severity,
    activity: EvidenceInfoAction,
    device: DeviceRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.EvidenceInfo:
    """Build an OCSF Live Evidence Info (5040) event."""
    core = _core(
        OcsfClass.EVIDENCE_INFO, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.EvidenceInfo(
        **core,
        device=build_device(device),
        query_evidence=build_query_evidence(query_evidence),
        query_result_id=query_result_id,
    )

build_application_lifecycle 

build_application_lifecycle(
    *,
    app_name: str,
    severity: Severity,
    activity: ApplicationLifecycleAction,
    app_version: str | None = None,
    app_vendor: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> ApplicationLifecycle

Build an OCSF Application Lifecycle (6002) event (app is an OCSF product).

Source code in src/ocsf_emitter/builders.py 
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
def build_application_lifecycle(
    *,
    app_name: str,
    severity: Severity,
    activity: ApplicationLifecycleAction,
    app_version: str | None = None,
    app_vendor: str | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.ApplicationLifecycle:
    """Build an OCSF Application Lifecycle (6002) event (``app`` is an OCSF product)."""
    core = _core(
        OcsfClass.APPLICATION_LIFECYCLE,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    app = _m.Product(name=app_name, version=app_version, vendor_name=app_vendor)
    return _m.ApplicationLifecycle(**core, app=app)

build_datastore_activity 

build_datastore_activity(
    *,
    database: DatabaseRef,
    src_endpoint: EndpointRef,
    severity: Severity,
    activity: DatastoreActivityAction,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> DatastoreActivity

Build an OCSF Datastore Activity (6005) event (requires a database/databucket/table).

Source code in src/ocsf_emitter/builders.py 
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
def build_datastore_activity(
    *,
    database: DatabaseRef,
    src_endpoint: EndpointRef,
    severity: Severity,
    activity: DatastoreActivityAction,
    actor_user: UserRef | None = None,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.DatastoreActivity:
    """Build an OCSF Datastore Activity (6005) event (requires a database/databucket/table)."""
    core = _core(
        OcsfClass.DATASTORE_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.DatastoreActivity(
        **core,
        actor=_actor(actor_user, product),
        src_endpoint=build_endpoint(src_endpoint),
        database=build_database(database),
    )

build_scan_activity 

build_scan_activity(
    *,
    scan: ScanRef,
    severity: Severity,
    activity: ScanActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> ScanActivity

Build an OCSF Scan Activity (6007) event.

Source code in src/ocsf_emitter/builders.py 
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
def build_scan_activity(
    *,
    scan: ScanRef,
    severity: Severity,
    activity: ScanActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.ScanActivity:
    """Build an OCSF Scan Activity (6007) event."""
    core = _core(
        OcsfClass.SCAN_ACTIVITY, activity, severity, message, observables, time_ms, product, clock
    )
    return _m.ScanActivity(**core, scan=build_scan(scan))

build_application_error 

build_application_error(
    *,
    severity: Severity,
    activity: ApplicationErrorAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> ApplicationError

Build an OCSF Application Error (6008) event.

Source code in src/ocsf_emitter/builders.py 
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
def build_application_error(
    *,
    severity: Severity,
    activity: ApplicationErrorAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.ApplicationError:
    """Build an OCSF Application Error (6008) event."""
    return _m.ApplicationError(
        **_core(
            OcsfClass.APPLICATION_ERROR,
            activity,
            severity,
            message,
            observables,
            time_ms,
            product,
            clock,
        )
    )

build_remediation_activity 

build_remediation_activity(
    *,
    command_uid: str,
    severity: Severity,
    activity: RemediationActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> RemediationActivity

Build an OCSF Remediation Activity (7001) event (requires command_uid).

Source code in src/ocsf_emitter/builders.py 
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
def build_remediation_activity(
    *,
    command_uid: str,
    severity: Severity,
    activity: RemediationActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.RemediationActivity:
    """Build an OCSF Remediation Activity (7001) event (requires command_uid)."""
    core = _core(
        OcsfClass.REMEDIATION_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.RemediationActivity(**core, command_uid=command_uid)

build_file_remediation_activity 

build_file_remediation_activity(
    *,
    command_uid: str,
    file: FileRef,
    severity: Severity,
    activity: FileRemediationActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> FileRemediationActivity

Build an OCSF File Remediation Activity (7002) event.

Source code in src/ocsf_emitter/builders.py 
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
def build_file_remediation_activity(
    *,
    command_uid: str,
    file: FileRef,
    severity: Severity,
    activity: FileRemediationActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.FileRemediationActivity:
    """Build an OCSF File Remediation Activity (7002) event."""
    core = _core(
        OcsfClass.FILE_REMEDIATION_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.FileRemediationActivity(**core, command_uid=command_uid, file=build_file(file))

build_process_remediation_activity 

build_process_remediation_activity(
    *,
    command_uid: str,
    process: ProcessRef,
    severity: Severity,
    activity: ProcessRemediationActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> ProcessRemediationActivity

Build an OCSF Process Remediation Activity (7003) event.

Source code in src/ocsf_emitter/builders.py 
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
def build_process_remediation_activity(
    *,
    command_uid: str,
    process: ProcessRef,
    severity: Severity,
    activity: ProcessRemediationActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.ProcessRemediationActivity:
    """Build an OCSF Process Remediation Activity (7003) event."""
    core = _core(
        OcsfClass.PROCESS_REMEDIATION_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.ProcessRemediationActivity(
        **core, command_uid=command_uid, process=build_process(process)
    )

build_network_remediation_activity 

build_network_remediation_activity(
    *,
    command_uid: str,
    connection_info: ConnectionInfoRef,
    severity: Severity,
    activity: NetworkRemediationActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> NetworkRemediationActivity

Build an OCSF Network Remediation Activity (7004) event.

Source code in src/ocsf_emitter/builders.py 
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
def build_network_remediation_activity(
    *,
    command_uid: str,
    connection_info: ConnectionInfoRef,
    severity: Severity,
    activity: NetworkRemediationActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.NetworkRemediationActivity:
    """Build an OCSF Network Remediation Activity (7004) event."""
    core = _core(
        OcsfClass.NETWORK_REMEDIATION_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.NetworkRemediationActivity(
        **core, command_uid=command_uid, connection_info=build_connection_info(connection_info)
    )

build_drone_flights_activity 

build_drone_flights_activity(
    *,
    uas: UasRef,
    operator: UserRef,
    severity: Severity,
    activity: DroneFlightsActivityAction,
    dst_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> DroneFlightsActivity

Build an OCSF Drone Flights Activity (8001) event.

Source code in src/ocsf_emitter/builders.py 
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
def build_drone_flights_activity(
    *,
    uas: UasRef,
    operator: UserRef,
    severity: Severity,
    activity: DroneFlightsActivityAction,
    dst_endpoint: EndpointRef,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.DroneFlightsActivity:
    """Build an OCSF Drone Flights Activity (8001) event."""
    core = _core(
        OcsfClass.DRONE_FLIGHTS_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.DroneFlightsActivity(
        **core,
        unmanned_aerial_system=build_uas(uas),
        unmanned_system_operator=build_user(operator),
        dst_endpoint=build_endpoint(dst_endpoint),
    )

build_airborne_broadcast_activity 

build_airborne_broadcast_activity(
    *,
    uas: UasRef,
    operator: UserRef,
    severity: Severity,
    activity: AirborneBroadcastActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> AirborneBroadcastActivity

Build an OCSF Airborne Broadcast Activity (8002) event.

Source code in src/ocsf_emitter/builders.py 
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
def build_airborne_broadcast_activity(
    *,
    uas: UasRef,
    operator: UserRef,
    severity: Severity,
    activity: AirborneBroadcastActivityAction,
    message: str | None = None,
    observables: Sequence[Observable] | None = None,
    time_ms: int | None = None,
    product: _m.Product | None = None,
    clock: Callable[[], int] = _now_ms,
) -> _m.AirborneBroadcastActivity:
    """Build an OCSF Airborne Broadcast Activity (8002) event."""
    core = _core(
        OcsfClass.AIRBORNE_BROADCAST_ACTIVITY,
        activity,
        severity,
        message,
        observables,
        time_ms,
        product,
        clock,
    )
    return _m.AirborneBroadcastActivity(
        **core,
        unmanned_aerial_system=build_uas(uas),
        unmanned_system_operator=build_user(operator),
    )