package
0.4.0
Repository: https://github.com/cisco-open/flame.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

AssertAgentStateRequired checks if the required fields are not zero-ed.
AssertBaseModelRequired checks if the required fields are not zero-ed.
AssertBasicJobInfoRequired checks if the required fields are not zero-ed.
AssertChannelGroupByRequired checks if the required fields are not zero-ed.
AssertChannelRequired checks if the required fields are not zero-ed.
AssertCodeApiResponseConstraints checks if the values respects the defined constraints.
AssertCodeApiResponseRequired checks if the required fields are not zero-ed.
AssertCommBackendRequired checks if the required fields are not zero-ed.
AssertComputeSpecRequired checks if the required fields are not zero-ed.
AssertComputeStateRequired checks if the required fields are not zero-ed.
AssertComputeStatusRequired checks if the required fields are not zero-ed.
AssertConnectorRequired checks if the required fields are not zero-ed.
AssertDatasetInfoRequired checks if the required fields are not zero-ed.
AssertDeploymentConfigRequired checks if the required fields are not zero-ed.
AssertDesignConstraints checks if the values respects the defined constraints.
AssertDesignInfoRequired checks if the required fields are not zero-ed.
AssertDesignRequired checks if the required fields are not zero-ed.
AssertDesignSchemaConstraints checks if the values respects the defined constraints.
AssertDesignSchemaRequired checks if the required fields are not zero-ed.
AssertErrorRequired checks if the required fields are not zero-ed.
AssertJobPriorityRequired checks if the required fields are not zero-ed.
AssertJobSpecConstraints checks if the values respects the defined constraints.
AssertJobSpecRequired checks if the required fields are not zero-ed.
AssertJobStateRequired checks if the required fields are not zero-ed.
AssertJobStatusRequired checks if the required fields are not zero-ed.
AssertModelSpecRequired checks if the required fields are not zero-ed.
AssertOptimizerRequired checks if the required fields are not zero-ed.
AssertRecurseAgentStateRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseBaseModelRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseBasicJobInfoRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseChannelGroupByRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseChannelRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseCommBackendRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseComputeSpecRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseComputeStateRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseComputeStatusRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseConnectorRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseDatasetInfoRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseDeploymentConfigRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseDesignInfoRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseErrorRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseInterfaceRequired recursively checks each struct in a slice against the callback.
AssertRecurseJobPriorityRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseJobStateRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseJobStatusRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseModelSpecRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseOptimizerRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseRoleDatasetGroupsRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseRoleRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseSelectorRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTaskInfoRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTaskStatusRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseValueRequired checks each struct in the nested slice against the callback.
AssertRoleDatasetGroupsRequired checks if the required fields are not zero-ed.
AssertRoleRequired checks if the required fields are not zero-ed.
AssertSelectorRequired checks if the required fields are not zero-ed.
AssertTaskInfoRequired checks if the required fields are not zero-ed.
AssertTaskStatusRequired checks if the required fields are not zero-ed.
DefaultErrorHandler defines the default logic on how to handle errors from the controller.
EncodeJSONResponse uses the json encoder to write an interface to the http response with an optional status code.
IsZeroValue checks if the val is the zero-ed value.
No description provided by the author
NewComputesApiController creates a default api controller.
NewDatasetsApiController creates a default api controller.
NewDesignCodeApiController creates a default api controller.
NewDesignsApiController creates a default api controller.
NewDesignSchemaApiController creates a default api controller.
NewJobsApiController creates a default api controller.
NewRouter creates a new router for any number of api routers.
ReadFormFilesToTempFiles reads files array data from a request form and writes it to a temporary files.
ReadFormFileToTempFile reads file data from a request form and writes it to a temporary file.
Response return a ImplResponse struct filled.
WithComputesApiErrorHandler inject ErrorHandler into controller.
WithDatasetsApiErrorHandler inject ErrorHandler into controller.
WithDesignCodeApiErrorHandler inject ErrorHandler into controller.
WithDesignsApiErrorHandler inject ErrorHandler into controller.
WithDesignSchemaApiErrorHandler inject ErrorHandler into controller.
WithJobsApiErrorHandler inject ErrorHandler into controller.

# Constants

