searchattribute

package
v1.11.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2021 License: MIT Imports: 16 Imported by: 6

Documentation

Overview

Package searchattribute is a generated GoMock package.

Index

Constants

View Source 
const (
	NamespaceID          = "NamespaceId"
	WorkflowID           = "WorkflowId"
	RunID                = "RunId"
	WorkflowType         = "WorkflowType"
	StartTime            = "StartTime"
	ExecutionTime        = "ExecutionTime"
	CloseTime            = "CloseTime"
	ExecutionStatus      = "ExecutionStatus"
	TaskQueue            = "TaskQueue"
	HistoryLength        = "HistoryLength"
	ExecutionDuration    = "ExecutionDuration"
	StateTransitionCount = "StateTransitionCount"

	TemporalChangeVersion = "TemporalChangeVersion"
	BinaryChecksums       = "BinaryChecksums"
	BatcherNamespace      = "BatcherNamespace"
	BatcherUser           = "BatcherUser"

	MemoEncoding      = "MemoEncoding"
	Memo              = "Memo"
	VisibilityTaskKey = "VisibilityTaskKey"
)
View Source 
const (
	MetadataType = "type"
)

Variables

View Source 
var (
	ErrInvalidName = errors.New("invalid search attribute name")
	ErrInvalidType = errors.New("invalid search attribute type")
)
View Source 
var (
	ErrExceedSizeLimit = errors.New("exceeds size limit")
)
View Source 
var (
	TestNameTypeMap = NameTypeMap{
		// contains filtered or unexported fields
	}
)

Functions

func ApplyTypeMap 

func ApplyTypeMap(searchAttributes *commonpb.SearchAttributes, typeMap NameTypeMap)

ApplyTypeMap set type for all valid search attributes which don't have it. It doesn't do any validation and just skip invalid or already set search attributes.

func BuildIndexNameTypeMap added in v1.10.0 

func BuildIndexNameTypeMap(indexSearchAttributes map[string]*persistencespb.IndexSearchAttributes) map[string]NameTypeMap

func BuildTypeMap 

func BuildTypeMap(validSearchAttributesFn dynamicconfig.MapPropertyFn) (map[string]enumspb.IndexedValueType, error)

BuildTypeMap converts search attributes types from dynamic config map to type map. TODO: Remove after 1.10.0 release

func Decode 

func Decode(searchAttributes *commonpb.SearchAttributes, typeMap *NameTypeMap) (map[string]interface{}, error)

Decode decodes search attributes to the map of search attribute values using (in order): 1. type from MetadataType field, 2. type from typeMap (can be nil). In case of error, it will continue to next search attribute and return last error.

func DecodeValue 

func DecodeValue(value *commonpb.Payload, t enumspb.IndexedValueType) (interface{}, error)

DecodeValue decodes search attribute value from Payload using (in order): 1. type from MetadataType field, 2. passed type t.

func Encode 

func Encode(searchAttributes map[string]interface{}, typeMap *NameTypeMap) (*commonpb.SearchAttributes, error)

