\BuildJobsAPI

All URIs are relative to https://all.api.keil.arm.com

Method	HTTP request	Description
CancelBuildJob	Post /build-jobs/{jobName}/cancel	Cancel a Build Job
DeleteBuildJob	Delete /build-jobs/{jobName}	Delete a Build Job
GetBuildArtefact	Get /build-jobs/{jobName}/artefacts/{artefactName}	Download the named Build Artefact for the given Build Job.
GetBuildJob	Get /build-jobs/{jobName}	Return status of a Build Job.
GetBuildJobArtefactManager	Get /build-jobs/{jobName}/outputs/{artefactName}	Get the corresponding Build Job artefact manager.
GetBuildMessages	Get /build-jobs/{jobName}/messages	Build Message Feed.
GetBuildOutputArtefact	Get /build-jobs/{jobName}/outputs/{artefactName}/artefact	Download the build artefact for the given build job.
ListBuildArtefacts	Get /build-jobs/{jobName}/artefacts/	List all the available Build Artefacts for the given Build Job.
ListBuildJob	Get /build-jobs/	List all Build Jobs.
ListBuildOutputManagers	Get /build-jobs/{jobName}/outputs/	List all the available managers of Build Artefacts for the given Build Job.
RetainBuildJob	Post /build-jobs/{jobName}/retain	Update how long a build job will be retained before automatic deletion.

CancelBuildJob

BuildJobItem CancelBuildJob(ctx, jobName).AcceptVersion(acceptVersion).Execute()

