Skip to content

VirtualHardwareTargetInstanceAPI.md

Latest commit

 

History

History
859 lines (566 loc) · 39.3 KB

VirtualHardwareTargetInstanceAPI.md

File metadata and controls

859 lines (566 loc) · 39.3 KB

\VirtualHardwareTargetInstanceAPI

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

Method HTTP request Description
ClearVhtInstanceArtefact Delete /vht-instances/{instanceName}/artefacts/{artefactName}/artefact Clear the VHT artefact from the VHT instance.
DeleteVhtInstance Delete /vht-instances/{instanceName} Delete a VHT instance
DownloadVhtInstanceArtefact Get /vht-instances/{instanceName}/artefacts/{artefactName}/artefact Download the artefact named `artefactName` present on this VHT instance.
GetVhtInstance Get /vht-instances/{instanceName} Return status of a VHT instance.
GetVhtInstanceArtefactManager Get /vht-instances/{instanceName}/artefacts/{artefactName} Get the VHT artefact manager for the artefact named `artefactName` present of this VHT instance.
GetVhtInstanceMessages Get /vht-instances/{instanceName}/messages Instance Message Feed.
ListVhtInstanceArtefactManagers Get /vht-instances/{instanceName}/artefacts/ List all the managers of the artefacts (e.g. binary, test input) available on a specific VHT instance.
ListVhtInstances Get /vht-instances/ List all VHT instances requested.
StartVhtRunJob Post /vht-instances/{instanceName} Starts a VHT Run job.
StopVhtInstance Post /vht-instances/{instanceName}/cancel Stop this VHT instance.
UploadVhtInstanceArtefact Put /vht-instances/{instanceName}/artefacts/{artefactName}/artefact Upload and replace the named VHT artefact on the given VHT instance.

ClearVhtInstanceArtefact

ClearVhtInstanceArtefact(ctx, artefactName, instanceName).AcceptVersion(acceptVersion).Execute()

Clear the VHT artefact from the VHT instance.

Example

package main

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

