All URIs are relative to https://all.api.keil.arm.com
| Method | HTTP request | Description |
|---|---|---|
| GetGenericWorker | Get /generic-workers/{genericWorkerName} | Return details of specific Generic Workers. |
| ListGenericWorkers | Get /generic-workers/ | List available Generic Workers. |
| StartGenericWorkJob | Post /generic-workers/{genericWorkerName} | Initiate a job using the specified Generic Worker. |
GenericWorkerItem GetGenericWorker(ctx, genericWorkerName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
Return details of specific Generic Workers.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)
func main() {
genericWorkerName := "genericWorkerName_example" // string | The ID of the Generic Worker.
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.GenericWorkersAPI.GetGenericWorker(context.Background(), genericWorkerName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkersAPI.GetGenericWorker``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGenericWorker`: GenericWorkerItem
fmt.Fprintf(os.Stdout, "Response from `GenericWorkersAPI.GetGenericWorker`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| genericWorkerName | string | The ID of the Generic Worker. |
Other parameters are passed through a pointer to a apiGetGenericWorkerRequest 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]
GenericWorkerCollection ListGenericWorkers(ctx).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
List available Generic Workers.
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.GenericWorkersAPI.ListGenericWorkers(context.Background()).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkersAPI.ListGenericWorkers``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListGenericWorkers`: GenericWorkerCollection
fmt.Fprintf(os.Stdout, "Response from `GenericWorkersAPI.ListGenericWorkers`: %v\n", resp)
}Other parameters are passed through a pointer to a apiListGenericWorkersRequest 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 StartGenericWorkJob(ctx, genericWorkerName).GenericWorkJobItem(genericWorkJobItem).AcceptVersion(acceptVersion).Execute()
Initiate a job using the specified Generic Worker.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)
func main() {
genericWorkerName := "genericWorkerName_example" // string | The ID of the Generic Worker.
genericWorkJobItem := *openapiclient.NewGenericWorkJobItem("TODO", "TODO", true, false, true, NullableInt32(50), NullableInt32(70), "332129b3-f14d-49d2-b9be-acd2abd80c6b", "INITIALISING", false) // GenericWorkJobItem | A generic work job to start.
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.GenericWorkersAPI.StartGenericWorkJob(context.Background(), genericWorkerName).GenericWorkJobItem(genericWorkJobItem).AcceptVersion(acceptVersion).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GenericWorkersAPI.StartGenericWorkJob``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `StartGenericWorkJob`: GenericWorkJobItem
fmt.Fprintf(os.Stdout, "Response from `GenericWorkersAPI.StartGenericWorkJob`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| genericWorkerName | string | The ID of the Generic Worker. |
Other parameters are passed through a pointer to a apiStartGenericWorkJobRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
genericWorkJobItem | GenericWorkJobItem | A generic work job to start. | 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: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]