requester

Documentation

Overview

Package requester is a generated GoMock package.

Index

• Variables
• type BaseEndpoint
  • func NewBaseEndpoint(params *BaseEndpointParams) *BaseEndpoint
  • func (e *BaseEndpoint) CancelJob(ctx context.Context, request CancelJobRequest) (CancelJobResult, error)
  • func (e *BaseEndpoint) OnBidComplete(ctx context.Context, response compute.BidResult)
  • func (e *BaseEndpoint) OnCancelComplete(ctx context.Context, result compute.CancelResult)
  • func (e *BaseEndpoint) OnComputeFailure(ctx context.Context, result compute.ComputeError)
  • func (e *BaseEndpoint) OnRunComplete(ctx context.Context, result compute.RunResult)
  • func (e *BaseEndpoint) SubmitJob(ctx context.Context, data model.JobCreatePayload) (*model.Job, error)
• type BaseEndpointParams
• type CancelJobRequest
• type CancelJobResult
• type Endpoint
• type MockEndpoint
  • func NewMockEndpoint(ctrl *gomock.Controller) *MockEndpoint
  • func (m *MockEndpoint) CancelJob(arg0 context.Context, arg1 CancelJobRequest) (CancelJobResult, error)
  • func (m *MockEndpoint) EXPECT() *MockEndpointMockRecorder
  • func (m *MockEndpoint) SubmitJob(arg0 context.Context, arg1 model.JobCreatePayload) (*model.Job, error)
• type MockEndpointMockRecorder
  • func (mr *MockEndpointMockRecorder) CancelJob(arg0, arg1 any) *gomock.Call
  • func (mr *MockEndpointMockRecorder) SubmitJob(arg0, arg1 any) *gomock.Call
• type ReadLogsRequest
• type ReadLogsResponse
• type StartJobRequest

Variables

var (
	JobsSubmitted = lo.Must(telemetry.NewCounter(
		requesterMeter,
		"job_submitted",
		"Number of jobs submitted"))
)

Types

type BaseEndpoint

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

BaseEndpoint base implementation of requester Endpoint

func NewBaseEndpoint

func NewBaseEndpoint(params *BaseEndpointParams) *BaseEndpoint

func (*BaseEndpoint) CancelJob

func (e *BaseEndpoint) CancelJob(ctx context.Context, request CancelJobRequest) (CancelJobResult, error)

func (*BaseEndpoint) OnBidComplete

func (e *BaseEndpoint) OnBidComplete(ctx context.Context, response compute.BidResult)

OnBidComplete implements compute.Callback

func (*BaseEndpoint) OnCancelComplete

func (e *BaseEndpoint) OnCancelComplete(ctx context.Context, result compute.CancelResult)

func (*BaseEndpoint) OnComputeFailure

func (e *BaseEndpoint) OnComputeFailure(ctx context.Context, result compute.ComputeError)

func (*BaseEndpoint) OnRunComplete

func (e *BaseEndpoint) OnRunComplete(ctx context.Context, result compute.RunResult)

func (*BaseEndpoint) SubmitJob

func (e *BaseEndpoint) SubmitJob(ctx context.Context, data model.JobCreatePayload) (*model.Job, error)

type BaseEndpointParams

type BaseEndpointParams struct {
	ID                         string
	Store                      jobstore.Store
	EventEmitter               orchestrator.EventEmitter
	ComputeEndpoint            compute.Endpoint
	StorageProviders           storage.StorageProvider
	MinJobExecutionTimeout     time.Duration
	DefaultJobExecutionTimeout time.Duration
	DefaultPublisher           string
}

type CancelJobRequest

type CancelJobRequest struct {
	JobID         string
	Reason        string
	UserTriggered bool
}

type CancelJobResult

type CancelJobResult struct{}

type Endpoint

type Endpoint interface {
	// SubmitJob submits a new job to the network.
	SubmitJob(context.Context, model.JobCreatePayload) (*model.Job, error)
	// CancelJob cancels an existing job.
	CancelJob(context.Context, CancelJobRequest) (CancelJobResult, error)
}

Endpoint is the frontend and entry point to the requester node for the end users to submit, update and cancel jobs.

type MockEndpoint

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

MockEndpoint is a mock of Endpoint interface.

func NewMockEndpoint

func NewMockEndpoint(ctrl *gomock.Controller) *MockEndpoint

NewMockEndpoint creates a new mock instance.

func (*MockEndpoint) CancelJob

func (m *MockEndpoint) CancelJob(arg0 context.Context, arg1 CancelJobRequest) (CancelJobResult, error)

CancelJob mocks base method.

func (*MockEndpoint) EXPECT

func (m *MockEndpoint) EXPECT() *MockEndpointMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockEndpoint) SubmitJob

func (m *MockEndpoint) SubmitJob(arg0 context.Context, arg1 model.JobCreatePayload) (*model.Job, error)

SubmitJob mocks base method.

type MockEndpointMockRecorder

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

MockEndpointMockRecorder is the mock recorder for MockEndpoint.

func (*MockEndpointMockRecorder) CancelJob

func (mr *MockEndpointMockRecorder) CancelJob(arg0, arg1 any) *gomock.Call

CancelJob indicates an expected call of CancelJob.

func (*MockEndpointMockRecorder) SubmitJob

func (mr *MockEndpointMockRecorder) SubmitJob(arg0, arg1 any) *gomock.Call

SubmitJob indicates an expected call of SubmitJob.

type ReadLogsRequest

type ReadLogsRequest struct {
	JobID       string
	ExecutionID string
	Tail        bool
	Follow      bool
}

type ReadLogsResponse

type ReadLogsResponse struct {
	Address           string
	ExecutionComplete bool
}

type StartJobRequest

type StartJobRequest struct {
	Job model.Job
}

StartJobRequest triggers the scheduling of a job.