List of AgentState.
List of AgentState.
List of AgentState.
List of AgentState.
List of JobState.
List of JobState.
List of JobState.
List of ComputeState.
List of JobState.
List of JobPriority.
List of JobPriority.
List of ComputeState.
List of JobPriority.
List of CommBackend.
List of CommBackend.
List of JobState.
List of JobState.
List of JobState.
List of JobState.
List of JobState.
List of ComputeState.

# Variables

ErrTypeAssertionError is thrown when type an interface does not match the asserted type.

# Structs

No description provided by the author
BasicJobInfo - Basic Job specification.
Channel - Defines how different roles are connected.
No description provided by the author
No description provided by the author
ComputesApiController binds http requests to an api service and writes the service results to the http response.
ComputeSpec - Compute specification.
ComputeStatus - Cluster compute status.
No description provided by the author
DatasetInfo - dataset meta information.
DatasetsApiController binds http requests to an api service and writes the service results to the http response.
DeploymentConfig - Deployment config for agents.
Design - Design template details along with a schema.
DesignCodeApiController binds http requests to an api service and writes the service results to the http response.
DesignInfo - Only basic desgin information.
DesignsApiController binds http requests to an api service and writes the service results to the http response.
DesignSchema - Schema to define the roles and their connections.
DesignSchemaApiController binds http requests to an api service and writes the service results to the http response.
Error - Generic error object.
ImplResponse response defines an error code with the associated body.
JobsApiController binds http requests to an api service and writes the service results to the http response.
JobSpec - Job specification.
JobStatus - Job status.
ModelSpec - Model specification.
No description provided by the author
ParsingError indicates that an error has occurred when parsing request parameters.
RequiredError indicates that an error has occurred when parsing request parameters.
Role - Define the role of a compute unit.
RoleDatasetGroups - Dataset specification.
A Route defines the parameters for an api endpoint.
No description provided by the author
TaskInfo - Task information.
TaskStatus - Task status.

# Interfaces

ComputesApiRouter defines the required methods for binding the api requests to a responses for the ComputesApi The ComputesApiRouter implementation should parse necessary information from the http request, pass the data to a ComputesApiServicer to perform the required actions, then write the service results to the http response.
ComputesApiServicer defines the api actions for the ComputesApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
DatasetsApiRouter defines the required methods for binding the api requests to a responses for the DatasetsApi The DatasetsApiRouter implementation should parse necessary information from the http request, pass the data to a DatasetsApiServicer to perform the required actions, then write the service results to the http response.
DatasetsApiServicer defines the api actions for the DatasetsApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
DesignCodeApiRouter defines the required methods for binding the api requests to a responses for the DesignCodeApi The DesignCodeApiRouter implementation should parse necessary information from the http request, pass the data to a DesignCodeApiServicer to perform the required actions, then write the service results to the http response.
DesignCodeApiServicer defines the api actions for the DesignCodeApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
DesignsApiRouter defines the required methods for binding the api requests to a responses for the DesignsApi The DesignsApiRouter implementation should parse necessary information from the http request, pass the data to a DesignsApiServicer to perform the required actions, then write the service results to the http response.
DesignsApiServicer defines the api actions for the DesignsApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
DesignSchemaApiRouter defines the required methods for binding the api requests to a responses for the DesignSchemaApi The DesignSchemaApiRouter implementation should parse necessary information from the http request, pass the data to a DesignSchemaApiServicer to perform the required actions, then write the service results to the http response.
DesignSchemaApiServicer defines the api actions for the DesignSchemaApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
JobsApiRouter defines the required methods for binding the api requests to a responses for the JobsApi The JobsApiRouter implementation should parse necessary information from the http request, pass the data to a JobsApiServicer to perform the required actions, then write the service results to the http response.
JobsApiServicer defines the api actions for the JobsApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
Router defines the required methods for retrieving api routes.

# Type aliases

No description provided by the author
No description provided by the author
ComputesApiOption for how the controller is set up.
No description provided by the author
DatasetsApiOption for how the controller is set up.
DesignCodeApiOption for how the controller is set up.
DesignsApiOption for how the controller is set up.
DesignSchemaApiOption for how the controller is set up.
ErrorHandler defines the required method for handling error.
No description provided by the author
JobsApiOption for how the controller is set up.
No description provided by the author
Routes are a collection of defined api endpoints.