-
Notifications
You must be signed in to change notification settings - Fork 775
/
clientInterface.go
62 lines (54 loc) · 2.85 KB
/
clientInterface.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
// 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.
//go:generate mockgen -package $GOPACKAGE -source $GOFILE -destination clientInterface_mock.go -self_package github.com/uber/cadence/common/dynamicconfig
package dynamicconfig
import (
"time"
"github.com/uber/cadence/common/types"
)
const (
DynamicConfigConfigStoreClient = "configstore"
DynamicConfigFileBasedClient = "filebased"
DynamicConfigInMemoryClient = "memory"
DynamicConfigNopClient = "nop"
)
// Client allows fetching values from a dynamic configuration system NOTE: This does not have async
// options right now. In the interest of keeping it minimal, we can add when requirement arises.
type Client interface {
GetValue(name Key, defaultValue interface{}) (interface{}, error)
GetValueWithFilters(name Key, filters map[Filter]interface{}, defaultValue interface{}) (interface{}, error)
GetIntValue(name Key, filters map[Filter]interface{}, defaultValue int) (int, error)
GetFloatValue(name Key, filters map[Filter]interface{}, defaultValue float64) (float64, error)
GetBoolValue(name Key, filters map[Filter]interface{}, defaultValue bool) (bool, error)
GetStringValue(name Key, filters map[Filter]interface{}, defaultValue string) (string, error)
GetMapValue(
name Key, filters map[Filter]interface{}, defaultValue map[string]interface{},
) (map[string]interface{}, error)
GetDurationValue(
name Key, filters map[Filter]interface{}, defaultValue time.Duration,
) (time.Duration, error)
// UpdateValue takes value as map and updates by overriding. It doesn't support update with filters.
UpdateValue(name Key, value interface{}) error
RestoreValue(name Key, filters map[Filter]interface{}) error
ListValue(name Key) ([]*types.DynamicConfigEntry, error)
}
var NotFoundError = &types.EntityNotExistsError{
Message: "unable to find key",
}