Download build target output

client.Builds.TargetOutputs.Get(ctx, query) (*BuildTargetOutputGetResponseUnion, error)

get/v0/build_target_outputs

Retrieve a method to download an output for a given build target.

If the requested type of output is source, and the requested output method is url, a download link to a tarball of the source files is returned. If the requested output method is git, a Git remote, ref, and access token (if necessary) is returned.

Otherwise, the possible types of outputs are specific to the requested target, and the output method must be url. See the documentation for type for more information.

ParametersExpand Collapse

query BuildTargetOutputGetParams

BuildID param.Field[string]

Build ID

Target param.Field[BuildTargetOutputGetParamsTarget]

SDK language target name

const BuildTargetOutputGetParamsTargetNode BuildTargetOutputGetParamsTarget = "node"

const BuildTargetOutputGetParamsTargetTypescript BuildTargetOutputGetParamsTarget = "typescript"

const BuildTargetOutputGetParamsTargetPython BuildTargetOutputGetParamsTarget = "python"

const BuildTargetOutputGetParamsTargetGo BuildTargetOutputGetParamsTarget = "go"

const BuildTargetOutputGetParamsTargetJava BuildTargetOutputGetParamsTarget = "java"

const BuildTargetOutputGetParamsTargetKotlin BuildTargetOutputGetParamsTarget = "kotlin"

const BuildTargetOutputGetParamsTargetRuby BuildTargetOutputGetParamsTarget = "ruby"

const BuildTargetOutputGetParamsTargetTerraform BuildTargetOutputGetParamsTarget = "terraform"

const BuildTargetOutputGetParamsTargetCli BuildTargetOutputGetParamsTarget = "cli"

const BuildTargetOutputGetParamsTargetPhp BuildTargetOutputGetParamsTarget = "php"

const BuildTargetOutputGetParamsTargetCsharp BuildTargetOutputGetParamsTarget = "csharp"

const BuildTargetOutputGetParamsTargetOpenAPI BuildTargetOutputGetParamsTarget = "openapi"

Type param.Field[BuildTargetOutputGetParamsType]

const BuildTargetOutputGetParamsTypeSource BuildTargetOutputGetParamsType = "source"

const BuildTargetOutputGetParamsTypeDist BuildTargetOutputGetParamsType = "dist"

const BuildTargetOutputGetParamsTypeWheel BuildTargetOutputGetParamsType = "wheel"

Output param.Field[BuildTargetOutputGetParamsOutput]optional

Output format: url (download URL) or git (temporary access token).

const BuildTargetOutputGetParamsOutputURL BuildTargetOutputGetParamsOutput = "url"

const BuildTargetOutputGetParamsOutputGit BuildTargetOutputGetParamsOutput = "git"

ReturnsExpand Collapse

type BuildTargetOutputGetResponseUnion interface{…}

Accepts one of the following:

type BuildTargetOutputGetResponseURL struct{…}

Output URL

Target Target

Accepts one of the following:

const TargetNode Target = "node"

const TargetTypescript Target = "typescript"

const TargetPython Target = "python"

const TargetGo Target = "go"

const TargetJava Target = "java"

const TargetKotlin Target = "kotlin"

const TargetRuby Target = "ruby"

const TargetTerraform Target = "terraform"

const TargetCli Target = "cli"

const TargetPhp Target = "php"

const TargetCsharp Target = "csharp"

const TargetOpenAPI Target = "openapi"

Type BuildTargetOutputGetResponseURLType

Accepts one of the following:

const BuildTargetOutputGetResponseURLTypeSource BuildTargetOutputGetResponseURLType = "source"

const BuildTargetOutputGetResponseURLTypeDist BuildTargetOutputGetResponseURLType = "dist"

const BuildTargetOutputGetResponseURLTypeWheel BuildTargetOutputGetResponseURLType = "wheel"

URL string

URL for direct download

type BuildTargetOutputGetResponseGit struct{…}

Token string

Temporary GitHub access token

Output Git

Ref string

Git reference (commit SHA, branch, or tag)

Target Target

Accepts one of the following:

const TargetNode Target = "node"

const TargetTypescript Target = "typescript"

const TargetPython Target = "python"

const TargetGo Target = "go"

const TargetJava Target = "java"

const TargetKotlin Target = "kotlin"

const TargetRuby Target = "ruby"

const TargetTerraform Target = "terraform"

const TargetCli Target = "cli"

const TargetPhp Target = "php"

const TargetCsharp Target = "csharp"

const TargetOpenAPI Target = "openapi"

Type BuildTargetOutputGetResponseGitType

Accepts one of the following:

const BuildTargetOutputGetResponseGitTypeSource BuildTargetOutputGetResponseGitType = "source"

const BuildTargetOutputGetResponseGitTypeDist BuildTargetOutputGetResponseGitType = "dist"

const BuildTargetOutputGetResponseGitTypeWheel BuildTargetOutputGetResponseGitType = "wheel"

URL string

URL to git remote

Download build target output

package main

import (
  "context"
  "fmt"

  "github.com/stainless-api/stainless-api-go"
  "github.com/stainless-api/stainless-api-go/option"
)

func main() {
  client := stainless.NewClient(
    option.WithAPIKey("My API Key"),
  )
  targetOutput, err := client.Builds.TargetOutputs.Get(context.TODO(), stainless.BuildTargetOutputGetParams{
    BuildID: "build_id",
    Target: stainless.BuildTargetOutputGetParamsTargetNode,
    Type: stainless.BuildTargetOutputGetParamsTypeSource,
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", targetOutput)
}

{
  "output": "url",
  "target": "node",
  "type": "source",
  "url": "url"
}

Returns Examples

{
  "output": "url",
  "target": "node",
  "type": "source",
  "url": "url"
}