\VHTRunJobsAPI

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

Method	HTTP request	Description
CancelVhtRunJob	Post /vht-run-jobs/{jobName}/cancel	Cancel a VHT run job.
DeleteVhtRunJob	Delete /vht-run-jobs/{jobName}	Delete an VHT run Job.
GetVhtRunJob	Get /vht-run-jobs/{jobName}	Return status of an VHT run Job.
GetVhtRunJobMessages	Get /vht-run-jobs/{jobName}/messages	VHT Run Job Message Feed.
ListVhtRunJobs	Get /vht-run-jobs/	List all run jobs on VHTs.

CancelVhtRunJob

VhtRunJobItem CancelVhtRunJob(ctx, jobName).AcceptVersion(acceptVersion).Execute()

Cancel a VHT run 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 VHT run 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.VHTRunJobsAPI.CancelVhtRunJob(context.Background(), jobName).AcceptVersion(acceptVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VHTRunJobsAPI.CancelVhtRunJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CancelVhtRunJob`: VhtRunJobItem
	fmt.Fprintf(os.Stdout, "Response from `VHTRunJobsAPI.CancelVhtRunJob`: %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 VHT run job.

Other Parameters

Other parameters are passed through a pointer to a apiCancelVhtRunJobRequest 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

VhtRunJobItem

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]

DeleteVhtRunJob

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

Delete an VHT run 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 VHT run 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.VHTRunJobsAPI.DeleteVhtRunJob(context.Background(), jobName).AcceptVersion(acceptVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VHTRunJobsAPI.DeleteVhtRunJob``: %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 VHT run job.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteVhtRunJobRequest 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]

GetVhtRunJob

VhtRunJobItem GetVhtRunJob(ctx, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()

Return status of an VHT run 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 VHT run 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.VHTRunJobsAPI.GetVhtRunJob(context.Background(), jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VHTRunJobsAPI.GetVhtRunJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetVhtRunJob`: VhtRunJobItem
	fmt.Fprintf(os.Stdout, "Response from `VHTRunJobsAPI.GetVhtRunJob`: %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 VHT run job.

Other Parameters

Other parameters are passed through a pointer to a apiGetVhtRunJobRequest 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

VhtRunJobItem

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]

GetVhtRunJobMessages

NotificationFeed GetVhtRunJobMessages(ctx, jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()

VHT Run Job 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 VHT run 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.VHTRunJobsAPI.GetVhtRunJobMessages(context.Background(), jobName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VHTRunJobsAPI.GetVhtRunJobMessages``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetVhtRunJobMessages`: NotificationFeed
	fmt.Fprintf(os.Stdout, "Response from `VHTRunJobsAPI.GetVhtRunJobMessages`: %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 VHT run job.

Other Parameters

Other parameters are passed through a pointer to a apiGetVhtRunJobMessagesRequest 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

NotificationFeed

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]

ListVhtRunJobs

VhtRunJobCollection ListVhtRunJobs(ctx).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()

List all run jobs on VHTs.

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.VHTRunJobsAPI.ListVhtRunJobs(context.Background()).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VHTRunJobsAPI.ListVhtRunJobs``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListVhtRunJobs`: VhtRunJobCollection
	fmt.Fprintf(os.Stdout, "Response from `VHTRunJobsAPI.ListVhtRunJobs`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListVhtRunJobsRequest 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

VhtRunJobCollection

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]

Files

VHTRunJobsAPI.md

Latest commit

History

VHTRunJobsAPI.md

File metadata and controls

\VHTRunJobsAPI

CancelVhtRunJob

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteVhtRunJob

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetVhtRunJob

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetVhtRunJobMessages

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListVhtRunJobs

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers