All URIs are relative to https://all.api.keil.arm.com
| Method | HTTP request | Description |
|---|---|---|
| CancelGenericWorkJob | Post /generic-work-jobs/{jobName}/cancel | Cancel an Generic Work Job. |
| DeleteGenericWorkJob | Delete /generic-work-jobs/{jobName} | Delete an Generic Work Job. |
| GetGenericWorkJob | Get /generic-work-jobs/{jobName} | Return status of an Generic Work Job. |
| GetGenericWorkJobArtefactManager | Get /generic-work-jobs/{jobName}/artefacts/{artefactName} | Get the Generic Work Job artefact manager for the artefact named `artefactName` present of job. |
| GetGenericWorkJobMessages | Get /generic-work-jobs/{jobName}/messages | GenericWorkJob Message Feed. |
| GetGenericWorkJobOutputArtefact | Get /generic-work-jobs/{jobName}/artefacts/{artefactName}/artefact | Download the artefact for the corresponding generic work job. |
| ListGenericWorkJobArtefactManagers | Get /generic-work-jobs/{jobName}/artefacts/ | Get the list of artefact managers for the given generic work job. |
| ListGenericWorkJobs | Get /generic-work-jobs/ | List all Generic Work Jobs. |
| RetainGenericWorkJob | Post /generic-work-jobs/{jobName}/retain | Update how long an generic work job will be retained before automatic deletion. |
GenericWorkJobItem CancelGenericWorkJob(ctx, jobName).AcceptVersion(acceptVersion).Execute()
Cancel an Generic Work Job.
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 generic work 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.GenericWorkJobsAPI.CancelGenericWorkJob(context.Background(), jobName).AcceptVersion(acceptVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkJobsAPI.CancelGenericWorkJob``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CancelGenericWorkJob`: GenericWorkJobItem
fmt.Fprintf(os.Stdout, "Response from `GenericWorkJobsAPI.CancelGenericWorkJob`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| jobName | string | Unique ID of the generic work Job. |
Other parameters are passed through a pointer to a apiCancelGenericWorkJobRequest 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. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteGenericWorkJob(ctx, jobName).AcceptVersion(acceptVersion).Execute()
Delete an Generic Work Job.
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 generic work 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.GenericWorkJobsAPI.DeleteGenericWorkJob(context.Background(), jobName).AcceptVersion(acceptVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkJobsAPI.DeleteGenericWorkJob``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| jobName | string | Unique ID of the generic work Job. |
Other parameters are passed through a pointer to a apiDeleteGenericWorkJobRequest 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. |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GenericWorkJobItem GetGenericWorkJob(ctx, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
Return status of an Generic Work Job.
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 generic work 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.GenericWorkJobsAPI.GetGenericWorkJob(context.Background(), jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkJobsAPI.GetGenericWorkJob``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGenericWorkJob`: GenericWorkJobItem
fmt.Fprintf(os.Stdout, "Response from `GenericWorkJobsAPI.GetGenericWorkJob`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| jobName | string | Unique ID of the generic work Job. |
Other parameters are passed through a pointer to a apiGetGenericWorkJobRequest 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. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ArtefactManagerItem GetGenericWorkJobArtefactManager(ctx, artefactName, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
Get the Generic Work Job artefact manager for the artefact named artefactName present of job.
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 generic work 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.GenericWorkJobsAPI.GetGenericWorkJobArtefactManager(context.Background(), artefactName, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkJobsAPI.GetGenericWorkJobArtefactManager``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGenericWorkJobArtefactManager`: ArtefactManagerItem
fmt.Fprintf(os.Stdout, "Response from `GenericWorkJobsAPI.GetGenericWorkJobArtefactManager`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| 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 generic work Job. |
Other parameters are passed through a pointer to a apiGetGenericWorkJobArtefactManagerRequest 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. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NotificationFeed GetGenericWorkJobMessages(ctx, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
GenericWorkJob Message Feed.
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 generic work 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.GenericWorkJobsAPI.GetGenericWorkJobMessages(context.Background(), jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkJobsAPI.GetGenericWorkJobMessages``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGenericWorkJobMessages`: NotificationFeed
fmt.Fprintf(os.Stdout, "Response from `GenericWorkJobsAPI.GetGenericWorkJobMessages`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| jobName | string | Unique ID of the generic work Job. |
Other parameters are passed through a pointer to a apiGetGenericWorkJobMessagesRequest 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]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
*os.File GetGenericWorkJobOutputArtefact(ctx, artefactName, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
Download the artefact for the corresponding generic work job.
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 generic work 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.GenericWorkJobsAPI.GetGenericWorkJobOutputArtefact(context.Background(), artefactName, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkJobsAPI.GetGenericWorkJobOutputArtefact``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGenericWorkJobOutputArtefact`: *os.File
fmt.Fprintf(os.Stdout, "Response from `GenericWorkJobsAPI.GetGenericWorkJobOutputArtefact`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| 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 generic work Job. |
Other parameters are passed through a pointer to a apiGetGenericWorkJobOutputArtefactRequest 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. |
- Content-Type: Not defined
- Accept: text/plain, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ArtefactManagerCollection ListGenericWorkJobArtefactManagers(ctx, jobName).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
Get the list of artefact managers for the given generic work job.
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 generic work 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.GenericWorkJobsAPI.ListGenericWorkJobArtefactManagers(context.Background(), jobName).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkJobsAPI.ListGenericWorkJobArtefactManagers``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListGenericWorkJobArtefactManagers`: ArtefactManagerCollection
fmt.Fprintf(os.Stdout, "Response from `GenericWorkJobsAPI.ListGenericWorkJobArtefactManagers`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| jobName | string | Unique ID of the generic work Job. |
Other parameters are passed through a pointer to a apiListGenericWorkJobArtefactManagersRequest 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]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GenericWorkJobCollection ListGenericWorkJobs(ctx).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
List all Generic Work Jobs.
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.GenericWorkJobsAPI.ListGenericWorkJobs(context.Background()).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkJobsAPI.ListGenericWorkJobs``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListGenericWorkJobs`: GenericWorkJobCollection
fmt.Fprintf(os.Stdout, "Response from `GenericWorkJobsAPI.ListGenericWorkJobs`: %v\n", resp)
}Other parameters are passed through a pointer to a apiListGenericWorkJobsRequest 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] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GenericWorkJobItem RetainGenericWorkJob(ctx, jobName).AcceptVersion(acceptVersion).RetainBuildJobRequest(retainBuildJobRequest).Execute()
Update how long an generic work job will be retained before automatic deletion.
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 generic work 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.GenericWorkJobsAPI.RetainGenericWorkJob(context.Background(), jobName).AcceptVersion(acceptVersion).RetainBuildJobRequest(retainBuildJobRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkJobsAPI.RetainGenericWorkJob``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RetainGenericWorkJob`: GenericWorkJobItem
fmt.Fprintf(os.Stdout, "Response from `GenericWorkJobsAPI.RetainGenericWorkJob`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| jobName | string | Unique ID of the generic work Job. |
Other parameters are passed through a pointer to a apiRetainGenericWorkJobRequest 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. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]