# Builds ## List project builds `client.Builds.List(ctx, query) (*Page[Build], error)` **get** `/v0/builds` List user-triggered builds for a given project. An optional revision can be specified to filter by config commit SHA, or hashes of file contents. ### Parameters - `query BuildListParams` - `Project param.Field[string]` Project name - `Branch param.Field[string]` Branch name - `Cursor param.Field[string]` Pagination cursor from a previous response. - `Limit param.Field[float64]` Maximum number of builds to return, defaults to 10 (maximum: 100). - `Revision param.Field[BuildListParamsRevisionUnion]` A config commit SHA used for the build - `string` - `type BuildListParamsRevisionMap map[string, BuildListParamsRevisionMapItem]` Hash of the files used for the build - `Hash string` File content hash ### Returns - `type Build struct{…}` - `ID string` Build ID - `ConfigCommit string` - `CreatedAt Time` - `DocumentedSpec BuildDocumentedSpecUnion` - `type BuildDocumentedSpecObject struct{…}` - `Content string` - `Type string` - `const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"` - `type BuildDocumentedSpecObject struct{…}` - `Expires Time` - `Type string` - `const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"` - `URL string` - `Object BuildObject` - `const BuildObjectBuild BuildObject = "build"` - `Org string` - `Project string` - `Targets BuildTargets` - `Cli BuildTarget` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` - `Csharp BuildTarget` - `Go BuildTarget` - `Java BuildTarget` - `Kotlin BuildTarget` - `Node BuildTarget` - `OpenAPI BuildTarget` - `Php BuildTarget` - `Python BuildTarget` - `Ruby BuildTarget` - `Sql BuildTarget` - `Terraform BuildTarget` - `Typescript BuildTarget` - `UpdatedAt Time` ### Example ```go 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"), ) page, err := client.Builds.List(context.TODO(), stainless.BuildListParams{ Project: stainless.String("project"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "id": "id", "config_commit": "config_commit", "created_at": "2019-12-27T18:11:19.117Z", "documented_spec": { "content": "content", "type": "content" }, "object": "build", "org": "org", "project": "project", "targets": { "cli": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "csharp": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "go": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "java": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "kotlin": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "node": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "openapi": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "php": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "python": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "ruby": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "sql": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "terraform": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "typescript": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } } }, "updated_at": "2019-12-27T18:11:19.117Z" } ], "has_more": true, "next_cursor": "next_cursor" } ``` ## Create build `client.Builds.New(ctx, body) (*Build, error)` **post** `/v0/builds` Create a build, on top of a project branch, against a given input revision. The project branch will be modified so that its latest set of config files points to the one specified by the input revision. ### Parameters - `body BuildNewParams` - `Project param.Field[string]` Project name - `Revision param.Field[BuildNewParamsRevisionUnion]` Specifies what to build: a branch name, commit SHA, merge command ("base..head"), or file contents. - `string` - `type BuildNewParamsRevisionMap map[string, FileInputUnion]` File contents to commit directly - `FileInputContent` - `Content string` File content - `FileInputURL` - `URL string` URL to fetch file content from - `AllowEmpty param.Field[bool]` Whether to allow empty commits (no changes). Defaults to false. - `Branch param.Field[string]` The project branch to use for the build. If not specified, the branch is inferred from the `revision`, and will 400 when that is not possible. - `CommitMessage param.Field[string]` Optional commit message to use when creating a new commit. - `EnableAICommitMessage param.Field[bool]` Whether to generate AI-powered commit messages for the build. Cannot be combined with `commit_message` or `target_commit_messages`. - `TargetCommitMessages param.Field[BuildNewParamsTargetCommitMessages]` Optional commit messages to use for each SDK when making a new commit. SDKs not represented in this object will fallback to the optional `commit_message` parameter, or will fallback further to the default commit message. - `Cli string` - `Csharp string` - `Go string` - `Java string` - `Kotlin string` - `Node string` - `OpenAPI string` - `Php string` - `Python string` - `Ruby string` - `Sql string` - `Terraform string` - `Typescript string` - `Targets param.Field[[]Target]` Optional list of SDK targets to build. If not specified, all configured targets will be built. - `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 TargetSql Target = "sql"` - `const TargetOpenAPI Target = "openapi"` ### Returns - `type Build struct{…}` - `ID string` Build ID - `ConfigCommit string` - `CreatedAt Time` - `DocumentedSpec BuildDocumentedSpecUnion` - `type BuildDocumentedSpecObject struct{…}` - `Content string` - `Type string` - `const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"` - `type BuildDocumentedSpecObject struct{…}` - `Expires Time` - `Type string` - `const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"` - `URL string` - `Object BuildObject` - `const BuildObjectBuild BuildObject = "build"` - `Org string` - `Project string` - `Targets BuildTargets` - `Cli BuildTarget` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` - `Csharp BuildTarget` - `Go BuildTarget` - `Java BuildTarget` - `Kotlin BuildTarget` - `Node BuildTarget` - `OpenAPI BuildTarget` - `Php BuildTarget` - `Python BuildTarget` - `Ruby BuildTarget` - `Sql BuildTarget` - `Terraform BuildTarget` - `Typescript BuildTarget` - `UpdatedAt Time` ### Example ```go 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"), ) build, err := client.Builds.New(context.TODO(), stainless.BuildNewParams{ Project: stainless.String("project"), Revision: stainless.BuildNewParamsRevisionUnion{ OfString: stainless.String("string"), }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", build.ID) } ``` #### Response ```json { "id": "id", "config_commit": "config_commit", "created_at": "2019-12-27T18:11:19.117Z", "documented_spec": { "content": "content", "type": "content" }, "object": "build", "org": "org", "project": "project", "targets": { "cli": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "csharp": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "go": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "java": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "kotlin": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "node": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "openapi": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "php": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "python": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "ruby": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "sql": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "terraform": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "typescript": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } } }, "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Retrieve build `client.Builds.Get(ctx, buildID) (*Build, error)` **get** `/v0/builds/{buildId}` Retrieve a build by its ID. ### Parameters - `buildID string` Build ID ### Returns - `type Build struct{…}` - `ID string` Build ID - `ConfigCommit string` - `CreatedAt Time` - `DocumentedSpec BuildDocumentedSpecUnion` - `type BuildDocumentedSpecObject struct{…}` - `Content string` - `Type string` - `const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"` - `type BuildDocumentedSpecObject struct{…}` - `Expires Time` - `Type string` - `const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"` - `URL string` - `Object BuildObject` - `const BuildObjectBuild BuildObject = "build"` - `Org string` - `Project string` - `Targets BuildTargets` - `Cli BuildTarget` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` - `Csharp BuildTarget` - `Go BuildTarget` - `Java BuildTarget` - `Kotlin BuildTarget` - `Node BuildTarget` - `OpenAPI BuildTarget` - `Php BuildTarget` - `Python BuildTarget` - `Ruby BuildTarget` - `Sql BuildTarget` - `Terraform BuildTarget` - `Typescript BuildTarget` - `UpdatedAt Time` ### Example ```go 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"), ) build, err := client.Builds.Get(context.TODO(), "buildId") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", build.ID) } ``` #### Response ```json { "id": "id", "config_commit": "config_commit", "created_at": "2019-12-27T18:11:19.117Z", "documented_spec": { "content": "content", "type": "content" }, "object": "build", "org": "org", "project": "project", "targets": { "cli": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "csharp": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "go": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "java": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "kotlin": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "node": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "openapi": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "php": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "python": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "ruby": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "sql": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "terraform": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "typescript": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } } }, "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Creates two comparable builds `client.Builds.Compare(ctx, body) (*BuildCompareResponse, error)` **post** `/v0/builds/compare` Create two builds whose outputs can be directly compared with each other. Created builds _modify_ their project branches so that their latest sets of config files point to the ones specified by the input revision. This endpoint is useful because a build has more inputs than the set of config files it uses, so comparing two builds directly may return spurious differences. Builds made via this endpoint are guaranteed to have differences arising from the set of config files, and any custom code. ### Parameters - `body BuildCompareParams` - `Base param.Field[BuildCompareParamsBase]` Parameters for the base build - `Branch string` Branch to use. When using a branch name as revision, this must match or be omitted. - `Revision BuildCompareParamsBaseRevisionUnion` Specifies what to build: a branch name, a commit SHA, or file contents. - `string` - `type BuildCompareParamsBaseRevisionMap map[string, FileInputUnion]` File contents to commit directly - `FileInputContent` - `Content string` File content - `FileInputURL` - `URL string` URL to fetch file content from - `CommitMessage string` Optional commit message to use when creating a new commit. - `Head param.Field[BuildCompareParamsHead]` Parameters for the head build - `Branch string` Branch to use. When using a branch name as revision, this must match or be omitted. - `Revision BuildCompareParamsHeadRevisionUnion` Specifies what to build: a branch name, a commit SHA, or file contents. - `string` - `type BuildCompareParamsHeadRevisionMap map[string, FileInputUnion]` File contents to commit directly - `FileInputContent` - `FileInputURL` - `CommitMessage string` Optional commit message to use when creating a new commit. - `Project param.Field[string]` Project name - `Targets param.Field[[]Target]` Optional list of SDK targets to build. If not specified, all configured targets will be built. - `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 TargetSql Target = "sql"` - `const TargetOpenAPI Target = "openapi"` ### Returns - `type BuildCompareResponse struct{…}` - `Base Build` - `ID string` Build ID - `ConfigCommit string` - `CreatedAt Time` - `DocumentedSpec BuildDocumentedSpecUnion` - `type BuildDocumentedSpecObject struct{…}` - `Content string` - `Type string` - `const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"` - `type BuildDocumentedSpecObject struct{…}` - `Expires Time` - `Type string` - `const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"` - `URL string` - `Object BuildObject` - `const BuildObjectBuild BuildObject = "build"` - `Org string` - `Project string` - `Targets BuildTargets` - `Cli BuildTarget` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` - `Csharp BuildTarget` - `Go BuildTarget` - `Java BuildTarget` - `Kotlin BuildTarget` - `Node BuildTarget` - `OpenAPI BuildTarget` - `Php BuildTarget` - `Python BuildTarget` - `Ruby BuildTarget` - `Sql BuildTarget` - `Terraform BuildTarget` - `Typescript BuildTarget` - `UpdatedAt Time` - `Head Build` ### Example ```go 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"), ) response, err := client.Builds.Compare(context.TODO(), stainless.BuildCompareParams{ Base: stainless.BuildCompareParamsBase{ Branch: "branch", Revision: stainless.BuildCompareParamsBaseRevisionUnion{ OfString: stainless.String("string"), }, }, Head: stainless.BuildCompareParamsHead{ Branch: "branch", Revision: stainless.BuildCompareParamsHeadRevisionUnion{ OfString: stainless.String("string"), }, }, Project: stainless.String("project"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Base) } ``` #### Response ```json { "base": { "id": "id", "config_commit": "config_commit", "created_at": "2019-12-27T18:11:19.117Z", "documented_spec": { "content": "content", "type": "content" }, "object": "build", "org": "org", "project": "project", "targets": { "cli": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "csharp": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "go": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "java": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "kotlin": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "node": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "openapi": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "php": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "python": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "ruby": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "sql": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "terraform": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "typescript": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } } }, "updated_at": "2019-12-27T18:11:19.117Z" }, "head": { "id": "id", "config_commit": "config_commit", "created_at": "2019-12-27T18:11:19.117Z", "documented_spec": { "content": "content", "type": "content" }, "object": "build", "org": "org", "project": "project", "targets": { "cli": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "csharp": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "go": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "java": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "kotlin": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "node": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "openapi": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "php": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "python": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "ruby": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "sql": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "terraform": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "typescript": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } } }, "updated_at": "2019-12-27T18:11:19.117Z" } } ``` ## Domain Types ### Build - `type Build struct{…}` - `ID string` Build ID - `ConfigCommit string` - `CreatedAt Time` - `DocumentedSpec BuildDocumentedSpecUnion` - `type BuildDocumentedSpecObject struct{…}` - `Content string` - `Type string` - `const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"` - `type BuildDocumentedSpecObject struct{…}` - `Expires Time` - `Type string` - `const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"` - `URL string` - `Object BuildObject` - `const BuildObjectBuild BuildObject = "build"` - `Org string` - `Project string` - `Targets BuildTargets` - `Cli BuildTarget` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` - `Csharp BuildTarget` - `Go BuildTarget` - `Java BuildTarget` - `Kotlin BuildTarget` - `Node BuildTarget` - `OpenAPI BuildTarget` - `Php BuildTarget` - `Python BuildTarget` - `Ruby BuildTarget` - `Sql BuildTarget` - `Terraform BuildTarget` - `Typescript BuildTarget` - `UpdatedAt Time` ### Build Target - `type BuildTarget struct{…}` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` ### Check Step - `type CheckStepUnion interface{…}` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` # Diagnostics ## Get diagnostics for a build `client.Builds.Diagnostics.List(ctx, buildID, query) (*Page[BuildDiagnostic], error)` **get** `/v0/builds/{buildId}/diagnostics` Get the list of diagnostics for a given build. If no language targets are specified, diagnostics for all languages are returned. ### Parameters - `buildID string` Build ID - `query BuildDiagnosticListParams` - `Cursor param.Field[string]` Pagination cursor from a previous response - `Limit param.Field[float64]` Maximum number of diagnostics to return, defaults to 100 (maximum: 100) - `Severity param.Field[BuildDiagnosticListParamsSeverity]` Includes the given severity and above (fatal > error > warning > note). - `const BuildDiagnosticListParamsSeverityFatal BuildDiagnosticListParamsSeverity = "fatal"` - `const BuildDiagnosticListParamsSeverityError BuildDiagnosticListParamsSeverity = "error"` - `const BuildDiagnosticListParamsSeverityWarning BuildDiagnosticListParamsSeverity = "warning"` - `const BuildDiagnosticListParamsSeverityNote BuildDiagnosticListParamsSeverity = "note"` - `Targets param.Field[string]` Optional comma-delimited list of language targets to filter diagnostics by ### Returns - `type BuildDiagnostic struct{…}` - `Code string` The kind of diagnostic. - `Ignored bool` Whether the diagnostic is ignored in the Stainless config. - `Level BuildDiagnosticLevel` The severity of the diagnostic. - `const BuildDiagnosticLevelFatal BuildDiagnosticLevel = "fatal"` - `const BuildDiagnosticLevelError BuildDiagnosticLevel = "error"` - `const BuildDiagnosticLevelWarning BuildDiagnosticLevel = "warning"` - `const BuildDiagnosticLevelNote BuildDiagnosticLevel = "note"` - `Message string` A description of the diagnostic. - `More BuildDiagnosticMoreUnion` - `type BuildDiagnosticMoreMarkdown struct{…}` - `Markdown string` - `Type Markdown` - `const MarkdownMarkdown Markdown = "markdown"` - `type BuildDiagnosticMoreRaw struct{…}` - `Raw string` - `Type Raw` - `const RawRaw Raw = "raw"` - `ConfigRef string` A JSON pointer to a relevant field in the Stainless config. - `OasRef string` A JSON pointer to a relevant field in the OpenAPI spec. ### Example ```go 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"), ) page, err := client.Builds.Diagnostics.List( context.TODO(), "buildId", stainless.BuildDiagnosticListParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "code": "code", "ignored": true, "level": "fatal", "message": "message", "more": { "markdown": "markdown", "type": "markdown" }, "config_ref": "config_ref", "oas_ref": "oas_ref" } ], "has_more": true, "next_cursor": "next_cursor" } ``` ## Domain Types ### Build Diagnostic - `type BuildDiagnostic struct{…}` - `Code string` The kind of diagnostic. - `Ignored bool` Whether the diagnostic is ignored in the Stainless config. - `Level BuildDiagnosticLevel` The severity of the diagnostic. - `const BuildDiagnosticLevelFatal BuildDiagnosticLevel = "fatal"` - `const BuildDiagnosticLevelError BuildDiagnosticLevel = "error"` - `const BuildDiagnosticLevelWarning BuildDiagnosticLevel = "warning"` - `const BuildDiagnosticLevelNote BuildDiagnosticLevel = "note"` - `Message string` A description of the diagnostic. - `More BuildDiagnosticMoreUnion` - `type BuildDiagnosticMoreMarkdown struct{…}` - `Markdown string` - `Type Markdown` - `const MarkdownMarkdown Markdown = "markdown"` - `type BuildDiagnosticMoreRaw struct{…}` - `Raw string` - `Type Raw` - `const RawRaw Raw = "raw"` - `ConfigRef string` A JSON pointer to a relevant field in the Stainless config. - `OasRef string` A JSON pointer to a relevant field in the OpenAPI spec. ### Build Diagnostic More - `type BuildDiagnosticMoreUnion interface{…}` - `type BuildDiagnosticMoreMarkdown struct{…}` - `Markdown string` - `Type Markdown` - `const MarkdownMarkdown Markdown = "markdown"` - `type BuildDiagnosticMoreRaw struct{…}` - `Raw string` - `Type Raw` - `const RawRaw Raw = "raw"` # Target Outputs ## 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. ### Parameters - `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 BuildTargetOutputGetParamsTargetSql BuildTargetOutputGetParamsTarget = "sql"` - `const BuildTargetOutputGetParamsTargetOpenAPI BuildTargetOutputGetParamsTarget = "openapi"` - `Type param.Field[BuildTargetOutputGetParamsType]` - `const BuildTargetOutputGetParamsTypeSource BuildTargetOutputGetParamsType = "source"` - `const BuildTargetOutputGetParamsTypeDist BuildTargetOutputGetParamsType = "dist"` - `const BuildTargetOutputGetParamsTypeWheel BuildTargetOutputGetParamsType = "wheel"` - `const BuildTargetOutputGetParamsTypeOpenAPIWithTransforms BuildTargetOutputGetParamsType = "openapi-with-transforms"` - `const BuildTargetOutputGetParamsTypeOpenAPIWithCodeSamples BuildTargetOutputGetParamsType = "openapi-with-code-samples"` - `const BuildTargetOutputGetParamsTypeOpenAPISDKSpec BuildTargetOutputGetParamsType = "openapi-sdk-spec"` - `const BuildTargetOutputGetParamsTypeFile BuildTargetOutputGetParamsType = "file"` - `Output param.Field[BuildTargetOutputGetParamsOutput]` Output format: url (download URL) or git (temporary access token). - `const BuildTargetOutputGetParamsOutputURL BuildTargetOutputGetParamsOutput = "url"` - `const BuildTargetOutputGetParamsOutputGit BuildTargetOutputGetParamsOutput = "git"` - `Path param.Field[string]` The path of the file to get when used with "type": "file". ### Returns - `type BuildTargetOutputGetResponseUnion interface{…}` - `type BuildTargetOutputGetResponseURL struct{…}` - `Output URL` - `const URLURL URL = "url"` - `Target Target` - `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 TargetSql Target = "sql"` - `const TargetOpenAPI Target = "openapi"` - `Type BuildTargetOutputGetResponseURLType` - `const BuildTargetOutputGetResponseURLTypeSource BuildTargetOutputGetResponseURLType = "source"` - `const BuildTargetOutputGetResponseURLTypeDist BuildTargetOutputGetResponseURLType = "dist"` - `const BuildTargetOutputGetResponseURLTypeWheel BuildTargetOutputGetResponseURLType = "wheel"` - `const BuildTargetOutputGetResponseURLTypeOpenAPIWithTransforms BuildTargetOutputGetResponseURLType = "openapi-with-transforms"` - `const BuildTargetOutputGetResponseURLTypeOpenAPIWithCodeSamples BuildTargetOutputGetResponseURLType = "openapi-with-code-samples"` - `const BuildTargetOutputGetResponseURLTypeOpenAPISDKSpec BuildTargetOutputGetResponseURLType = "openapi-sdk-spec"` - `const BuildTargetOutputGetResponseURLTypeFile BuildTargetOutputGetResponseURLType = "file"` - `URL string` URL for direct download - `Path string` The path of the file, which is only present when using with the type "file" option. - `type BuildTargetOutputGetResponseGit struct{…}` - `Token string` Temporary GitHub access token - `Output Git` - `const GitGit Git = "git"` - `Ref string` Git reference (commit SHA, branch, or tag) - `Target Target` - `Type BuildTargetOutputGetResponseGitType` - `const BuildTargetOutputGetResponseGitTypeSource BuildTargetOutputGetResponseGitType = "source"` - `const BuildTargetOutputGetResponseGitTypeDist BuildTargetOutputGetResponseGitType = "dist"` - `const BuildTargetOutputGetResponseGitTypeWheel BuildTargetOutputGetResponseGitType = "wheel"` - `const BuildTargetOutputGetResponseGitTypeOpenAPIWithTransforms BuildTargetOutputGetResponseGitType = "openapi-with-transforms"` - `const BuildTargetOutputGetResponseGitTypeOpenAPIWithCodeSamples BuildTargetOutputGetResponseGitType = "openapi-with-code-samples"` - `const BuildTargetOutputGetResponseGitTypeOpenAPISDKSpec BuildTargetOutputGetResponseGitType = "openapi-sdk-spec"` - `const BuildTargetOutputGetResponseGitTypeFile BuildTargetOutputGetResponseGitType = "file"` - `URL string` URL to git remote ### Example ```go 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) } ``` #### Response ```json { "output": "url", "target": "node", "type": "source", "url": "url", "path": "path" } ```