exportinfo.py

"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""

from __future__ import annotations
from .dlpfindingfilter import DlpFindingFilter, DlpFindingFilterTypedDict
from .dlpperson import DlpPerson, DlpPersonTypedDict
from enum import Enum
from glean.api_client.types import BaseModel
import pydantic
from typing import Optional
from typing_extensions import Annotated, NotRequired, TypedDict


class ExportInfoStatus(str, Enum):
    r"""The status of the export"""

    PENDING = "PENDING"
    COMPLETED = "COMPLETED"
    FAILED = "FAILED"


class ExportInfoTypedDict(TypedDict):
    created_by: NotRequired[DlpPersonTypedDict]
    r"""Details about the person who created this report/policy."""
    start_time: NotRequired[str]
    r"""Timestamp at which this export started."""
    end_time: NotRequired[str]
    r"""Timestamp at which this export completed."""
    export_id: NotRequired[str]
    r"""The ID of the export"""
    file_name: NotRequired[str]
    r"""The name of the file to export the findings to"""
    filter_: NotRequired[DlpFindingFilterTypedDict]
    status: NotRequired[ExportInfoStatus]
    r"""The status of the export"""
    export_size: NotRequired[int]
    r"""The size of the exported file in bytes"""


class ExportInfo(BaseModel):
    created_by: Annotated[Optional[DlpPerson], pydantic.Field(alias="createdBy")] = None
    r"""Details about the person who created this report/policy."""

    start_time: Annotated[Optional[str], pydantic.Field(alias="startTime")] = None
    r"""Timestamp at which this export started."""

    end_time: Annotated[Optional[str], pydantic.Field(alias="endTime")] = None
    r"""Timestamp at which this export completed."""

    export_id: Annotated[Optional[str], pydantic.Field(alias="exportId")] = None
    r"""The ID of the export"""

    file_name: Annotated[Optional[str], pydantic.Field(alias="fileName")] = None
    r"""The name of the file to export the findings to"""

    filter_: Annotated[Optional[DlpFindingFilter], pydantic.Field(alias="filter")] = (
        None
    )

    status: Optional[ExportInfoStatus] = None
    r"""The status of the export"""

    export_size: Annotated[Optional[int], pydantic.Field(alias="exportSize")] = None
    r"""The size of the exported file in bytes"""