Encode encodes map of search attribute values to search attributes. typeMap can be nil (MetadataType field won't be set). In case of error, it will continue to next search attribute and return last error.

func EncodeValue 

func EncodeValue(val interface{}, t enumspb.IndexedValueType) (*commonpb.Payload, error)

EncodeValue encodes search attribute value and IndexedValueType to Payload.

func FilterCustomOnly added in v1.10.0 

func FilterCustomOnly(searchAttributes map[string]enumspb.IndexedValueType) map[string]enumspb.IndexedValueType

FilterCustomOnly returns new search attributes map with only custom search attributes in it. TODO: Remove this after 1.10.0 release

func IsReserved added in v1.11.0 

func IsReserved(fieldName string) bool

IsReserved return true if field name is system reserved and can't be used as custom search attribute name.

func Parse 

func Parse(searchAttributesStr map[string]string, typeMap *NameTypeMap) (*commonpb.SearchAttributes, error)

Parse converts maps of search attribute strings to search attributes. typeMap can be nil (values will be parsed with strconv and MetadataType field won't be set). In case of error, it will continue to next search attribute and return last error. Single values are parsed using strconv, arrays are parsed using json.Unmarshal.

func Stringify 

func Stringify(searchAttributes *commonpb.SearchAttributes, typeMap *NameTypeMap) (map[string]string, error)

Stringify converts search attributes to map of strings using (in order): 1. type from MetadataType field, 2. type from typeMap (can be nil). In case of error, it will continue to next search attribute and return last error. Single values are converted using strconv, arrays are converted using json.Marshal.

Types

type Manager added in v1.10.0 

type Manager interface {
	Provider
	SaveSearchAttributes(indexName string, newCustomSearchAttributes map[string]enumspb.IndexedValueType) error
}

type MockManager added in v1.10.0 

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

MockManager is a mock of Manager interface.

func NewMockManager added in v1.10.0 

func NewMockManager(ctrl *gomock.Controller) *MockManager

NewMockManager creates a new mock instance.

func (*MockManager) EXPECT added in v1.10.0 

func (m *MockManager) EXPECT() *MockManagerMockRecorder

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

func (*MockManager) GetSearchAttributes added in v1.10.0 

func (m *MockManager) GetSearchAttributes(indexName string, forceRefreshCache bool) (NameTypeMap, error)

GetSearchAttributes mocks base method.

func (*MockManager) SaveSearchAttributes added in v1.10.0 

func (m *MockManager) SaveSearchAttributes(indexName string, newCustomSearchAttributes map[string]v1.IndexedValueType) error

SaveSearchAttributes mocks base method.

type MockManagerMockRecorder added in v1.10.0 

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

MockManagerMockRecorder is the mock recorder for MockManager.

func (*MockManagerMockRecorder) GetSearchAttributes added in v1.10.0 

func (mr *MockManagerMockRecorder) GetSearchAttributes(indexName, forceRefreshCache interface{}) *gomock.Call

GetSearchAttributes indicates an expected call of GetSearchAttributes.

func (*MockManagerMockRecorder) SaveSearchAttributes added in v1.10.0 

func (mr *MockManagerMockRecorder) SaveSearchAttributes(indexName, newCustomSearchAttributes interface{}) *gomock.Call

SaveSearchAttributes indicates an expected call of SaveSearchAttributes.

type MockProvider added in v1.10.0 

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

MockProvider is a mock of Provider interface.

func NewMockProvider added in v1.10.0 

func NewMockProvider(ctrl *gomock.Controller) *MockProvider

NewMockProvider creates a new mock instance.

func (*MockProvider) EXPECT added in v1.10.0 

func (m *MockProvider) EXPECT() *MockProviderMockRecorder

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

func (*MockProvider) GetSearchAttributes added in v1.10.0 

func (m *MockProvider) GetSearchAttributes(indexName string, forceRefreshCache bool) (NameTypeMap, error)

GetSearchAttributes mocks base method.

type MockProviderMockRecorder added in v1.10.0 

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

MockProviderMockRecorder is the mock recorder for MockProvider.

func (*MockProviderMockRecorder) GetSearchAttributes added in v1.10.0 

func (mr *MockProviderMockRecorder) GetSearchAttributes(indexName, forceRefreshCache interface{}) *gomock.Call

GetSearchAttributes indicates an expected call of GetSearchAttributes.

type NameTypeMap added in v1.10.0 

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

func (NameTypeMap) All added in v1.10.0 

func (m NameTypeMap) All() map[string]enumspb.IndexedValueType

func (NameTypeMap) Custom added in v1.10.0 

func (m NameTypeMap) Custom() map[string]enumspb.IndexedValueType

func (NameTypeMap) GetType added in v1.10.0 

func (m NameTypeMap) GetType(name string) (enumspb.IndexedValueType, error)

GetType returns type of search attribute from type map.

func (NameTypeMap) IsDefined added in v1.10.0 

func (m NameTypeMap) IsDefined(name string) bool

func (NameTypeMap) System added in v1.10.0 

func (m NameTypeMap) System() map[string]enumspb.IndexedValueType

type Provider added in v1.10.0 

type Provider interface {
	GetSearchAttributes(indexName string, forceRefreshCache bool) (NameTypeMap, error)
}

type SystemProvider added in v1.10.0 

type SystemProvider struct{}

func NewSystemProvider added in v1.10.0 

func NewSystemProvider() *SystemProvider

func (*SystemProvider) GetSearchAttributes added in v1.10.0 

func (s *SystemProvider) GetSearchAttributes(_ string, _ bool) (NameTypeMap, error)

type TestProvider added in v1.10.0 

type TestProvider struct{}

func NewTestProvider added in v1.10.0 

func NewTestProvider() *TestProvider

func (*TestProvider) GetSearchAttributes added in v1.10.0 

func (s *TestProvider) GetSearchAttributes(_ string, _ bool) (NameTypeMap, error)

type Validator 

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

Validator is used to validate search attributes

func NewValidator 

func NewValidator(
	logger log.Logger,
	searchAttributesProvider Provider,
	searchAttributesNumberOfKeysLimit dynamicconfig.IntPropertyFnWithNamespaceFilter,
	searchAttributesSizeOfValueLimit dynamicconfig.IntPropertyFnWithNamespaceFilter,
	searchAttributesTotalSizeLimit dynamicconfig.IntPropertyFnWithNamespaceFilter,
) *Validator

NewValidator create Validator

func (*Validator) Validate 

func (v *Validator) Validate(searchAttributes *commonpb.SearchAttributes, namespace string, indexName string) error

Validate validate search attributes are valid for writing.

func (*Validator) ValidateAndLog 

func (v *Validator) ValidateAndLog(searchAttributes *commonpb.SearchAttributes, namespace string, indexName string) error

ValidateAndLog validate search attributes are valid for writing and not exceed limits

func (*Validator) ValidateSize added in v1.9.0 

func (v *Validator) ValidateSize(searchAttributes *commonpb.SearchAttributes, namespace string) error

ValidateSize validate search attributes are valid for writing and not exceed limits

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.