package
1.2.18-prerelease02
Repository: https://github.com/uber/cadence.git
Documentation: pkg.go.dev

# Packages

Package archiver is a generated GoMock package.
No description provided by the author
Package authorization is a generated GoMock package.
No description provided by the author
No description provided by the author
Package cache is a generated GoMock package.
No description provided by the author
Package client is a generated GoMock package.
Package clock is a generated GoMock package.
No description provided by the author
Package codec is a generated GoMock package.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package domain is a generated GoMock package.
Package dynamicconfig is a generated GoMock package.
No description provided by the author
No description provided by the author
No description provided by the author
Package isolationgroup is a generated GoMock package.
No description provided by the author
No description provided by the author
No description provided by the author
Package membership is a generated GoMock package.
Package messaging is a generated GoMock package.
No description provided by the author
No description provided by the author
Package ndc is a generated GoMock package.
Package pagination is a generated GoMock package.
Package partition is a generated GoMock package.
No description provided by the author
Package persistence is a generated GoMock package.
Package pinot is a generated GoMock package.
Package quotas is a generated GoMock package.
No description provided by the author
Package resource is a generated GoMock package.
Package rpc is a generated GoMock package.
No description provided by the author
Package stats is a generated GoMock package.
No description provided by the author
Package task is a generated GoMock package.
Package taskvalidator provides a Work in Progress service for workflow validations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

