Skip to content

Commit 2f0f21d

Browse files
committed
Update models
1 parent 11b090a commit 2f0f21d

1 file changed

Lines changed: 87 additions & 7 deletions

File tree

src/apify_client/_models.py

Lines changed: 87 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# generated by datamodel-codegen:
22
# filename: openapi.json
3-
# timestamp: 2026-01-16T13:13:20+00:00
3+
# timestamp: 2026-01-16T18:57:38+00:00
44

55
from __future__ import annotations
66

@@ -980,16 +980,50 @@ class RunUsage(BaseModel):
980980

981981

982982
class Run(BaseModel):
983+
"""Represents an Actor run and its associated data."""
984+
983985
id: Annotated[str, Field(examples=['HG7ML7M8z78YcAPEB'])]
986+
"""
987+
Unique identifier of the Actor run.
988+
"""
984989
act_id: Annotated[str, Field(alias='actId', examples=['HDSasDasz78YcAPEB'])]
990+
"""
991+
ID of the Actor that was run.
992+
"""
985993
user_id: Annotated[str, Field(alias='userId', examples=['7sT5jcggjjA9fNcxF'])]
994+
"""
995+
ID of the user who started the run.
996+
"""
986997
actor_task_id: Annotated[str | None, Field(alias='actorTaskId', examples=['KJHSKHausidyaJKHs'])] = None
987-
started_at: Annotated[str, Field(alias='startedAt', examples=['2019-11-30T07:34:24.202Z'])]
988-
finished_at: Annotated[str | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])] = None
998+
"""
999+
ID of the Actor task, if the run was started from a task.
1000+
"""
1001+
started_at: Annotated[AwareDatetime, Field(alias='startedAt', examples=['2019-11-30T07:34:24.202Z'])]
1002+
"""
1003+
Time when the Actor run started.
1004+
"""
1005+
finished_at: Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])] = (
1006+
None
1007+
)
1008+
"""
1009+
Time when the Actor run finished.
1010+
"""
9891011
status: ActorJobStatus
1012+
"""
1013+
Current status of the Actor run.
1014+
"""
9901015
status_message: Annotated[str | None, Field(alias='statusMessage', examples=['Actor is running'])] = None
1016+
"""
1017+
Detailed message about the run status.
1018+
"""
9911019
is_status_message_terminal: Annotated[bool | None, Field(alias='isStatusMessageTerminal', examples=[False])] = None
1020+
"""
1021+
Whether the status message is terminal (final).
1022+
"""
9921023
meta: RunMeta
1024+
"""
1025+
Metadata about the Actor run.
1026+
"""
9931027
pricing_info: Annotated[
9941028
PayPerEventActorPricingInfo
9951029
| PricePerDatasetItemActorPricingInfo
@@ -998,32 +1032,78 @@ class Run(BaseModel):
9981032
| None,
9991033
Field(alias='pricingInfo', discriminator='pricing_model', title='ActorRunPricingInfo'),
10001034
] = None
1035+
"""
1036+
Pricing information for the Actor.
1037+
"""
10011038
stats: RunStats
1039+
"""
1040+
Statistics of the Actor run.
1041+
"""
10021042
charged_event_counts: Annotated[
10031043
dict[str, int] | None,
1004-
Field(
1005-
alias='chargedEventCounts', examples=[{'actor-start': 1, 'page-crawled': 150, 'data-extracted': 75}], ge=0
1006-
),
1044+
Field(alias='chargedEventCounts', examples=[{'actor-start': 1, 'page-crawled': 150, 'data-extracted': 75}]),
10071045
] = None
10081046
"""
10091047
A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run.
10101048
"""
10111049
options: RunOptions
1050+
"""
1051+
Configuration options for the Actor run.
1052+
"""
10121053
build_id: Annotated[str, Field(alias='buildId', examples=['7sT5jcggjjA9fNcxF'])]
1013-
exit_code: Annotated[float | None, Field(alias='exitCode', examples=[0])] = None
1054+
"""
1055+
ID of the Actor build used for this run.
1056+
"""
1057+
exit_code: Annotated[int | None, Field(alias='exitCode', examples=[0])] = None
1058+
"""
1059+
Exit code of the Actor run process.
1060+
"""
10141061
general_access: Annotated[GeneralAccessEnum, Field(alias='generalAccess')]
1062+
"""
1063+
General access level for the Actor run.
1064+
"""
10151065
default_key_value_store_id: Annotated[str, Field(alias='defaultKeyValueStoreId', examples=['eJNzqsbPiopwJcgGQ'])]
1066+
"""
1067+
ID of the default key-value store for this run.
1068+
"""
10161069
default_dataset_id: Annotated[str, Field(alias='defaultDatasetId', examples=['wmKPijuyDnPZAPRMk'])]
1070+
"""
1071+
ID of the default dataset for this run.
1072+
"""
10171073
default_request_queue_id: Annotated[str, Field(alias='defaultRequestQueueId', examples=['FL35cSF7jrxr3BY39'])]
1074+
"""
1075+
ID of the default request queue for this run.
1076+
"""
10181077
build_number: Annotated[str | None, Field(alias='buildNumber', examples=['0.0.36'])] = None
1078+
"""
1079+
Build number of the Actor build used for this run.
1080+
"""
10191081
container_url: Annotated[
10201082
str | None, Field(alias='containerUrl', examples=['https://g8kd8kbc5ge8.runs.apify.net'])
10211083
] = None
1084+
"""
1085+
URL of the container running the Actor.
1086+
"""
10221087
is_container_server_ready: Annotated[bool | None, Field(alias='isContainerServerReady', examples=[True])] = None
1088+
"""
1089+
Whether the container's HTTP server is ready to accept requests.
1090+
"""
10231091
git_branch_name: Annotated[str | None, Field(alias='gitBranchName', examples=['master'])] = None
1092+
"""
1093+
Name of the git branch used for the Actor build.
1094+
"""
10241095
usage: RunUsage | None = None
1096+
"""
1097+
Resource usage statistics for the run.
1098+
"""
10251099
usage_total_usd: Annotated[float | None, Field(alias='usageTotalUsd', examples=[0.2654])] = None
1100+
"""
1101+
Total cost of the run in USD.
1102+
"""
10261103
usage_usd: Annotated[RunUsage | None, Field(alias='usageUsd')] = None
1104+
"""
1105+
Resource usage costs in USD.
1106+
"""
10271107

10281108

10291109
class RunResponse(BaseModel):

0 commit comments

Comments
 (0)