You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*GenericWorkJobsAPI* | [**GetGenericWorkJob**](docs/GenericWorkJobsAPI.md#getgenericworkjob) | **Get** /generic-work-jobs/{jobName} | Return the status of a Generic Work Job.
198
199
*GenericWorkJobsAPI* | [**GetGenericWorkJobArtefactManager**](docs/GenericWorkJobsAPI.md#getgenericworkjobartefactmanager) | **Get** /generic-work-jobs/{jobName}/artefacts/{artefactName} | Get the job's artefact manager for the artefact named `artefactName`.
**CompleteGracePeriod** | Pointer to **int32** | The maximum time (in seconds) to use in the event that a graceful shutdown is requested. A graceful shutdown consists of a SIGINT being sent to the process, waiting the specified duration, and then finally sending a SIGKILL to the process. This should be chosen such that any cleanup actions have time to occur. | [optional][default to 30]
13
14
**Configuration** | Pointer to **map[string]string** | Configuration map for jobs that require it. These could be environment variables. This is job implementation dependent and job documentation should describe it. | [optional]
14
15
**Done** | **bool** | True when the job has completed (this does not necessarily indicate success). | [readonly]
15
16
**Error** | **bool** | True if there was an error in the service while attempting the job. | [readonly]
@@ -106,6 +107,31 @@ SetMetadata sets Metadata field to given value.
106
107
`func (o *GenericWorkJobItem) UnsetMetadata()`
107
108
108
109
UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil
110
+
### GetCompleteGracePeriod
111
+
112
+
`func (o *GenericWorkJobItem) GetCompleteGracePeriod() int32`
113
+
114
+
GetCompleteGracePeriod returns the CompleteGracePeriod field if non-nil, zero value otherwise.
115
+
116
+
### GetCompleteGracePeriodOk
117
+
118
+
`func (o *GenericWorkJobItem) GetCompleteGracePeriodOk() (*int32, bool)`
119
+
120
+
GetCompleteGracePeriodOk returns a tuple with the CompleteGracePeriod field if it's non-nil, zero value otherwise
121
+
and a boolean to check if the value has been set.
122
+
123
+
### SetCompleteGracePeriod
124
+
125
+
`func (o *GenericWorkJobItem) SetCompleteGracePeriod(v int32)`
126
+
127
+
SetCompleteGracePeriod sets CompleteGracePeriod field to given value.
128
+
129
+
### HasCompleteGracePeriod
130
+
131
+
`func (o *GenericWorkJobItem) HasCompleteGracePeriod() bool`
132
+
133
+
HasCompleteGracePeriod returns a boolean if a field has been set.
134
+
109
135
### GetConfiguration
110
136
111
137
`func (o *GenericWorkJobItem) GetConfiguration() map[string]string`
Copy file name to clipboardExpand all lines: client/docs/GenericWorkJobsAPI.md
+73Lines changed: 73 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,7 @@ All URIs are relative to *https://all.api.keil.arm.com*
9
9
Method | HTTP request | Description
10
10
------------- | ------------- | -------------
11
11
[**CancelGenericWorkJob**](GenericWorkJobsAPI.md#CancelGenericWorkJob) | **Post** /generic-work-jobs/{jobName}/cancel | Cancel a generic job.
12
+
[**CompleteGenericWorkJob**](GenericWorkJobsAPI.md#CompleteGenericWorkJob) | **Post** /generic-work-jobs/{jobName}/complete | Stop a generic job gracefully.
12
13
[**DeleteGenericWorkJob**](GenericWorkJobsAPI.md#DeleteGenericWorkJob) | **Delete** /generic-work-jobs/{jobName} | Delete a generic job.
13
14
[**GetGenericWorkJob**](GenericWorkJobsAPI.md#GetGenericWorkJob) | **Get** /generic-work-jobs/{jobName} | Return the status of a Generic Work Job.
14
15
[**GetGenericWorkJobArtefactManager**](GenericWorkJobsAPI.md#GetGenericWorkJobArtefactManager) | **Get** /generic-work-jobs/{jobName}/artefacts/{artefactName} | Get the job's artefact manager for the artefact named `artefactName`.
@@ -92,6 +93,78 @@ Name | Type | Description | Notes
jobName:="jobName_example"// string | Unique ID of the generic work Job.
118
+
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)
**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. |
149
+
150
+
### Return type
151
+
152
+
[**GenericWorkJobItem**](GenericWorkJobItem.md)
153
+
154
+
### Authorization
155
+
156
+
[TokenAuth](../README.md#TokenAuth)
157
+
158
+
### HTTP request headers
159
+
160
+
-**Content-Type**: Not defined
161
+
-**Accept**: application/json
162
+
163
+
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)
164
+
[[Back to Model list]](../README.md#documentation-for-models)
0 commit comments