Get build details

client.Builds.Get(ctx, id) (*Build, error)

get/builds/{id}

Get build details

ParametersExpand Collapse

id string

ReturnsExpand Collapse

type Build struct{…}

ID string

Build job identifier

CreatedAt Time

Build creation timestamp

formatdate-time

Status BuildStatus

Build job status

Accepts one of the following:

const BuildStatusQueued BuildStatus = "queued"

const BuildStatusBuilding BuildStatus = "building"

const BuildStatusPushing BuildStatus = "pushing"

const BuildStatusReady BuildStatus = "ready"

const BuildStatusFailed BuildStatus = "failed"

const BuildStatusCancelled BuildStatus = "cancelled"

BuilderInstanceID stringoptional

Instance ID of the builder VM (for debugging)

CompletedAt Timeoptional

Build completion timestamp

formatdate-time

DurationMs int64optional

Build duration in milliseconds

formatint64

Error stringoptional

Error message (only when status is failed)

ImageDigest stringoptional

Digest of built image (only when status is ready)

ImageRef stringoptional

Full image reference (only when status is ready)

Provenance BuildProvenanceoptional

BaseImageDigest stringoptional

Pinned base image digest used

BuildkitVersion stringoptional

BuildKit version used

LockfileHashes map[string, string]optional

Map of lockfile names to SHA256 hashes

SourceHash stringoptional

SHA256 hash of source tarball

Timestamp Timeoptional

Build completion timestamp

formatdate-time

QueuePosition int64optional

Position in build queue (only when status is queued)

StartedAt Timeoptional

Build start timestamp

formatdate-time

Get build details

package main

import (
  "context"
  "fmt"

  "github.com/kernel/hypeman-go"
  "github.com/kernel/hypeman-go/option"
)

func main() {
  client := hypeman.NewClient(
    option.WithAPIKey("My API Key"),
  )
  build, err := client.Builds.Get(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", build.ID)
}

{
  "id": "build-abc123",
  "created_at": "2019-12-27T18:11:19.117Z",
  "status": "queued",
  "builder_instance_id": "builder_instance_id",
  "completed_at": "2019-12-27T18:11:19.117Z",
  "duration_ms": 0,
  "error": "error",
  "image_digest": "image_digest",
  "image_ref": "image_ref",
  "provenance": {
    "base_image_digest": "base_image_digest",
    "buildkit_version": "buildkit_version",
    "lockfile_hashes": {
      "foo": "string"
    },
    "source_hash": "source_hash",
    "timestamp": "2019-12-27T18:11:19.117Z"
  },
  "queue_position": 0,
  "started_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "build-abc123",
  "created_at": "2019-12-27T18:11:19.117Z",
  "status": "queued",
  "builder_instance_id": "builder_instance_id",
  "completed_at": "2019-12-27T18:11:19.117Z",
  "duration_ms": 0,
  "error": "error",
  "image_digest": "image_digest",
  "image_ref": "image_ref",
  "provenance": {
    "base_image_digest": "base_image_digest",
    "buildkit_version": "buildkit_version",
    "lockfile_hashes": {
      "foo": "string"
    },
    "source_hash": "source_hash",
    "timestamp": "2019-12-27T18:11:19.117Z"
  },
  "queue_position": 0,
  "started_at": "2019-12-27T18:11:19.117Z"
}