ActivityTypePtr makes a copy and returns the pointer to a ActivityType.
ArchivalStatusPtr makes a copy and returns the pointer to an ArchivalStatus.
AwaitWaitGroup calls Wait on the given wait Returns true if the Wait() call succeeded before the timeout Returns false if the Wait() did not return before the timeout.
BoolDefault returns value if bool pointer is set otherwise default value of bool.
BoolPtr makes a copy and returns the pointer to a bool.
CancelExternalWorkflowExecutionFailedCausePtr makes a copy and returns the pointer to a CancelExternalWorkflowExecutionFailedCause.
CheckDecisionResultLimit checks if decision result count exceeds limits.
CheckEventBlobSizeLimit checks if a blob data exceeds limits.
ChildWorkflowExecutionFailedCausePtr makes a copy and returns the pointer to a ChildWorkflowExecutionFailedCause.
ClientArchivalStatusPtr makes a copy and returns the pointer to a client ArchivalStatus.
ConvertDynamicConfigMapPropertyToIntMap convert a map property from dynamic config to a map whose type for both key and value are int.
ConvertErrToGetTaskFailedCause converts error to GetTaskFailedCause.
ConvertGetTaskFailedCauseToErr converts GetTaskFailedCause to error.
ConvertIndexedValueTypeToInternalType takes fieldType as interface{} and convert to IndexedValueType.
ConvertIntMapToDynamicConfigMapProperty converts a map whose key value type are both int to a map value that is compatible with dynamic config's map property.
CreateAdminServiceRetryPolicy creates a retry policy for calls to matching service.
CreateChildContext creates a child context which shorted context timeout from the given parent context tailroom must be in range [0, 1] and (1-tailroom) * parent timeout will be the new child context timeout if tailroom is less 0, tailroom will be considered as 0 if tailroom is greater than 1, tailroom wil be considered as 1.
CreateDlqPublishRetryPolicy creates a retry policy for kafka operation.
CreateDomainCacheRetryPolicy creates a retry policy to handle domain cache refresh failures.
CreateFrontendServiceRetryPolicy creates a retry policy for calls to frontend service.
CreateHistoryServiceRetryPolicy creates a retry policy for calls to history service.
CreateHistoryStartWorkflowRequest create a start workflow request for history.
CreateMatchingPollForDecisionTaskResponse create response for matching's PollForDecisionTask.
CreateMatchingServiceRetryPolicy creates a retry policy for calls to matching service.
CreatePersistenceRetryPolicy creates a retry policy for persistence layer operations.
CreateReplicationServiceBusyRetryPolicy creates a retry policy to handle replication service busy.
No description provided by the author
CreateTaskCompleterRetryPolicy creates a retry policy to handle tasks not being started.
CreateTaskProcessingRetryPolicy creates a retry policy for task processing.
DaysToDuration converts number of 24 hour days to time.Duration.
DecisionTaskFailedCausePtr makes a copy and returns the pointer to a DecisionTaskFailedCause.
DecisionTypePtr makes a copy and returns the pointer to a DecisionType.
DeserializeSearchAttributeValue takes json encoded search attribute value and it's type as input, then unmarshal the value into a concrete type and return the value.
DomainIDToHistoryShard is used to map a domainID to a shardID.
DurationPtr makes a copy and returns the pointer to a duration.
DurationToDays converts time.Duration to number of 24 hour days.
DurationToSeconds converts time.Duration to number of seconds.
EventTypePtr makes a copy and returns the pointer to a EventType.
Float64Ptr makes a copy and returns the pointer to an int64.
HistoryRetryFuncFrontendExceptions checks if an error should be retried in a call from frontend.
GenerateRandomString is used for generate test string.
GetSizeOfHistoryEvent returns approximate size in bytes of the history event taking into account byte arrays only now.
GetSizeOfMapStringToByteArray get size of map[string][]byte.
GetTaskPriority returns priority given a task's priority class and subclass.
Int16Ptr makes a copy and returns the pointer to an int16.
Int32Default returns value if int32 pointer is set otherwise default value of int32.
Int32Ptr makes a copy and returns the pointer to an int32.
Int64Default returns value if int64 pointer is set otherwise default value of int64.
Int64Ptr makes a copy and returns the pointer to an int64.
IntersectionStringSlice get the intersection of 2 string slices.
IntPtr makes a copy and returns the pointer to an int.
IsAdvancedVisibilityReadingEnabled returns true if we should read from advanced visibility.
IsAdvancedVisibilityWritingEnabled returns true if we should write to advanced visibility.
IsContextTimeoutError checks if the error is context timeout error.
IsEntityNotExistsError checks if the error is an entity not exists error.
IsExpectedError checks if an error is expected to happen in normal operation of the system.
IsJustOrderByClause return true is query start with order by.
IsServiceBusyError checks if the error is a service busy error.
IsServiceTransientError checks if the error is a transient error.
IsStickyTaskConditionError is error from matching engine.
IsValidContext checks that the thrift context is not expired on cancelled.
IsValidIDLength checks if id is valid according to its length.
No description provided by the author
No description provided by the author
NewJSONTaskTokenSerializer creates a new instance of TaskTokenSerializer.
NewMockPProfInitializer creates a new mock instance.
NewMockTaskTokenSerializer creates a new mock instance.
NewPerTaskListScope creates a tasklist metrics scope.
ParentClosePolicyPtr makes a copy and returns the pointer to a DecisionType.
PrettyPrintHistory prints history in human readable format.
Returns a pointer to the given value.
QueryConsistencyLevelPtr makes a copy and returns the pointer to a QueryConsistencyLevel.
QueryRejectConditionPtr makes a copy and returns the pointer to a QueryRejectCondition.
QueryResultTypePtr makes a copy and returns the pointer to a QueryResultType.
QueryTaskCompletedTypePtr makes a copy and returns the pointer to a QueryTaskCompletedType.
SecondsToDuration converts number of seconds to time.Duration.
SignalExternalWorkflowExecutionFailedCausePtr makes a copy and returns the pointer to a SignalExternalWorkflowExecutionFailedCause.
SleepWithMinDuration sleeps for the minimum of desired and available duration returns the remaining available time duration.
StringDefault returns value if string pointer is set otherwise default value of string.
StringPtr makes a copy and returns the pointer to a string.
TaskListKindPtr makes a copy and returns the pointer to a TaskListKind.
TaskListPtr makes a copy and returns the pointer to a TaskList.
TaskListTypePtr makes a copy and returns the pointer to a TaskListKind.
TimeNowNanosPtr returns an int64 ptr to current time in unix nanos.
TimeoutTypePtr makes a copy and returns the pointer to a TimeoutType.
TimePtr makes a copy and returns the pointer to a time.
ToServiceTransientError converts an error to ServiceTransientError.
Uint32Ptr makes a copy and returns the pointer to a uint32.
Uint64Ptr makes a copy and returns the pointer to a uint64.
ValidateDomainUUID checks if the given domainID string is a valid UUID.
ValidateLongPollContextTimeout check if the context timeout for a long poll handler is too short or below a normal value.
ValidateLongPollContextTimeoutIsSet checks if the context timeout is set for long poll requests.
ValidateRetryPolicy validates a retry policy.
WorkflowIDToHistoryShard is used to map a workflowID to a shardID.
WorkflowTypePtr makes a copy and returns the pointer to a WorkflowType.

