endpoints

package

v0.2.8 Latest Latest Go to latest Published: May 12, 2021 License: GPL-3.0 Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func RunGrpcJobServer() error

RunGrpcJobServer Runs the Grpc server

type AuthHandler struct {
	// contains filtered or unexported fields
}

AuthHandler Simple auth handler to check if a grpc call has a token Only for testing purposes

func InitAuthHandler() (*AuthHandler, error)

InitAuthHandler Initiates a simple auth handler

type BaktaJobAPI struct {
	api.UnimplementedBaktaJobsServer
	// contains filtered or unexported fields
}

BaktaJobAPI implements the job endpoints of the bakta-web-api

func InitBaktaAPI(dbHandler *database.Handler, scheduler *scheduler.SimpleScheduler, s3Handler *objectStorage.S3ObjectStorageHandler) *BaktaJobAPI

InitBaktaAPI Initiates the Bakta API handler

func (apiHandler *BaktaJobAPI) GetJobResult(ctx context.Context, request *api.JobAuth) (*api.JobResultResponse, error)

GetJobResult Returns the results for a specific jobs

func (apiHandler *BaktaJobAPI) GetJobsStatus(ctx context.Context, request *api.JobStatusRequestList) (*api.JobStatusReponseList, error)

GetJobsStatus Get the job status of the provided list of jobs

func (apiHandler *BaktaJobAPI) InitJob(ctx context.Context, request *api.InitJobRequest) (*api.InitJobResponse, error)

InitJob Initiates a bakta job and returns upload links for the fasta, prodigal training and replicon file

func (apiHandler *BaktaJobAPI) StartJob(ctx context.Context, request *api.StartJobRequest) (*api.Empty, error)

StartJob Starts a job based on the provided configuration

func (apiHandler *BaktaJobAPI) Version(ctx context.Context, request *api.Empty) (*api.VersionResponse, error)

type BaktaUpdateAPI struct {
	api.UnimplementedBaktaStatusUpdateServer
	// contains filtered or unexported fields
}

BaktaUpdateAPI implements the endpoints of the bakta-web-api

func (apiHandler *BaktaUpdateAPI) UpdateStatus(ctx context.Context, request *api.UpdateStatusRequest) (*api.Empty, error)

UpdateStatus Updates the status of a running job