Cancel a Build Job

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	jobName := "jobName_example" // string | Unique ID of the Build Job.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BuildJobsAPI.CancelBuildJob(context.Background(), jobName).AcceptVersion(acceptVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.CancelBuildJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CancelBuildJob`: BuildJobItem
	fmt.Fprintf(os.Stdout, "Response from `BuildJobsAPI.CancelBuildJob`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobName	string	Unique ID of the Build Job.

Other Parameters

Other parameters are passed through a pointer to a apiCancelBuildJobRequest struct via the builder pattern

Name	Type	Description	Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. |

Return type

BuildJobItem

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteBuildJob

DeleteBuildJob(ctx, jobName).AcceptVersion(acceptVersion).Execute()

Delete a Build Job

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	jobName := "jobName_example" // string | Unique ID of the Build Job.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.BuildJobsAPI.DeleteBuildJob(context.Background(), jobName).AcceptVersion(acceptVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.DeleteBuildJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobName	string	Unique ID of the Build Job.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteBuildJobRequest struct via the builder pattern

Name	Type	Description	Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. |

Return type

(empty response body)

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBuildArtefact

*os.File GetBuildArtefact(ctx, artefactName, jobName).AcceptVersion(acceptVersion).Execute()

Download the named Build Artefact for the given Build Job.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	artefactName := "artefactName_example" // string | Unique ID of a Job Artefact.
	jobName := "jobName_example" // string | Unique ID of the Build Job.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BuildJobsAPI.GetBuildArtefact(context.Background(), artefactName, jobName).AcceptVersion(acceptVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.GetBuildArtefact``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBuildArtefact`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `BuildJobsAPI.GetBuildArtefact`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
artefactName	string	Unique ID of a Job Artefact.
jobName	string	Unique ID of the Build Job.

Other Parameters

Other parameters are passed through a pointer to a apiGetBuildArtefactRequest struct via the builder pattern

Name	Type	Description	Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. |

Return type

*os.File

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBuildJob

BuildJobItem GetBuildJob(ctx, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()

Return status of a Build Job.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	jobName := "jobName_example" // string | Unique ID of the Build Job.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
	ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BuildJobsAPI.GetBuildJob(context.Background(), jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.GetBuildJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBuildJob`: BuildJobItem
	fmt.Fprintf(os.Stdout, "Response from `BuildJobsAPI.GetBuildJob`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobName	string	Unique ID of the Build Job.

Other Parameters

Other parameters are passed through a pointer to a apiGetBuildJobRequest struct via the builder pattern

Name	Type	Description	Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. | ifNoneMatch | string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. |

Return type

BuildJobItem

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBuildJobArtefactManager

ArtefactManagerItem GetBuildJobArtefactManager(ctx, artefactName, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()

Get the corresponding Build Job artefact manager.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	artefactName := "artefactName_example" // string | Unique ID of a Job Artefact.
	jobName := "jobName_example" // string | Unique ID of the Build Job.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
	ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BuildJobsAPI.GetBuildJobArtefactManager(context.Background(), artefactName, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.GetBuildJobArtefactManager``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBuildJobArtefactManager`: ArtefactManagerItem
	fmt.Fprintf(os.Stdout, "Response from `BuildJobsAPI.GetBuildJobArtefactManager`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
artefactName	string	Unique ID of a Job Artefact.
jobName	string	Unique ID of the Build Job.

Other Parameters

Other parameters are passed through a pointer to a apiGetBuildJobArtefactManagerRequest struct via the builder pattern

Name	Type	Description	Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. | ifNoneMatch | string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. |

Return type

ArtefactManagerItem

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBuildMessages

BuildMessageItem GetBuildMessages(ctx, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()

Build Message Feed.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	jobName := "jobName_example" // string | Unique ID of the Build Job.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
	ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)
	limit := int32(20) // int32 | Paging: The maximum number of items to return in a resource. (optional) (default to 20)
	offset := int32(0) // int32 | Paging:  The index of the first item to return in the resource. (optional) (default to 0)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BuildJobsAPI.GetBuildMessages(context.Background(), jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.GetBuildMessages``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBuildMessages`: BuildMessageItem
	fmt.Fprintf(os.Stdout, "Response from `BuildJobsAPI.GetBuildMessages`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobName	string	Unique ID of the Build Job.

Other Parameters

Other parameters are passed through a pointer to a apiGetBuildMessagesRequest struct via the builder pattern

Name	Type	Description	Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. | ifNoneMatch | string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. | limit | int32 | Paging: The maximum number of items to return in a resource. | [default to 20] offset | int32 | Paging: The index of the first item to return in the resource. | [default to 0]

Return type

BuildMessageItem

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBuildOutputArtefact

*os.File GetBuildOutputArtefact(ctx, artefactName, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()

Download the build artefact for the given build job.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	artefactName := "artefactName_example" // string | Unique ID of a Job Artefact.
	jobName := "jobName_example" // string | Unique ID of the Build Job.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
	ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BuildJobsAPI.GetBuildOutputArtefact(context.Background(), artefactName, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.GetBuildOutputArtefact``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBuildOutputArtefact`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `BuildJobsAPI.GetBuildOutputArtefact`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
artefactName	string	Unique ID of a Job Artefact.
jobName	string	Unique ID of the Build Job.

Other Parameters

Other parameters are passed through a pointer to a apiGetBuildOutputArtefactRequest struct via the builder pattern

Name	Type	Description	Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. | ifNoneMatch | string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. |

Return type

*os.File

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListBuildArtefacts

SimpleCollection ListBuildArtefacts(ctx, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()

List all the available Build Artefacts for the given Build Job.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	jobName := "jobName_example" // string | Unique ID of the Build Job.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
	ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)
	limit := int32(20) // int32 | Paging: The maximum number of items to return in a resource. (optional) (default to 20)
	offset := int32(0) // int32 | Paging:  The index of the first item to return in the resource. (optional) (default to 0)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BuildJobsAPI.ListBuildArtefacts(context.Background(), jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.ListBuildArtefacts``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListBuildArtefacts`: SimpleCollection
	fmt.Fprintf(os.Stdout, "Response from `BuildJobsAPI.ListBuildArtefacts`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobName	string	Unique ID of the Build Job.

Other Parameters

Other parameters are passed through a pointer to a apiListBuildArtefactsRequest struct via the builder pattern

Name	Type	Description	Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. | ifNoneMatch | string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. | limit | int32 | Paging: The maximum number of items to return in a resource. | [default to 20] offset | int32 | Paging: The index of the first item to return in the resource. | [default to 0]

Return type

SimpleCollection

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListBuildJob

BuildJobCollection ListBuildJob(ctx).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()

List all Build Jobs.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
	embed := false // bool | Embedding: The whether or not to embed resources into the collection (rather than return links). (optional) (default to false)
	ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)
	limit := int32(20) // int32 | Paging: The maximum number of items to return in a resource. (optional) (default to 20)
	offset := int32(0) // int32 | Paging:  The index of the first item to return in the resource. (optional) (default to 0)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BuildJobsAPI.ListBuildJob(context.Background()).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.ListBuildJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListBuildJob`: BuildJobCollection
	fmt.Fprintf(os.Stdout, "Response from `BuildJobsAPI.ListBuildJob`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListBuildJobRequest struct via the builder pattern

Name	Type	Description	Notes
acceptVersion	string	Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning.
embed	bool	Embedding: The whether or not to embed resources into the collection (rather than return links).	[default to false]
ifNoneMatch	string	Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content.
limit	int32	Paging: The maximum number of items to return in a resource.	[default to 20]
offset	int32	Paging: The index of the first item to return in the resource.	[default to 0]

Return type

BuildJobCollection

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListBuildOutputManagers

ArtefactManagerCollection ListBuildOutputManagers(ctx, jobName).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()

List all the available managers of Build Artefacts for the given Build Job.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	jobName := "jobName_example" // string | Unique ID of the Build Job.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
	embed := false // bool | Embedding: The whether or not to embed resources into the collection (rather than return links). (optional) (default to false)
	ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)
	limit := int32(20) // int32 | Paging: The maximum number of items to return in a resource. (optional) (default to 20)
	offset := int32(0) // int32 | Paging:  The index of the first item to return in the resource. (optional) (default to 0)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BuildJobsAPI.ListBuildOutputManagers(context.Background(), jobName).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.ListBuildOutputManagers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListBuildOutputManagers`: ArtefactManagerCollection
	fmt.Fprintf(os.Stdout, "Response from `BuildJobsAPI.ListBuildOutputManagers`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobName	string	Unique ID of the Build Job.

Other Parameters

Other parameters are passed through a pointer to a apiListBuildOutputManagersRequest struct via the builder pattern

Name	Type	Description	Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. | embed | bool | Embedding: The whether or not to embed resources into the collection (rather than return links). | [default to false] ifNoneMatch | string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. | limit | int32 | Paging: The maximum number of items to return in a resource. | [default to 20] offset | int32 | Paging: The index of the first item to return in the resource. | [default to 0]

Return type

ArtefactManagerCollection

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetainBuildJob

BuildJobItem RetainBuildJob(ctx, jobName).AcceptVersion(acceptVersion).RetainBuildJobRequest(retainBuildJobRequest).Execute()

Update how long a build job will be retained before automatic deletion.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	jobName := "jobName_example" // string | Unique ID of the Build Job.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
	retainBuildJobRequest := *openapiclient.NewRetainBuildJobRequest() // RetainBuildJobRequest | TTL configuration. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BuildJobsAPI.RetainBuildJob(context.Background(), jobName).AcceptVersion(acceptVersion).RetainBuildJobRequest(retainBuildJobRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BuildJobsAPI.RetainBuildJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RetainBuildJob`: BuildJobItem
	fmt.Fprintf(os.Stdout, "Response from `BuildJobsAPI.RetainBuildJob`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobName	string	Unique ID of the Build Job.

Other Parameters

Other parameters are passed through a pointer to a apiRetainBuildJobRequest struct via the builder pattern

Name	Type	Description	Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. | retainBuildJobRequest | RetainBuildJobRequest | TTL configuration. |

Return type

BuildJobItem

Authorization

TokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

BuildJobsAPI.md

Latest commit

History

BuildJobsAPI.md

File metadata and controls

\BuildJobsAPI

CancelBuildJob

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteBuildJob

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetBuildArtefact

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetBuildJob

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetBuildJobArtefactManager

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetBuildMessages

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetBuildOutputArtefact

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListBuildArtefacts

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListBuildJob

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListBuildOutputManagers

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RetainBuildJob

Example

Path Parameters