# Constants

AdvancedVisibilityModeOff means do not use advanced visibility store.
ArchivalDisabled is the status for disabling archival.
ArchivalEnabled is the status for enabling archival.
ArchivalPaused is the status for pausing archival.
AuthorizationTokenHeaderName refers to the jwt token in the request.
AutoforwardingClusterHeaderName refers to the name of the header that contains the source cluster of the auto-forwarding request.
BatcherDomainID is domain id for batcher local domain.
BatcherLocalDomainName is domain name for batcher workflows running in local cluster Batcher cannot use SystemLocalDomain because auth.
BufferedEventID is the id of the buffered event.
Header name to pass the feature flags from customer to client or server.
ClientImplHeaderName refers to the name of the header that contains the client implementation.
ClientIsolationGroupHeaderName refers to the name of the header that contains the isolation group which the client request is from.
CriticalLongPollTimeout is a threshold for the context timeout passed into long poll API, below which a warning will be logged.
DaemonStatusInitialized coroutine pool initialized.
DaemonStatusStarted coroutine pool started.
DaemonStatusStopped coroutine pool stopped.
No description provided by the author
DefaultESAnalyzerBufferWaitTime controls min time required to consider a worklow stuck.
DefaultESAnalyzerEnableAvgDurationBasedChecks controls if we want to enable avg duration based refreshes.
DefaultESAnalyzerLimitToDomains controls if we want to limit ESAnalyzer only to some domains.
DefaultESAnalyzerLimitToTypes controls if we want to limit ESAnalyzer only to some workflow types.
DefaultESAnalyzerMaxNumDomains controls how many domains to check.
DefaultESAnalyzerMaxNumWorkflowTypes controls how many workflow types per domain to check.
DefaultESAnalyzerMinNumWorkflowsForAvg controls how many workflows to have at least to rely on workflow run time avg per type.
DefaultESAnalyzerNumWorkflowsToRefresh controls how many workflows per workflow type should be refreshed.
DefaultESAnalyzerPause controls if we want to dynamically pause the analyzer.
DefaultESAnalyzerTimeWindow controls how many days to go back for ElasticSearch Analyzer.
DefaultESAnalyzerWorkflowDurationWarnThreshold defines warning threshold for a workflow duration.
DefaultHistoryMaxAutoResetPoints is the default maximum number for auto reset points.
DefaultIDLengthErrorLimit is the maximum length allowed for various ID types.
DefaultIDLengthWarnLimit is the warning length for various ID types.
DefaultPriorityClass is the priority class for default priority tasks.
DefaultPrioritySubclass is the priority subclass for high priority tasks.
DefaultTransactionSizeLimit is the largest allowed transaction size to persistence.
DomainDataKeyForFailoverHistory is the key of DomainData for failover history.
DomainDataKeyForManagedFailover is key of DomainData for managed failover.
DomainDataKeyForPreferredCluster is the key of DomainData for domain rebalance.
DomainDataKeyForReadGroups stores which groups have read permission of the domain API.
DomainDataKeyForWriteGroups stores which groups have write permission of the domain API.
EmptyEventID is the id of the empty event.
EmptyEventTaskID is uninitialized id of the task id within event.
EmptyMessageID is the default start message ID for replication level.
EmptyUUID is the placeholder for UUID when it's empty.
EmptyVersion is used as the default value for failover version when no value is provided.
Data encoding types.
Data encoding types.
Data encoding types.
Data encoding types.
Data encoding types.
Data encoding types.
EndEventID is the id of the end event, here we use the int64 max.
EndMessageID is the id of the end message, here we use the int64 max.
No description provided by the author
ESVisibilityStoreName is used to find es advanced visibility store.
No description provided by the author
No description provided by the author
FailureReasonCancelDetailsExceedsLimit is failureReason for cancel details exceeds limit.
FailureReasonCompleteResultExceedsLimit is failureReason for complete result exceeds limit.
FailureReasonDecisionAttemptsExceedsLimit is reason to fail workflow when decision attempts fail too many times.
FailureReasonDecisionBlobSizeExceedsLimit is the failureReason for decision blob exceeds size limit.
FailureReasonFailureDetailsExceedsLimit is failureReason for failure details exceeds limit.
FailureReasonHeartbeatExceedsLimit is failureReason for heartbeat exceeds limit.
FailureReasonSizeExceedsLimit is reason to fail workflow when history size or count exceed limit.
FailureReasonTransactionSizeExceedsLimit is the failureReason for when transaction cannot be committed because it exceeds size limit.
FeatureVersionHeaderName refers to the name of the tchannel / http header that contains the client feature version the feature version sent from client represents the feature set of the cadence client library support.
FirstBlobPageToken is the page token identifying the first blob for each history archival.
FirstEventID is the id of the first event in the history.
GetHistoryMaxPageSize is the max page size for get history.
HighPriorityClass is the priority class for high priority tasks.
HighPrioritySubclass is the priority subclass for high priority tasks.
InitialPreviousFailoverVersion is the initial previous failover version.
IsolationGroupHeaderName refers to the name of the header that contains the isolation group of the client.
No description provided by the author
No description provided by the author
LastBlobNextPageToken is the next page token on the last blob for each history archival.
LibraryVersionHeaderName refers to the name of the tchannel / http header that contains the client library version.
LowPriorityClass is the priority class for low priority tasks.
LowPrioritySubclass is the priority subclass for high priority tasks.
MaxTaskTimeout is maximum task timeout allowed.
MemoKeyForOperator is the memo key for operator.
MinLongPollTimeout is the minimum context timeout for long poll API, below which the request won't be processed.
OSVisibilityStoreName is used to find opensearch advanced visibility store.
PartitionConfigHeaderName refers to the name of the header that contains the json encoded partition config of the request.
No description provided by the author
No description provided by the author
PinotVisibilityStoreName is used to find pinot advanced visibility store.
ReadDLQMessagesPageSize is the max page size for read DLQ messages.
Enum for visibility message type.
Enum for visibility message type.
ReservedTaskListPrefix is the required naming prefix for any task list partition other than partition 0.
ShadowerDomainID is domain id for workflow shadower local domain.
ShadowerLocalDomainName.
No description provided by the author
No description provided by the author
StickyTaskConditionFailedErrorMsg error msg for sticky task ConditionFailedError.
SystemDomainID is domain id for all cadence system workflows.
SystemDomainRetentionDays is retention config for all cadence system workflows.
SystemGlobalDomainName is global domain name for cadence system workflows running globally.
SystemLocalDomainName is domain name for cadence system workflows running in local cluster.
Deprecated: TaskTypeCrossCluster is the task type for cross cluster task as of June 2024, this feature is no longer supported.
TaskTypeReplication is the task type for replication task.
TaskTypeTimer is the task type for timer task.
TaskTypeTransfer is the task type for transfer task starting from 2 here to be consistent with the row type define for cassandra TODO: we can remove +2 from the following definition we don't have to make them consistent with cassandra definition there's also no row type for sql or other nosql persistence implementation.
TransientEventID is the id of the transient event.
Enum for visibility message type.
VisibilityAppName is used to find kafka topics and ES indexName for visibility.
AdvancedVisibilityModeDB means db visibility mode.
AdvancedVisibilityModeES means ElasticSearch visibility mode.
AdvancedVisibilityModeOS means OpenSearch visibility mode.
AdvancedVisibilityModePinot means Pinot visibility mode.
WorkflowIDRateLimitReason is the reason set in ServiceBusyError when workflow ID rate limit is exceeded.

# Variables

ErrBlobSizeExceedsLimit is error for event blob size exceeds limit.
ErrContextTimeoutNotSet is error for not setting a context timeout when calling a long poll API.
ErrContextTimeoutTooShort is error for setting a very short context timeout when calling a long poll API.
ErrDecisionResultCountTooLarge error for decision result count exceeds limit.

# Structs

MockPProfInitializer is a mock of PProfInitializer interface.
MockPProfInitializerMockRecorder is the mock recorder for MockPProfInitializer.
MockTaskTokenSerializer is a mock of TaskTokenSerializer interface.
MockTaskTokenSerializerMockRecorder is the mock recorder for MockTaskTokenSerializer.
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author