Documentation
¶
Overview ¶
Package archiver is a generated GoMock package.
Package archiver is a generated GoMock package.
Package archiver is a generated GoMock package.
Index ¶
- func MaxArchivalIterationTimeout() time.Duration
- func NewReplayMetricsClient(metricsHandler metrics.Handler, ctx workflow.Context) metrics.Handler
- type ArchivalTarget
- type ArchiveRequest
- type BootstrapContainer
- type Client
- type ClientRequest
- type ClientResponse
- type ClientWorker
- type Config
- type Handler
- type MockClient
- type MockClientMockRecorder
- type MockHandler
- type MockHandlerMockRecorder
- type MockPump
- type MockPumpMockRecorder
- type Pump
- type PumpResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func MaxArchivalIterationTimeout ¶ added in v0.5.9
func MaxArchivalIterationTimeout() time.Duration
MaxArchivalIterationTimeout returns the max allowed timeout for a single iteration of archival workflow
func NewReplayMetricsClient ¶
func NewReplayMetricsClient(metricsHandler metrics.Handler, ctx workflow.Context) metrics.Handler
NewReplayMetricsClient creates a metrics client which is aware of temporal's replay mode
Types ¶
type ArchivalTarget ¶ added in v0.27.0
type ArchivalTarget int
ArchivalTarget is either history or visibility
const (
// ArchiveTargetHistory is the archive target for workflow history
ArchiveTargetHistory ArchivalTarget = iota
// ArchiveTargetVisibility is the archive target for workflow visibility record
ArchiveTargetVisibility
)
type ArchiveRequest ¶
type ArchiveRequest struct {
ShardID int32
NamespaceID string
Namespace string
WorkflowID string
RunID string
// history archival
BranchToken []byte
NextEventID int64
CloseFailoverVersion int64
HistoryURI string
// visibility archival
WorkflowTypeName string
StartTime time.Time
ExecutionTime time.Time
CloseTime time.Time
Status enumspb.WorkflowExecutionStatus
HistoryLength int64
Memo *commonpb.Memo
SearchAttributes *commonpb.SearchAttributes
VisibilityURI string
// archival targets: history and/or visibility
Targets []ArchivalTarget
}
ArchiveRequest is the request signal sent to the archival workflow
type BootstrapContainer ¶
type BootstrapContainer struct {
SdkClientFactory sdk.ClientFactory
MetricsHandler metrics.Handler
Logger log.Logger
HistoryV2Manager persistence.ExecutionManager
NamespaceCache namespace.Registry
Config *Config
ArchiverProvider provider.ArchiverProvider
HistoryClient historyservice.HistoryServiceClient
}
BootstrapContainer contains everything need for bootstrapping
type Client ¶
type Client interface {
Archive(context.Context, *ClientRequest) (*ClientResponse, error)
}
Client is used to archive workflow histories
func NewClient ¶
func NewClient(
metricsHandler metrics.Handler,
logger log.Logger,
sdkClientFactory sdk.ClientFactory,
numWorkflows dynamicconfig.IntPropertyFn,
requestRPS dynamicconfig.IntPropertyFn,
signalTimeout dynamicconfig.DurationPropertyFn,
archiverProvider provider.ArchiverProvider,
) Client
NewClient creates a new Client
type ClientRequest ¶ added in v0.7.0
type ClientRequest struct {
ArchiveRequest *ArchiveRequest
CallerService string
AttemptArchiveInline bool
}
ClientRequest is the archive request sent to the archiver client
type ClientResponse ¶ added in v0.8.0
type ClientResponse struct {
HistoryArchivedInline bool
}
ClientResponse is the archive response returned from the archiver client
type ClientWorker ¶
type ClientWorker interface {
Start() error
Stop()
}
ClientWorker is a temporal client worker
func NewClientWorker ¶
func NewClientWorker(container *BootstrapContainer) ClientWorker
NewClientWorker returns a new ClientWorker
type Config ¶
type Config struct {
MaxConcurrentActivityExecutionSize dynamicconfig.IntPropertyFn
MaxConcurrentWorkflowTaskExecutionSize dynamicconfig.IntPropertyFn
MaxConcurrentActivityTaskPollers dynamicconfig.IntPropertyFn
MaxConcurrentWorkflowTaskPollers dynamicconfig.IntPropertyFn
ArchiverConcurrency dynamicconfig.IntPropertyFn
ArchivalsPerIteration dynamicconfig.IntPropertyFn
TimeLimitPerArchivalIteration dynamicconfig.DurationPropertyFn
}
Config for ClientWorker
type Handler ¶ added in v0.7.0
type Handler interface {
Start()
Finished() []uint64
}
Handler is used to process archival requests
func NewHandler ¶ added in v0.7.0
func NewHandler(
ctx workflow.Context,
logger log.Logger,
metricsHandler metrics.Handler,
concurrency int,
requestCh workflow.Channel,
) Handler
NewHandler returns a new Handler
type MockClient ¶ added in v1.5.7
type MockClient struct {
// contains filtered or unexported fields
}
MockClient is a mock of Client interface.
func NewMockClient ¶ added in v1.5.7
func NewMockClient(ctrl *gomock.Controller) *MockClient
NewMockClient creates a new mock instance.
type MockClientMockRecorder ¶ added in v1.5.7
type MockClientMockRecorder struct {
// contains filtered or unexported fields
}
MockClientMockRecorder is the mock recorder for MockClient.
type MockHandler ¶ added in v0.7.0
type MockHandler struct {
// contains filtered or unexported fields
}
MockHandler is a mock of Handler interface.
func NewMockHandler ¶ added in v1.5.7
func NewMockHandler(ctrl *gomock.Controller) *MockHandler
NewMockHandler creates a new mock instance.
func (*MockHandler) EXPECT ¶ added in v1.5.7
func (m *MockHandler) EXPECT() *MockHandlerMockRecorder
EXPECT returns an object that allows the caller to indicate expected use.
type MockHandlerMockRecorder ¶ added in v1.5.7
type MockHandlerMockRecorder struct {
// contains filtered or unexported fields
}
MockHandlerMockRecorder is the mock recorder for MockHandler.
type MockPump ¶ added in v1.5.7
type MockPump struct {
// contains filtered or unexported fields
}
MockPump is a mock of Pump interface.
func NewMockPump ¶ added in v1.5.7
func NewMockPump(ctrl *gomock.Controller) *MockPump
NewMockPump creates a new mock instance.
type MockPumpMockRecorder ¶ added in v1.5.7
type MockPumpMockRecorder struct {
// contains filtered or unexported fields
}
MockPumpMockRecorder is the mock recorder for MockPump.
type Pump ¶
type Pump interface {
Run() PumpResult
}
Pump pumps archival requests into request channel
type PumpResult ¶
type PumpResult struct {
PumpedHashes []uint64
UnhandledCarryover []ArchiveRequest
TimeoutWithoutSignals bool
}
PumpResult is the result of pumping requests into request channel