-
Notifications
You must be signed in to change notification settings - Fork 787
/
interface.go
124 lines (111 loc) · 4.24 KB
/
interface.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package archiver
import (
"context"
"github.com/uber/cadence/common/cache"
"github.com/uber/cadence/common/cluster"
"github.com/uber/cadence/common/log"
"github.com/uber/cadence/common/metrics"
"github.com/uber/cadence/common/persistence"
"github.com/uber/cadence/common/types"
)
type (
// ArchiveHistoryRequest is request to Archive workflow history
ArchiveHistoryRequest struct {
ShardID int
DomainID string
DomainName string
WorkflowID string
RunID string
BranchToken []byte
NextEventID int64
CloseFailoverVersion int64
}
// GetHistoryRequest is the request to Get archived history
GetHistoryRequest struct {
DomainID string
WorkflowID string
RunID string
CloseFailoverVersion *int64
NextPageToken []byte
PageSize int
}
// GetHistoryResponse is the response of Get archived history
GetHistoryResponse struct {
HistoryBatches []*types.History
NextPageToken []byte
}
// HistoryBootstrapContainer contains components needed by all history Archiver implementations
HistoryBootstrapContainer struct {
HistoryV2Manager persistence.HistoryManager
Logger log.Logger
MetricsClient metrics.Client
ClusterMetadata cluster.Metadata
DomainCache cache.DomainCache
}
// HistoryArchiver is used to archive history and read archived history
HistoryArchiver interface {
Archive(context.Context, URI, *ArchiveHistoryRequest, ...ArchiveOption) error
Get(context.Context, URI, *GetHistoryRequest) (*GetHistoryResponse, error)
ValidateURI(URI) error
}
// VisibilityBootstrapContainer contains components needed by all visibility Archiver implementations
VisibilityBootstrapContainer struct {
Logger log.Logger
MetricsClient metrics.Client
ClusterMetadata cluster.Metadata
DomainCache cache.DomainCache
}
// ArchiveVisibilityRequest is request to Archive single workflow visibility record
ArchiveVisibilityRequest struct {
DomainID string
DomainName string // doesn't need to be archived
WorkflowID string
RunID string
WorkflowTypeName string
StartTimestamp int64
ExecutionTimestamp int64
CloseTimestamp int64
CloseStatus types.WorkflowExecutionCloseStatus
HistoryLength int64
Memo *types.Memo
SearchAttributes map[string]string
HistoryArchivalURI string
}
// QueryVisibilityRequest is the request to query archived visibility records
QueryVisibilityRequest struct {
DomainID string
PageSize int
NextPageToken []byte
Query string
}
// QueryVisibilityResponse is the response of querying archived visibility records
QueryVisibilityResponse struct {
Executions []*types.WorkflowExecutionInfo
NextPageToken []byte
}
// VisibilityArchiver is used to archive visibility and read archived visibility
VisibilityArchiver interface {
Archive(context.Context, URI, *ArchiveVisibilityRequest, ...ArchiveOption) error
Query(context.Context, URI, *QueryVisibilityRequest) (*QueryVisibilityResponse, error)
ValidateURI(URI) error
}
)