GetEnginesResponse GetEngines(ctx, optional)
Get the list of engines deployed and available on aiWARE
Required Parameters
| Name | Type | Description | Notes |
|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetEnginesOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a GetEnginesOpts struct
|
| Name | Type | Description | Notes |
|---|
| xCorrelationId | optional.String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request | |
| internalApplicationID | optional.Interface of string | Internal ID of Application | |
| internalOrganizationID | optional.Interface of string | ID of Organization. UUID. This ID is unique to this aiWARE installation. | |
| engineName | optional.String | Field to string match against the engine names | |
| engineState | optional.Interface of EngineStateEnum | Field to match the current state | |
| engineType | optional.Interface of EngineTypeEnum | Field to match the current type | |
| engineOutputType | optional.Interface of EngineTypeEnum | Field to match the current type | |
| engineCategoryID | optional.String | Filter to the particular engine category ID | |
| engineIDs | optional.String | Field to provide the input to get engines by Engine ID list. Separated by commas | |
| offset | optional.Int64 | the number of data to skip before getting the result set | |
| limit | optional.Int64 | the number of items to return. | [default to 10] |
| direction | optional.String | the sort order. ASC or DESC. | [default to DESC] |
| startTime | optional.Int64 | The unix timestamp, describing the start time for the stats | |
| endTime | optional.Int64 | The unix timestamp, describing the end time for the stats | |
| preload | optional.Bool | Filter engines by preload | |
| orderBy | optional.String | The value should be in [name, state, type, organizationID, createdTime] |
Return type
GetEnginesResponse
Authorization
api_key
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
