Skip to main content
Version: Next

Build

Represents an Actor build.

Builds compile Actor source code and prepare it for execution. Each build has a unique ID and can be tagged (e.g., 'latest', 'beta') for easy reference.

Hierarchy

  • Omit<Schemas[Build], keyof BuildRePointed>
  • BuildRePointed
    • Build

Index

Properties

Properties

inheritedactId

actId: string
janedoe~my-actor

optionalinheritedactorDefinition

actorDefinition?: null | ActorDefinition

optionalinheritedactVersion

actVersion?: { buildTag?: string; gitRepoUrl?: string; sourceFiles?: { content?: string; format?: BASE64 | TEXT; name: string }[]; sourceType?: GITHUB_GIST | GIT_REPO | SOURCE_CODE | SOURCE_FILES | TARBALL; versionNumber?: string }

BuildActVersion

Type declaration

  • optionalbuildTag?: string
    experimental
  • optionalgitRepoUrl?: string
    https://github.com/apifytech/actor-crawler.git#experimental:web-scraper

    URL of the git repository, present when sourceType is GIT_REPO.

  • optionalsourceFiles?: { content?: string; format?: BASE64 | TEXT; name: string }[]

    Inline source files, present when sourceType is SOURCE_FILES.

  • optionalsourceType?: GITHUB_GIST | GIT_REPO | SOURCE_CODE | SOURCE_FILES | TARBALL
  • optionalversionNumber?: string
    0.0

Snapshot of the Actor version that this build was created from.

inheritedbuildNumber

buildNumber: string
0.1.1

optionalinheritedfinishedAt

finishedAt?: null | Date

Format: date-time

2019-12-12T09:30:12.202Z

inheritedid

id: string
HG7ML7M8z78YcAPEB

optionalinheritedimageDigest

imageDigest?: null | string
1b2f1e8c0d5a4c7f9e3b6a2d8c4e0f7a5b9d3c1e6f8a2b4d0c7e9f1a3b5d7c9e

Digest of the built Docker image manifest, without the sha256: prefix. Compare digests of two builds to find out whether their image contents differ. null if the digest is not available.

optionalinheritedinputSchema

inputSchema?: null | string
{\n  "title": "Schema for ... }

This API is deprecated and may be removed in a future version.

inheritedmeta

meta: BuildMeta

optionalinheritedoptions

options?: null | BuildOptions

optionalinheritedreadme

readme?: null | string
# Magic Actor\nThis Actor is magic.

This API is deprecated and may be removed in a future version.

inheritedstartedAt

startedAt: Date

Format: date-time

2019-11-30T07:34:24.202Z

optionalinheritedstats

stats?: null | BuildStats

inheritedstatus

status: ValueOf<{ ABORTED: ABORTED; ABORTING: ABORTING; FAILED: FAILED; READY: READY; RUNNING: RUNNING; SUCCEEDED: SUCCEEDED; TIMED_OUT: TIMED-OUT; TIMING_OUT: TIMING-OUT }>

optionalinheritedusage

usage?: null | BuildUsage

optionalinheritedusageTotalUsd

usageTotalUsd?: null | number
0.02

Total cost in USD for this build. Requires authentication token to access.

optionalinheritedusageUsd

usageUsd?: null | BuildUsage

inheriteduserId

userId: string
klmdEpoiojmdEMlk3
Page Options