func main() {
	artefactName := "artefactName_example" // string | The URL safe name of the artefact.
	instanceName := "instanceName_example" // string | Unique ID of the VHT instance.
	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.VirtualHardwareTargetInstanceAPI.ClearVhtInstanceArtefact(context.Background(), artefactName, instanceName).AcceptVersion(acceptVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VirtualHardwareTargetInstanceAPI.ClearVhtInstanceArtefact``: %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.
artefactName string The URL safe name of the artefact.
instanceName string Unique ID of the VHT instance.

Other Parameters

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

DeleteVhtInstance

DeleteVhtInstance(ctx, instanceName).AcceptVersion(acceptVersion).Execute()

Delete a VHT instance

Example

package main

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

func main() {
	instanceName := "instanceName_example" // string | Unique ID of the VHT instance.
	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.VirtualHardwareTargetInstanceAPI.DeleteVhtInstance(context.Background(), instanceName).AcceptVersion(acceptVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VirtualHardwareTargetInstanceAPI.DeleteVhtInstance``: %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.
instanceName string Unique ID of the VHT instance.

Other Parameters

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

DownloadVhtInstanceArtefact

*os.File DownloadVhtInstanceArtefact(ctx, artefactName, instanceName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()

Download the artefact named artefactName present on this VHT instance.

Example

package main

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

func main() {
	artefactName := "artefactName_example" // string | The URL safe name of the artefact.
	instanceName := "instanceName_example" // string | Unique ID of the VHT instance.
	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.VirtualHardwareTargetInstanceAPI.DownloadVhtInstanceArtefact(context.Background(), artefactName, instanceName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VirtualHardwareTargetInstanceAPI.DownloadVhtInstanceArtefact``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadVhtInstanceArtefact`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `VirtualHardwareTargetInstanceAPI.DownloadVhtInstanceArtefact`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
artefactName string The URL safe name of the artefact.
instanceName string Unique ID of the VHT instance.

Other Parameters

Other parameters are passed through a pointer to a apiDownloadVhtInstanceArtefactRequest 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: application/octet-stream, application/json

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

GetVhtInstance

VhtInstanceItem GetVhtInstance(ctx, instanceName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()

Return status of a VHT instance.

Example

package main

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

func main() {
	instanceName := "instanceName_example" // string | Unique ID of the VHT instance.
	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.VirtualHardwareTargetInstanceAPI.GetVhtInstance(context.Background(), instanceName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VirtualHardwareTargetInstanceAPI.GetVhtInstance``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetVhtInstance`: VhtInstanceItem
	fmt.Fprintf(os.Stdout, "Response from `VirtualHardwareTargetInstanceAPI.GetVhtInstance`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceName string Unique ID of the VHT instance.

Other Parameters

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

VhtInstanceItem

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]

GetVhtInstanceArtefactManager

ArtefactManagerItem GetVhtInstanceArtefactManager(ctx, artefactName, instanceName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()

Get the VHT artefact manager for the artefact named artefactName present of this VHT instance.

Example

package main

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

func main() {
	artefactName := "artefactName_example" // string | The URL safe name of the artefact.
	instanceName := "instanceName_example" // string | Unique ID of the VHT instance.
	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.VirtualHardwareTargetInstanceAPI.GetVhtInstanceArtefactManager(context.Background(), artefactName, instanceName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VirtualHardwareTargetInstanceAPI.GetVhtInstanceArtefactManager``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetVhtInstanceArtefactManager`: ArtefactManagerItem
	fmt.Fprintf(os.Stdout, "Response from `VirtualHardwareTargetInstanceAPI.GetVhtInstanceArtefactManager`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
artefactName string The URL safe name of the artefact.
instanceName string Unique ID of the VHT instance.

Other Parameters

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

GetVhtInstanceMessages

NotificationFeed GetVhtInstanceMessages(ctx, instanceName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()

Instance Message Feed.

Example

package main

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

func main() {
	instanceName := "instanceName_example" // string | Unique ID of the VHT instance.
	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.VirtualHardwareTargetInstanceAPI.GetVhtInstanceMessages(context.Background(), instanceName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VirtualHardwareTargetInstanceAPI.GetVhtInstanceMessages``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetVhtInstanceMessages`: NotificationFeed
	fmt.Fprintf(os.Stdout, "Response from `VirtualHardwareTargetInstanceAPI.GetVhtInstanceMessages`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceName string Unique ID of the VHT instance.

Other Parameters

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

ListVhtInstanceArtefactManagers

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

List all the managers of the artefacts (e.g. binary, test input) available on a specific VHT instance.

Example

package main

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

func main() {
	instanceName := "instanceName_example" // string | Unique ID of the VHT instance.
	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.VirtualHardwareTargetInstanceAPI.ListVhtInstanceArtefactManagers(context.Background(), instanceName).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VirtualHardwareTargetInstanceAPI.ListVhtInstanceArtefactManagers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListVhtInstanceArtefactManagers`: ArtefactManagerCollection
	fmt.Fprintf(os.Stdout, "Response from `VirtualHardwareTargetInstanceAPI.ListVhtInstanceArtefactManagers`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceName string Unique ID of the VHT instance.

Other Parameters

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

ListVhtInstances

VhtInstanceCollection ListVhtInstances(ctx).AcceptVersion(acceptVersion).Embed(embed).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()

List all VHT instances requested.

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

Path Parameters

Other Parameters

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

VhtInstanceCollection

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]

StartVhtRunJob

VhtRunJobItem StartVhtRunJob(ctx, instanceName).VhtRunJobItem(vhtRunJobItem).AcceptVersion(acceptVersion).Execute()

Starts a VHT Run job.

Example

package main

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

func main() {
	instanceName := "instanceName_example" // string | Unique ID of the VHT instance.
	vhtRunJobItem := *openapiclient.NewVhtRunJobItem("TODO", "TODO", true, true, "332129b3-f14d-49d2-b9be-acd2abd80c6b", false, "PENDING", false, false) // VhtRunJobItem | A 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.VirtualHardwareTargetInstanceAPI.StartVhtRunJob(context.Background(), instanceName).VhtRunJobItem(vhtRunJobItem).AcceptVersion(acceptVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VirtualHardwareTargetInstanceAPI.StartVhtRunJob``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `StartVhtRunJob`: VhtRunJobItem
	fmt.Fprintf(os.Stdout, "Response from `VirtualHardwareTargetInstanceAPI.StartVhtRunJob`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceName string Unique ID of the VHT instance.

Other Parameters

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

Name Type Description Notes

vhtRunJobItem | VhtRunJobItem | A VHT run job. | 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: application/json
  • Accept: application/json

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

StopVhtInstance

VhtInstanceItem StopVhtInstance(ctx, instanceName).AcceptVersion(acceptVersion).Execute()

Stop this VHT instance.

Example

package main

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

func main() {
	instanceName := "instanceName_example" // string | Unique ID of the VHT instance.
	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.VirtualHardwareTargetInstanceAPI.StopVhtInstance(context.Background(), instanceName).AcceptVersion(acceptVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VirtualHardwareTargetInstanceAPI.StopVhtInstance``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `StopVhtInstance`: VhtInstanceItem
	fmt.Fprintf(os.Stdout, "Response from `VirtualHardwareTargetInstanceAPI.StopVhtInstance`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceName string Unique ID of the VHT instance.

Other Parameters

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

VhtInstanceItem

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]

UploadVhtInstanceArtefact

ArtefactManagerItem UploadVhtInstanceArtefact(ctx, artefactName, instanceName).IfMatch(ifMatch).Content(content).Hash(hash).AcceptVersion(acceptVersion).ContentMediaType(contentMediaType).Size(size).Title(title).Execute()

Upload and replace the named VHT artefact on the given VHT instance.

Example

package main

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

func main() {
	artefactName := "artefactName_example" // string | The URL safe name of the artefact.
	instanceName := "instanceName_example" // string | Unique ID of the VHT instance.
	ifMatch := "ifMatch_example" // string | Conditional Requests: This is required in order to perform an update of a resource. The value of this header should be the `ETag` of the resource when read (before being subsequently modified by the client).
	content := os.NewFile(1234, "some_file") // *os.File | artefact content
	hash := "hash_example" // string | Hash of the artefact (sha256) for network resilience
	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)
	contentMediaType := "contentMediaType_example" // string | Media type of the artefact according to https://www.iana.org/assignments/media-types/media-types.xhtml Technically redundant, but can be used by JSON Schema tools that may not be aware of the OpenAPI context. (optional)
	size := int64(789) // int64 | size in bytes of this artefact. Technically redundant, but can be used by JSON Schema tools that may not be aware of the OpenAPI context. (optional)
	title := "title_example" // string | Optional human readable name of the artefact. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.VirtualHardwareTargetInstanceAPI.UploadVhtInstanceArtefact(context.Background(), artefactName, instanceName).IfMatch(ifMatch).Content(content).Hash(hash).AcceptVersion(acceptVersion).ContentMediaType(contentMediaType).Size(size).Title(title).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VirtualHardwareTargetInstanceAPI.UploadVhtInstanceArtefact``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UploadVhtInstanceArtefact`: ArtefactManagerItem
	fmt.Fprintf(os.Stdout, "Response from `VirtualHardwareTargetInstanceAPI.UploadVhtInstanceArtefact`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
artefactName string The URL safe name of the artefact.
instanceName string Unique ID of the VHT instance.

Other Parameters

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

Name Type Description Notes

ifMatch | string | Conditional Requests: This is required in order to perform an update of a resource. The value of this header should be the `ETag` of the resource when read (before being subsequently modified by the client). | content | *os.File | artefact content | hash | string | Hash of the artefact (sha256) for network resilience | 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. | contentMediaType | string | Media type of the artefact according to https://www.iana.org/assignments/media-types/media-types.xhtml Technically redundant, but can be used by JSON Schema tools that may not be aware of the OpenAPI context. | size | int64 | size in bytes of this artefact. Technically redundant, but can be used by JSON Schema tools that may not be aware of the OpenAPI context. | title | string | Optional human readable name of the artefact. |

Return type

ArtefactManagerItem

Authorization

TokenAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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