Documentation ¶
Index ¶
- func NewComputesApiService(dbService database.DBService, jobParams config.JobParams) openapi.ComputesApiServicer
- func NewDatasetsApiService(dbService database.DBService) openapi.DatasetsApiServicer
- func NewDesignCodeApiService(dbService database.DBService) openapi.DesignCodeApiServicer
- func NewDesignSchemaApiService(dbService database.DBService) openapi.DesignSchemaApiServicer
- func NewDesignsApiService(dbService database.DBService) openapi.DesignsApiServicer
- func NewJobsApiService(dbService database.DBService, jobEventQ *job.EventQ, ...) openapi.JobsApiServicer
- type ComputesApiService
- func (s *ComputesApiService) DeleteCompute(ctx context.Context, computeId string, xAPIKEY string) (openapi.ImplResponse, error)
- func (s *ComputesApiService) GetComputeConfig(ctx context.Context, computeId string, xAPIKEY string) (openapi.ImplResponse, error)
- func (s *ComputesApiService) GetComputeStatus(ctx context.Context, computeId string, xAPIKEY string) (openapi.ImplResponse, error)
- func (s *ComputesApiService) GetDeploymentConfig(ctx context.Context, computeId string, jobId string, xAPIKEY string) (openapi.ImplResponse, error)
- func (s *ComputesApiService) GetDeploymentStatus(ctx context.Context, computeId string, jobId string, xAPIKEY string) (openapi.ImplResponse, error)
- func (s *ComputesApiService) GetDeployments(ctx context.Context, computeId string, xAPIKEY string) (openapi.ImplResponse, error)
- func (s *ComputesApiService) PutDeploymentStatus(ctx context.Context, computeId string, jobId string, xAPIKEY string, ...) (openapi.ImplResponse, error)
- func (s *ComputesApiService) RegisterCompute(ctx context.Context, computeSpec openapi.ComputeSpec) (openapi.ImplResponse, error)
- func (s *ComputesApiService) UpdateCompute(ctx context.Context, computeId string, xAPIKEY string, ...) (openapi.ImplResponse, error)
- type DatasetsApiService
- func (s *DatasetsApiService) CreateDataset(ctx context.Context, user string, datasetInfo openapi.DatasetInfo) (openapi.ImplResponse, error)
- func (s *DatasetsApiService) GetAllDatasets(ctx context.Context, limit int32) (openapi.ImplResponse, error)
- func (s *DatasetsApiService) GetDataset(ctx context.Context, user string, datasetId string) (openapi.ImplResponse, error)
- func (s *DatasetsApiService) GetDatasets(ctx context.Context, user string, limit int32) (openapi.ImplResponse, error)
- func (s *DatasetsApiService) UpdateDataset(ctx context.Context, user string, datasetId string, ...) (openapi.ImplResponse, error)
- type DesignCodeApiService
- func (s *DesignCodeApiService) CreateDesignCode(ctx context.Context, user string, designId string, fileName string, ...) (openapi.ImplResponse, error)
- func (s *DesignCodeApiService) DeleteDesignCode(ctx context.Context, user string, designId string) (openapi.ImplResponse, error)
- func (s *DesignCodeApiService) GetDesignCode(ctx context.Context, user string, designId string) (openapi.ImplResponse, error)
- func (s *DesignCodeApiService) GetDesignCodeRevision(ctx context.Context, user string, designId string) (openapi.ImplResponse, error)
- func (s *DesignCodeApiService) UpdateDesignCode(ctx context.Context, user string, designId string, fileName string, ...) (openapi.ImplResponse, error)
- type DesignSchemaApiService
- func (s *DesignSchemaApiService) CreateDesignSchema(_ context.Context, user string, designId string, ...) (openapi.ImplResponse, error)
- func (s *DesignSchemaApiService) DeleteDesignSchema(_ context.Context, user string, designId string) (openapi.ImplResponse, error)
- func (s *DesignSchemaApiService) GetDesignSchema(_ context.Context, user string, designId string) (openapi.ImplResponse, error)
- func (s *DesignSchemaApiService) UpdateDesignSchema(_ context.Context, user string, designId string, ...) (openapi.ImplResponse, error)
- type DesignsApiService
- func (s *DesignsApiService) CreateDesign(ctx context.Context, user string, designInfo openapi.DesignInfo) (openapi.ImplResponse, error)
- func (s *DesignsApiService) DeleteDesign(ctx context.Context, user string, designId string) (openapi.ImplResponse, error)
- func (s *DesignsApiService) GetDesign(ctx context.Context, user string, designId string) (openapi.ImplResponse, error)
- func (s *DesignsApiService) GetDesigns(ctx context.Context, user string, limit int32) (openapi.ImplResponse, error)
- type JobsApiService
- func (s *JobsApiService) CreateJob(ctx context.Context, user string, jobSpec openapi.JobSpec) (openapi.ImplResponse, error)
- func (s *JobsApiService) DeleteJob(ctx context.Context, user string, jobId string) (openapi.ImplResponse, error)
- func (s *JobsApiService) GetJob(ctx context.Context, user string, jobId string) (openapi.ImplResponse, error)
- func (s *JobsApiService) GetJobStatus(ctx context.Context, user string, jobId string) (openapi.ImplResponse, error)
- func (s *JobsApiService) GetJobs(ctx context.Context, user string, limit int32) (openapi.ImplResponse, error)
- func (s *JobsApiService) GetJobsByCompute(ctx context.Context, computeId string) (openapi.ImplResponse, error)
- func (s *JobsApiService) GetTask(ctx context.Context, jobId string, taskId string, key string) (openapi.ImplResponse, error)
- func (s *JobsApiService) GetTaskInfo(ctx context.Context, user string, jobId string, taskId string) (openapi.ImplResponse, error)
- func (s *JobsApiService) GetTasksInfo(ctx context.Context, user string, jobId string, limit int32) (openapi.ImplResponse, error)
- func (s *JobsApiService) GetTasksInfoGeneric(ctx context.Context, user string, jobId string, limit int32) (openapi.ImplResponse, error)
- func (s *JobsApiService) UpdateJob(ctx context.Context, user string, jobId string, jobSpec openapi.JobSpec) (openapi.ImplResponse, error)
- func (s *JobsApiService) UpdateJobStatus(ctx context.Context, user string, jobId string, jobStatus openapi.JobStatus) (openapi.ImplResponse, error)
- func (s *JobsApiService) UpdateTaskStatus(ctx context.Context, jobId string, taskId string, ...) (openapi.ImplResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewComputesApiService ¶ added in v0.1.5
func NewComputesApiService(dbService database.DBService, jobParams config.JobParams) openapi.ComputesApiServicer
NewComputesApiService creates a default api service
func NewDatasetsApiService ¶
func NewDatasetsApiService(dbService database.DBService) openapi.DatasetsApiServicer
NewDatasetsApiService creates a default api service
func NewDesignCodeApiService ¶ added in v0.3.0
func NewDesignCodeApiService(dbService database.DBService) openapi.DesignCodeApiServicer
NewDesignCodeApiService creates a default api service
func NewDesignSchemaApiService ¶ added in v0.3.0
func NewDesignSchemaApiService(dbService database.DBService) openapi.DesignSchemaApiServicer
NewDesignSchemaApiService creates a default api service
func NewDesignsApiService ¶
func NewDesignsApiService(dbService database.DBService) openapi.DesignsApiServicer
NewDesignsApiService creates a default api service
func NewJobsApiService ¶
func NewJobsApiService(dbService database.DBService, jobEventQ *job.EventQ, jobBuilder *job.JobBuilder) openapi.JobsApiServicer
NewJobsApiService creates a default api service
Types ¶
type ComputesApiService ¶ added in v0.1.5
type ComputesApiService struct {
// contains filtered or unexported fields
}
ComputesApiService is a service that implements the logic for the ComputesApiServicer This service should implement the business logic for every endpoint for the ComputesApi API. Include any external packages or services that will be required by this service.
func (*ComputesApiService) DeleteCompute ¶ added in v0.1.5
func (s *ComputesApiService) DeleteCompute(ctx context.Context, computeId string, xAPIKEY string) (openapi.ImplResponse, error)
DeleteCompute - Delete compute cluster specification
func (*ComputesApiService) GetComputeConfig ¶ added in v0.1.5
func (s *ComputesApiService) GetComputeConfig(ctx context.Context, computeId string, xAPIKEY string) (openapi.ImplResponse, error)
GetComputeConfig - Get configuration for a compute cluster
func (*ComputesApiService) GetComputeStatus ¶ added in v0.1.5
func (s *ComputesApiService) GetComputeStatus(ctx context.Context, computeId string, xAPIKEY string) (openapi.ImplResponse, error)
GetComputeStatus - Get status of a given compute cluster
func (*ComputesApiService) GetDeploymentConfig ¶ added in v0.1.5
func (s *ComputesApiService) GetDeploymentConfig(ctx context.Context, computeId string, jobId string, xAPIKEY string) (openapi.ImplResponse, error)
GetDeploymentConfig - Get the deployment config for a job for a compute cluster
func (*ComputesApiService) GetDeploymentStatus ¶ added in v0.1.5
func (s *ComputesApiService) GetDeploymentStatus(ctx context.Context, computeId string, jobId string, xAPIKEY string) (openapi.ImplResponse, error)
GetDeploymentStatus - Get the deployment status for a job on a compute cluster
func (*ComputesApiService) GetDeployments ¶ added in v0.1.5
func (s *ComputesApiService) GetDeployments(ctx context.Context, computeId string, xAPIKEY string) (openapi.ImplResponse, error)
GetDeployments - Get all deployments within a compute cluster
func (*ComputesApiService) PutDeploymentStatus ¶ added in v0.1.5
func (s *ComputesApiService) PutDeploymentStatus(ctx context.Context, computeId string, jobId string, xAPIKEY string, requestBody map[string]openapi.AgentState) (openapi.ImplResponse, error)
PutDeploymentStatus - Add or update the deployment status for a job on a compute cluster
func (*ComputesApiService) RegisterCompute ¶ added in v0.1.5
func (s *ComputesApiService) RegisterCompute(ctx context.Context, computeSpec openapi.ComputeSpec) (openapi.ImplResponse, error)
RegisterCompute - Register a new compute cluster
func (*ComputesApiService) UpdateCompute ¶ added in v0.1.5
func (s *ComputesApiService) UpdateCompute(ctx context.Context, computeId string, xAPIKEY string, computeSpec openapi.ComputeSpec) (openapi.ImplResponse, error)
UpdateCompute - Update a compute cluster's specification
type DatasetsApiService ¶
type DatasetsApiService struct {
// contains filtered or unexported fields
}
DatasetsApiService is a service that implents the logic for the DatasetsApiServicer This service should implement the business logic for every endpoint for the DatasetsApi API. Include any external packages or services that will be required by this service.
func (*DatasetsApiService) CreateDataset ¶
func (s *DatasetsApiService) CreateDataset(ctx context.Context, user string, datasetInfo openapi.DatasetInfo) (openapi.ImplResponse, error)
CreateDataset - Create meta info for a new dataset.
func (*DatasetsApiService) GetAllDatasets ¶
func (s *DatasetsApiService) GetAllDatasets(ctx context.Context, limit int32) (openapi.ImplResponse, error)
GetAllDatasets - Get the meta info on all the datasets
func (*DatasetsApiService) GetDataset ¶
func (s *DatasetsApiService) GetDataset(ctx context.Context, user string, datasetId string) (openapi.ImplResponse, error)
GetDataset - Get dataset meta information
func (*DatasetsApiService) GetDatasets ¶
func (s *DatasetsApiService) GetDatasets(ctx context.Context, user string, limit int32) (openapi.ImplResponse, error)
GetDatasets - Get the meta info on all the datasets owned by user
func (*DatasetsApiService) UpdateDataset ¶
func (s *DatasetsApiService) UpdateDataset(ctx context.Context, user string, datasetId string, datasetInfo openapi.DatasetInfo) (openapi.ImplResponse, error)
UpdateDataset - Update meta info for a given dataset
type DesignCodeApiService ¶ added in v0.3.0
type DesignCodeApiService struct {
// contains filtered or unexported fields
}
DesignCodeApiService is a service that implents the logic for the DesignCodeApiServicer This service should implement the business logic for every endpoint for the DesignCodeApi API. Include any external packages or services that will be required by this service.
func (*DesignCodeApiService) CreateDesignCode ¶ added in v0.3.0
func (s *DesignCodeApiService) CreateDesignCode(ctx context.Context, user string, designId string, fileName string, fileData *os.File) (openapi.ImplResponse, error)
CreateDesignCode - Upload a new design code
func (*DesignCodeApiService) DeleteDesignCode ¶ added in v0.3.0
func (s *DesignCodeApiService) DeleteDesignCode(ctx context.Context, user string, designId string) (openapi.ImplResponse, error)
DeleteDesignCode - Delete a zipped design code file owned by user
func (*DesignCodeApiService) GetDesignCode ¶ added in v0.3.0
func (s *DesignCodeApiService) GetDesignCode(ctx context.Context, user string, designId string) (openapi.ImplResponse, error)
GetDesignCode - Get a zipped design code file owned by user
func (*DesignCodeApiService) GetDesignCodeRevision ¶ added in v0.3.0
func (s *DesignCodeApiService) GetDesignCodeRevision(ctx context.Context, user string, designId string) (openapi.ImplResponse, error)
GetDesignCodeRevision - Get a revision number of design code
func (*DesignCodeApiService) UpdateDesignCode ¶ added in v0.3.0
func (s *DesignCodeApiService) UpdateDesignCode(ctx context.Context, user string, designId string, fileName string, fileData *os.File) (openapi.ImplResponse, error)
UpdateDesignCode - Update a design code
type DesignSchemaApiService ¶ added in v0.3.0
type DesignSchemaApiService struct {
// contains filtered or unexported fields
}
DesignSchemaApiService is a service that implents the logic for the DesignSchemaApiServicer This service should implement the business logic for every endpoint for the DesignSchemaApi API. Include any external packages or services that will be required by this service.
func (*DesignSchemaApiService) CreateDesignSchema ¶ added in v0.3.0
func (s *DesignSchemaApiService) CreateDesignSchema(_ context.Context, user string, designId string, designSchema openapi.DesignSchema) (openapi.ImplResponse, error)
CreateDesignSchema - Update a design schema
func (*DesignSchemaApiService) DeleteDesignSchema ¶ added in v0.3.0
func (s *DesignSchemaApiService) DeleteDesignSchema(_ context.Context, user string, designId string) ( openapi.ImplResponse, error, )
func (*DesignSchemaApiService) GetDesignSchema ¶ added in v0.3.0
func (s *DesignSchemaApiService) GetDesignSchema(_ context.Context, user string, designId string) (openapi.ImplResponse, error)
GetDesignSchema - Get a design schema owned by user
func (*DesignSchemaApiService) UpdateDesignSchema ¶ added in v0.3.0
func (s *DesignSchemaApiService) UpdateDesignSchema(_ context.Context, user string, designId string, designSchema openapi.DesignSchema) (openapi.ImplResponse, error)
UpdateDesignSchema - Update a schema for a given design
type DesignsApiService ¶
type DesignsApiService struct {
// contains filtered or unexported fields
}
DesignsApiService is a service that implents the logic for the DesignsApiServicer This service should implement the business logic for every endpoint for the DesignsApi API. Include any external packages or services that will be required by this service.
func (*DesignsApiService) CreateDesign ¶
func (s *DesignsApiService) CreateDesign(ctx context.Context, user string, designInfo openapi.DesignInfo) (openapi.ImplResponse, error)
CreateDesign - Create a new design template.
func (*DesignsApiService) DeleteDesign ¶ added in v0.1.6
func (s *DesignsApiService) DeleteDesign(ctx context.Context, user string, designId string) (openapi.ImplResponse, error)
DeleteDesign - Delete design template
func (*DesignsApiService) GetDesign ¶
func (s *DesignsApiService) GetDesign(ctx context.Context, user string, designId string) (openapi.ImplResponse, error)
GetDesign - Get design template information
func (*DesignsApiService) GetDesigns ¶
func (s *DesignsApiService) GetDesigns(ctx context.Context, user string, limit int32) (openapi.ImplResponse, error)
GetDesigns - Get list of all the designs created by the user.
type JobsApiService ¶
type JobsApiService struct {
// contains filtered or unexported fields
}
JobsApiService is a service that implents the logic for the JobsApiServicer This service should implement the business logic for every endpoint for the JobsApi API. Include any external packages or services that will be required by this service.
func (*JobsApiService) CreateJob ¶
func (s *JobsApiService) CreateJob(ctx context.Context, user string, jobSpec openapi.JobSpec) (openapi.ImplResponse, error)
CreateJob - Create a new job specification
func (*JobsApiService) DeleteJob ¶
func (s *JobsApiService) DeleteJob(ctx context.Context, user string, jobId string) (openapi.ImplResponse, error)
DeleteJob - Delete job specification
func (*JobsApiService) GetJob ¶
func (s *JobsApiService) GetJob(ctx context.Context, user string, jobId string) (openapi.ImplResponse, error)
GetJob - Get a job specification
func (*JobsApiService) GetJobStatus ¶
func (s *JobsApiService) GetJobStatus(ctx context.Context, user string, jobId string) (openapi.ImplResponse, error)
GetJobStatus - Get job status of a given jobId
func (*JobsApiService) GetJobs ¶
func (s *JobsApiService) GetJobs(ctx context.Context, user string, limit int32) (openapi.ImplResponse, error)
GetJobs - Get status info on all the jobs owned by user
func (*JobsApiService) GetJobsByCompute ¶ added in v0.2.3
func (s *JobsApiService) GetJobsByCompute(ctx context.Context, computeId string) (openapi.ImplResponse, error)
GetJobsByCompute - Get status info on all the jobs by compute
func (*JobsApiService) GetTask ¶
func (s *JobsApiService) GetTask(ctx context.Context, jobId string, taskId string, key string) (openapi.ImplResponse, error)
GetTask - Get a job task for a given job and task
func (*JobsApiService) GetTaskInfo ¶ added in v0.1.2
func (s *JobsApiService) GetTaskInfo(ctx context.Context, user string, jobId string, taskId string) (openapi.ImplResponse, error)
GetTaskInfo - Get the info of a task in a job
func (*JobsApiService) GetTasksInfo ¶
func (s *JobsApiService) GetTasksInfo(ctx context.Context, user string, jobId string, limit int32) (openapi.ImplResponse, error)
GetTasksInfo - Get the info of tasks in a job
func (*JobsApiService) GetTasksInfoGeneric ¶ added in v0.2.3
func (s *JobsApiService) GetTasksInfoGeneric(ctx context.Context, user string, jobId string, limit int32) (openapi.ImplResponse, error)
GetTasksInfoGeneric - Get the info of tasks in a job
func (*JobsApiService) UpdateJob ¶
func (s *JobsApiService) UpdateJob(ctx context.Context, user string, jobId string, jobSpec openapi.JobSpec) (openapi.ImplResponse, error)
UpdateJob - Update a job specification
func (*JobsApiService) UpdateJobStatus ¶
func (s *JobsApiService) UpdateJobStatus(ctx context.Context, user string, jobId string, jobStatus openapi.JobStatus) (openapi.ImplResponse, error)
UpdateJobStatus - Update the status of a job
func (*JobsApiService) UpdateTaskStatus ¶
func (s *JobsApiService) UpdateTaskStatus(ctx context.Context, jobId string, taskId string, taskStatus openapi.TaskStatus) (openapi.ImplResponse, error)
UpdateTaskStatus - Update the status of a task