All URIs are relative to http://localhost:3003/api/v1/dynamic
| Method | HTTP request | Description |
|---|---|---|
| GetArtifact | Get /artifacts/{artifactId} | Reads information about an artifact. |
| GetArtifactData | Get /artifacts/{artifactId}/data | Reads the data for an artifact. |
| GetBuild | Get /builds/{buildId} | Reads the current build graph for a build. |
| GetJob | Get /jobs/{jobId} | Reads information about a job. |
| GetJobGraph | Get /jobs/{jobId}/graph | Reads information about a job's graph. |
| GetLogData | Get /logs/{logDescriptorId}/data | Reads part of a log. |
| GetLogDescriptor | Get /logs/{logDescriptorId} | Fetches a Log Descriptor containing information about part of a log. |
| ListArtifacts | Get /builds/{buildId}/artifacts | Reads information about all or some artifacts from a build. |
| Ping | Get /ping | Checks for connectivity to the Dynamic API. |
Artifact GetArtifact(ctx, artifactId).Execute()
Reads information about an artifact.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/client"
)
func main() {
artifactId := "artifact:5238115e-070a-44fe-bce0-b43582583eff" // string | The ID of the artifact to read information about.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.BuildApi.GetArtifact(context.Background(), artifactId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BuildApi.GetArtifact``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetArtifact`: Artifact
fmt.Fprintf(os.Stdout, "Response from `BuildApi.GetArtifact`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| artifactId | string | The ID of the artifact to read information about. |
Other parameters are passed through a pointer to a apiGetArtifactRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
*os.File GetArtifactData(ctx, artifactId).Execute()
Reads the data for an artifact.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/client"
)
func main() {
artifactId := "artifact:5238115e-070a-44fe-bce0-b43582583eff" // string | The ID of the artifact to read information about.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.BuildApi.GetArtifactData(context.Background(), artifactId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BuildApi.GetArtifactData``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetArtifactData`: *os.File
fmt.Fprintf(os.Stdout, "Response from `BuildApi.GetArtifactData`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| artifactId | string | The ID of the artifact to read information about. |
Other parameters are passed through a pointer to a apiGetArtifactDataRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
BuildGraph GetBuild(ctx, buildId).Execute()
Reads the current build graph for a build.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/client"
)
func main() {
buildId := "build:4738115e-070a-44fe-bce0-b43582583eaa" // string | The ID of the build to read.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.BuildApi.GetBuild(context.Background(), buildId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BuildApi.GetBuild``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetBuild`: BuildGraph
fmt.Fprintf(os.Stdout, "Response from `BuildApi.GetBuild`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| buildId | string | The ID of the build to read. |
Other parameters are passed through a pointer to a apiGetBuildRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Job GetJob(ctx, jobId).Execute()
Reads information about a job.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/client"
)
func main() {
jobId := "job:5238115e-070a-44fe-bce0-b43582583eff" // string | The ID of the job to read.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.BuildApi.GetJob(context.Background(), jobId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BuildApi.GetJob``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetJob`: Job
fmt.Fprintf(os.Stdout, "Response from `BuildApi.GetJob`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| jobId | string | The ID of the job to read. |
Other parameters are passed through a pointer to a apiGetJobRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobGraph GetJobGraph(ctx, jobId).Execute()
Reads information about a job's graph.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/client"
)
func main() {
jobId := "job:5238115e-070a-44fe-bce0-b43582583eff" // string | The ID of the job to read.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.BuildApi.GetJobGraph(context.Background(), jobId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BuildApi.GetJobGraph``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetJobGraph`: JobGraph
fmt.Fprintf(os.Stdout, "Response from `BuildApi.GetJobGraph`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| jobId | string | The ID of the job to read. |
Other parameters are passed through a pointer to a apiGetJobGraphRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
*os.File GetLogData(ctx, logDescriptorId).Start(start).Plaintext(plaintext).Expand(expand).Execute()
Reads part of a log.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/client"
)
func main() {
logDescriptorId := "log-descriptor:5238115e-070a-44fe-bce0-b43582583eff" // string | A Log Descriptor ID identifying the part of the log to read data from.
start := int32(56) // int32 | If provided, only log entries with sequence numbers greater than or equal to start will be returned. Note that expand and start cannot both be specified. (optional)
plaintext := true // bool | True if the log data should be streamed as plain text, or false to stream a series of log entries as JSON. (optional)
expand := true // bool | True to expand nested log blocks in the returned data, or false to only include a summary. Note that expand and start cannot both be specified. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.BuildApi.GetLogData(context.Background(), logDescriptorId).Start(start).Plaintext(plaintext).Expand(expand).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BuildApi.GetLogData``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetLogData`: *os.File
fmt.Fprintf(os.Stdout, "Response from `BuildApi.GetLogData`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| logDescriptorId | string | A Log Descriptor ID identifying the part of the log to read data from. |
Other parameters are passed through a pointer to a apiGetLogDataRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
start | int32 | If provided, only log entries with sequence numbers greater than or equal to start will be returned. Note that expand and start cannot both be specified. | plaintext | bool | True if the log data should be streamed as plain text, or false to stream a series of log entries as JSON. | expand | bool | True to expand nested log blocks in the returned data, or false to only include a summary. Note that expand and start cannot both be specified. |
- Content-Type: Not defined
- Accept: application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LogDescriptor GetLogDescriptor(ctx, logDescriptorId).Execute()
Fetches a Log Descriptor containing information about part of a log.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/client"
)
func main() {
logDescriptorId := "log-descriptor:5238115e-070a-44fe-bce0-b43582583eff" // string | The ID of the log descriptor to read.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.BuildApi.GetLogDescriptor(context.Background(), logDescriptorId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BuildApi.GetLogDescriptor``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetLogDescriptor`: LogDescriptor
fmt.Fprintf(os.Stdout, "Response from `BuildApi.GetLogDescriptor`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| logDescriptorId | string | The ID of the log descriptor to read. |
Other parameters are passed through a pointer to a apiGetLogDescriptorRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ArtifactsPaginatedResponse ListArtifacts(ctx, buildId).Workflow(workflow).JobName(jobName).GroupName(groupName).Cursor(cursor).Limit(limit).Execute()
Reads information about all or some artifacts from a build.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/client"
)
func main() {
buildId := "build:4738115e-070a-44fe-bce0-b43582583eaa" // string | The ID of the build to read artifacts for.
workflow := "build-all" // string | If provided, only artifacts produced by this workflow will be returned. (optional)
jobName := "build-all" // string | If provided, only artifacts produced by this job will be returned. (optional)
groupName := "reports" // string | If provided, only artifacts associated with this artifact group name will be returned. This name much match the name provided in the build definition. (optional)
cursor := "cursor_example" // string | An opaque value obtained from a prior results page that can be used to request the next or previous page of results. If not specified then the first page of results will be returned. (optional)
limit := int32(56) // int32 | The maximum number of results to return from this call. Additional results will be available in other pages via the returned cursor values. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.BuildApi.ListArtifacts(context.Background(), buildId).Workflow(workflow).JobName(jobName).GroupName(groupName).Cursor(cursor).Limit(limit).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BuildApi.ListArtifacts``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListArtifacts`: ArtifactsPaginatedResponse
fmt.Fprintf(os.Stdout, "Response from `BuildApi.ListArtifacts`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| buildId | string | The ID of the build to read artifacts for. |
Other parameters are passed through a pointer to a apiListArtifactsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
workflow | string | If provided, only artifacts produced by this workflow will be returned. | jobName | string | If provided, only artifacts produced by this job will be returned. | groupName | string | If provided, only artifacts associated with this artifact group name will be returned. This name much match the name provided in the build definition. | cursor | string | An opaque value obtained from a prior results page that can be used to request the next or previous page of results. If not specified then the first page of results will be returned. | limit | int32 | The maximum number of results to return from this call. Additional results will be available in other pages via the returned cursor values. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Ping(ctx).Execute()
Checks for connectivity to the Dynamic API.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID/client"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.BuildApi.Ping(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BuildApi.Ping``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiPingRequest struct via the builder pattern
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]