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
Copy file name to clipboardExpand all lines: client/docs/FPGAItem.md
+22-1Lines changed: 22 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,14 +21,15 @@ Name | Type | Description | Notes
21
21
**Name** | **string** | Unique ID of this FPGA | [readonly]
22
22
**Ready** | **bool** | True if this FPGA is ready to accept jobs to run. | [readonly]
23
23
**Repositories** | Pointer to [**FPGAPayloadRepositories**](FPGAPayloadRepositories.md) | | [optional]
24
+
**SupportedTargets** | [**[]FPGATarget**](FPGATarget.md) | A list of targets supported for this FPGA |
24
25
**Title** | **string** | Human readable name of the FPGA. |
25
26
**WorkerAuthToken** | Pointer to **string** | Hybrid RSA AES encoded worker authorisation token to use for authorising with the boundary controller | [optional]
26
27
27
28
## Methods
28
29
29
30
### NewFPGAItem
30
31
31
-
`func NewFPGAItem(links NullableFPGAItemLinks, metadata NullableCommonMetadata, busy bool, deprecated bool, description string, name string, ready bool, title string, ) *FPGAItem`
Copy file name to clipboardExpand all lines: client/docs/FPGAJobItem.md
+34-59Lines changed: 34 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,23 +16,23 @@ Name | Type | Description | Notes
16
16
**Error** | **bool** | True if there was an error in the service while attempting the job. | [readonly]
17
17
**Failure** | **bool** | True if the job failed (this should be used in conjunction with the `done` property). | [readonly]
18
18
**Name** | **string** | Unique ID of the FPGA job. | [readonly]
19
-
**Project** | Pointer to **string** | Identifier of the payload to run on the FPGA. | [optional]
20
-
**Queued** | Pointer to **bool** | True if job is currently queued and waiting to be processed. Otherwise, the job is either currently being processed or ended. | [optional][readonly]
19
+
**Queued** | **bool** | True if job is currently queued and waiting to be processed. Otherwise, the job is either currently being processed or ended. | [readonly]
21
20
**ReadyForConnection** | **bool** | True when the application running on the FPGA is ready to handle connections. If the job does not support connection, this flag will never be true. | [readonly]
22
21
**Status** | **string** | A summary status of the job. Note: this value should not be relied upon to determine whether a job has completed, succeeded or failed as this list may change as state machine evolves. Use resource appropriate flags instead. | [readonly]
23
22
**StepsCompleted** | **NullableInt32** | The number of steps that have been completed so far. Please note: - This value also includes additional service orchestration steps, that are outside the core process, so may differ from the job progress indicated within job messages. - This value will only be available after the job has been started. | [readonly]
24
23
**StepsTotal** | **NullableInt32** | The total number of steps that will need to be performed to complete the job. Please note: - This value also includes additional service orchestration steps, that are outside the core process, so may differ from the job progress indicated within job messages. - This value will only be available after the job has been started. | [readonly]
25
24
**Success** | **bool** | True if the job was successful (this should be used in conjunction with the `done` property). | [readonly]
26
25
**SupportConnection** | **bool** | True when the job allows direct connection to the job instance (application running on the FPGA). | [readonly]
26
+
**Target** | [**FPGATarget**](FPGATarget.md) | |
27
27
**Timeout** | Pointer to **int64** | The maximum time (in seconds) that the job will be allowed to run. After the timeout has expired the job will be aborted and reported as a failure. The timeout does not include any time the request spent being queued, waiting for the job to be started. | [optional][default to 300]
28
-
**Title** | Pointer to **NullableString** | Optional humanreadable name of the FPGA job. | [optional]
29
-
**Workspace** | Pointer to **NullableString** | Identifier of the workspace where the project is present. | [optional]
28
+
**Title** | Pointer to **NullableString** | Optional human-readable name of the FPGA job. | [optional]
NewFPGAJobItem instantiates a new FPGAJobItem object
38
38
This constructor will assign default values to properties that have it defined,
@@ -242,31 +242,6 @@ and a boolean to check if the value has been set.
242
242
SetName sets Name field to given value.
243
243
244
244
245
-
### GetProject
246
-
247
-
`func (o *FPGAJobItem) GetProject() string`
248
-
249
-
GetProject returns the Project field if non-nil, zero value otherwise.
250
-
251
-
### GetProjectOk
252
-
253
-
`func (o *FPGAJobItem) GetProjectOk() (*string, bool)`
254
-
255
-
GetProjectOk returns a tuple with the Project field if it's non-nil, zero value otherwise
256
-
and a boolean to check if the value has been set.
257
-
258
-
### SetProject
259
-
260
-
`func (o *FPGAJobItem) SetProject(v string)`
261
-
262
-
SetProject sets Project field to given value.
263
-
264
-
### HasProject
265
-
266
-
`func (o *FPGAJobItem) HasProject() bool`
267
-
268
-
HasProject returns a boolean if a field has been set.
269
-
270
245
### GetQueued
271
246
272
247
`func (o *FPGAJobItem) GetQueued() bool`
@@ -286,11 +261,6 @@ and a boolean to check if the value has been set.
286
261
287
262
SetQueued sets Queued field to given value.
288
263
289
-
### HasQueued
290
-
291
-
`func (o *FPGAJobItem) HasQueued() bool`
292
-
293
-
HasQueued returns a boolean if a field has been set.
294
264
295
265
### GetReadyForConnection
296
266
@@ -432,6 +402,26 @@ and a boolean to check if the value has been set.
432
402
SetSupportConnection sets SupportConnection field to given value.
433
403
434
404
405
+
### GetTarget
406
+
407
+
`func (o *FPGAJobItem) GetTarget() FPGATarget`
408
+
409
+
GetTarget returns the Target field if non-nil, zero value otherwise.
410
+
411
+
### GetTargetOk
412
+
413
+
`func (o *FPGAJobItem) GetTargetOk() (*FPGATarget, bool)`
414
+
415
+
GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise
416
+
and a boolean to check if the value has been set.
417
+
418
+
### SetTarget
419
+
420
+
`func (o *FPGAJobItem) SetTarget(v FPGATarget)`
421
+
422
+
SetTarget sets Target field to given value.
423
+
424
+
435
425
### GetTimeout
436
426
437
427
`func (o *FPGAJobItem) GetTimeout() int64`
@@ -492,41 +482,26 @@ HasTitle returns a boolean if a field has been set.
492
482
`func (o *FPGAJobItem) UnsetTitle()`
493
483
494
484
UnsetTitle ensures that no value is present for Title, not even an explicit nil
495
-
### GetWorkspace
485
+
### GetWorkload
496
486
497
-
`func (o *FPGAJobItem) GetWorkspace() string`
487
+
`func (o *FPGAJobItem) GetWorkload() FPGAWorkload`
498
488
499
-
GetWorkspace returns the Workspace field if non-nil, zero value otherwise.
489
+
GetWorkload returns the Workload field if non-nil, zero value otherwise.
500
490
501
-
### GetWorkspaceOk
491
+
### GetWorkloadOk
502
492
503
-
`func (o *FPGAJobItem) GetWorkspaceOk() (*string, bool)`
493
+
`func (o *FPGAJobItem) GetWorkloadOk() (*FPGAWorkload, bool)`
504
494
505
-
GetWorkspaceOk returns a tuple with the Workspace field if it's non-nil, zero value otherwise
495
+
GetWorkloadOk returns a tuple with the Workload field if it's non-nil, zero value otherwise
506
496
and a boolean to check if the value has been set.
507
497
508
-
### SetWorkspace
509
-
510
-
`func (o *FPGAJobItem) SetWorkspace(v string)`
511
-
512
-
SetWorkspace sets Workspace field to given value.
513
-
514
-
### HasWorkspace
515
-
516
-
`func (o *FPGAJobItem) HasWorkspace() bool`
517
-
518
-
HasWorkspace returns a boolean if a field has been set.
519
-
520
-
### SetWorkspaceNil
498
+
### SetWorkload
521
499
522
-
`func (o *FPGAJobItem) SetWorkspaceNil(b bool)`
500
+
`func (o *FPGAJobItem) SetWorkload(v FPGAWorkload)`
523
501
524
-
SetWorkspaceNil sets the value for Workspace to be an explicit nil
502
+
SetWorkload sets Workload field to given value.
525
503
526
-
### UnsetWorkspace
527
-
`func (o *FPGAJobItem) UnsetWorkspace()`
528
504
529
-
UnsetWorkspace ensures that no value is present for Workspace, not even an explicit nil
530
505
531
506
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
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)
0 commit comments