Documentation
¶
Index ¶
- Variables
- func AddSearchAttributes(c *cli.Context) error
- func BackfillSchedule(c *cli.Context) error
- func CancelWorkflow(c *cli.Context) error
- func ColorEvent(e *historypb.HistoryEvent) string
- func CompleteActivity(c *cli.Context) error
- func CountWorkflow(c *cli.Context) error
- func CreateSchedule(c *cli.Context) error
- func DataConverter(c *cli.Context) error
- func DeleteNamespace(c *cli.Context) error
- func DeleteSchedule(c *cli.Context) error
- func DeleteWorkflow(c *cli.Context) error
- func DescribeBatchJob(c *cli.Context) error
- func DescribeNamespace(c *cli.Context) error
- func DescribeSchedule(c *cli.Context) error
- func DescribeTaskQueue(c *cli.Context) error
- func DescribeWorkflow(c *cli.Context) error
- func FailActivity(c *cli.Context) error
- func GetValue(c *cli.Context) error
- func HealthCheck(c *cli.Context) error
- func HistoryEventToString(e *historypb.HistoryEvent, printFully bool, maxFieldLength int) string
- func ListBatchJobs(c *cli.Context) error
- func ListNamespaces(c *cli.Context) error
- func ListSchedules(c *cli.Context) error
- func ListSearchAttributes(c *cli.Context) error
- func ListTaskQueuePartitions(c *cli.Context) error
- func ListWorkflow(c *cli.Context) error
- func NewCliApp() *cli.App
- func NewContextWithCLIHeaders() (context.Context, context.CancelFunc)
- func NewContextWithTimeoutAndCLIHeaders(timeout time.Duration) (context.Context, context.CancelFunc)
- func QueryWorkflow(c *cli.Context) error
- func QueryWorkflowUsingStackTrace(c *cli.Context) error
- func RegisterNamespace(c *cli.Context) error
- func RemoveSearchAttributes(c *cli.Context) error
- func ResetInBatch(c *cli.Context) error
- func ResetWorkflow(c *cli.Context) error
- func ScanAllWorkflow(c *cli.Context) error
- func SetFactory(factory ClientFactory)
- func SetRequiredNamespaceDataKeys(keys []string)
- func SetValue(c *cli.Context) error
- func ShowHistory(c *cli.Context) error
- func SignalWorkflow(c *cli.Context) error
- func StartBatchJob(c *cli.Context) error
- func StartWorkflow(c *cli.Context, printProgress bool) error
- func TerminateBatchJob(c *cli.Context) error
- func TerminateWorkflow(c *cli.Context) error
- func ToggleSchedule(c *cli.Context) error
- func TriggerSchedule(c *cli.Context) error
- func UpdateNamespace(c *cli.Context) error
- func UpdateSchedule(c *cli.Context) error
- type ClientFactory
- type HttpGetter
- type PayloadRequest
- type PayloadResponse
- type SdkLogger
- func (l *SdkLogger) Debug(msg string, keyvals ...interface{})
- func (l *SdkLogger) Error(msg string, keyvals ...interface{})
- func (l *SdkLogger) Info(msg string, keyvals ...interface{})
- func (l *SdkLogger) Warn(msg string, keyvals ...interface{})
- func (l *SdkLogger) With(keyvals ...interface{}) sdklog.Logger
Constants ¶
This section is empty.
Variables ¶
var ( FlagUsername = "username" FlagPassword = "password" FlagKeyspace = "keyspace" FlagAddress = "address" FlagAuth = "auth" FlagHistoryAddress = "history-address" FlagDBEngine = "db-engine" FlagDBAddress = "db-address" FlagDBPort = "db-port" FlagNamespaceID = "namespace-id" FlagNamespace = "namespace" FlagNamespaceAlias = []string{"n"} FlagShardID = "shard-id" FlagWorkflowID = "workflow-id" FlagWorkflowIDAlias = []string{"wid"} FlagRunID = "run-id" FlagRunIDAlias = []string{"rid"} FlagTreeID = "tree-id" FlagBranchID = "branch-id" FlagNumberOfShards = "number-of-shards" FlagTargetCluster = "target-cluster" FlagMinEventID = "min-event-id" FlagMaxEventID = "max-event-id" FlagStartEventVersion = "start-event-version" FlagTaskQueue = "task-queue" FlagTaskQueueAlias = []string{"tq"} FlagTaskQueueType = "task-queue-type" FlagTaskQueueTypeAlias = []string{"tqt"} FlagWorkflowIDReusePolicy = "workflow-id-reuse-policy" FlagCronSchedule = "cron" FlagWorkflowType = "type" FlagWorkflowTypeAlias = []string{"t"} FlagWorkflowStatus = "status" FlagWorkflowExecutionTimeout = "execution-timeout" FlagWorkflowExecutionTimeoutAlias = []string{"et"} FlagWorkflowRunTimeout = "run-timeout" FlagWorkflowRunTimeoutAlias = []string{"rt"} FlagWorkflowTaskTimeout = "task-timeout" FlagWorkflowTaskTimeoutAlias = []string{"tt"} FlagContextTimeout = "context-timeout" FlagContextTimeoutAlias = []string{"ct"} FlagInput = "input" FlagInputAlias = []string{"i"} FlagInputFile = "input-file" FlagInputFileAlias = []string{"if"} FlagExcludeFile = "exclude-file" FlagInputSeparator = "input-separator" FlagParallelism = "input-parallelism" FlagSkipCurrentOpen = "skip-current-open" FlagSkipBaseIsNotCurrent = "skip-base-is-not-current" FlagDryRun = "dry-run" FlagNonDeterministic = "non-deterministic" FlagHostFile = "host-file" FlagCluster = "cluster" FlagInputCluster = "input-cluster" FlagTopic = "topic" FlagGroup = "group" FlagResult = "result" FlagIdentity = "identity" FlagDetail = "detail" FlagReason = "reason" FlagReasonAlias = []string{"r"} FlagOpen = "open" FlagPageSize = "pagesize" FlagPageSizeAlias = []string{"ps"} FlagFrom = "from" FlagTo = "to" FlagPrintEventVersion = "print-event-version" FlagPrintEventVersionAlias = []string{"pev"} FlagPrintFullyDetail = "print-full" FlagPrintFullyDetailAlias = []string{"pf"} FlagPrintRawTime = "print-raw-time" FlagPrintRawTimeAlias = []string{"prt"} FlagPrintRaw = "raw" FlagPrintDateTime = "print-datetime" FlagPrintDateTimeAlias = []string{"pdt"} FlagPrintMemo = "print-memo" FlagPrintMemoAlias = []string{"pme"} FlagPrintSearchAttr = "print-search-attr" FlagPrintSearchAttrAlias = []string{"psa"} FlagPrintJSON = "print-json" FlagPrintJSONAlias = []string{"pjson"} FlagDescription = "description" FlagDescriptionAlias = []string{"desc"} FlagOwnerEmail = "owner-email" FlagOwnerEmailAlias = []string{"oe"} FlagRetention = "retention" FlagRetentionAlias = []string{"rd"} FlagHistoryArchivalState = "history-archival-state" FlagHistoryArchivalStateAlias = []string{"has"} FlagHistoryArchivalURI = "history-uri" FlagHistoryArchivalURIAlias = []string{"huri"} FlagHeartbeatedWithin = "heartbeated-within" FlagVisibilityArchivalState = "visibility-archival-state" FlagVisibilityArchivalStateAlias = []string{"vas"} FlagVisibilityArchivalURI = "visibility-uri" FlagVisibilityArchivalURIAlias = []string{"vuri"} FlagName = "name" FlagNameAlias = []string{"n"} FlagOutputFilename = "output-filename" FlagOutputFilenameAlias = []string{"of"} FlagOutputFormat = "output" FlagQueryType = "query-type" FlagQueryTypeAlias = []string{"qt"} FlagQueryRejectCondition = "query-reject-condition" FlagQueryRejectConditionAlias = []string{"qrc"} FlagShowDetail = "show-detail" FlagShowDetailAlias = []string{"sd"} FlagActiveClusterName = "active-cluster" FlagActiveClusterNameAlias = []string{"ac"} FlagClusters = "clusters" FlagClustersAlias = []string{"cl"} FlagClusterMembershipRole = "role" FlagIsGlobalNamespace = "global-namespace" FlagIsGlobalNamespaceAlias = []string{"gn"} FlagNamespaceData = "namespace-data" FlagNamespaceDataAlias = []string{"nd"} FlagPromoteNamespace = "promote-namespace" FlagEventID = "event-id" FlagEventIDAlias = []string{"eid"} FlagActivityID = "activity-id" FlagActivityIDAlias = []string{"aid"} FlagMaxFieldLength = "max-field-length" FlagMaxFieldLengthAlias = []string{"maxl"} FlagSecurityToken = "security-token" FlagSecurityTokenAlias = []string{"st"} FlagSkipErrorMode = "skip-errors" FlagSkipErrorModeAlias = []string{"serr"} FlagHeadersMode = "headers" FlagHeadersModeAlias = []string{"he"} FlagMessageType = "message-type" FlagMessageTypeAlias = []string{"mt"} FlagURL = "url" FlagIndex = "index" FlagBatchSize = "batch-size" FlagBatchSizeAlias = []string{"bs"} FlagMemoKey = "memo-key" FlagMemo = "memo" FlagMemoFile = "memo-file" FlagSearchAttributeKey = "search-attribute-key" FlagSearchAttributeValue = "search-attribute-value" FlagSearchAttributeType = "search-attribute-type" FlagAddBadBinary = "add-bad-binary" FlagRemoveBadBinary = "remove-bad-binary" FlagResetType = "reset-type" FlagResetReapplyType = "reset-reapply-type" FlagResetPointsOnly = "reset-points-only" FlagResetBadBinaryChecksum = "reset-bad-binary-checksum" FlagListQuery = "query" FlagListQueryAlias = []string{"q"} FlagListQueryUsage = "Filter results using SQL like query. See https://docs.temporal.io/docs/tctl/workflow/list#--query for details" FlagArchive = "archived" FlagArchiveAlias = []string{"a"} FlagBatchType = "batch-type" FlagBatchTypeAlias = []string{"bt"} FlagSignalName = "signal-name" FlagSignalNameAlias = []string{"sn"} FlagTaskID = "task-id" FlagTaskType = "task-type" FlagMinReadLevel = "min-read-level" FlagMaxReadLevel = "max-read-level" FlagTaskVisibilityTimestamp = "task-timestamp" FlagMinVisibilityTimestamp = "min-visibility-ts" FlagMaxVisibilityTimestamp = "max-visibility-ts" FlagStartingRPS = "starting-rps" FlagRPS = "rps" FlagJobID = "job-id" FlagJobIDAlias = []string{"jid"} FlagYes = "yes" FlagYesAlias = []string{"y"} FlagServiceConfigDir = "service-config-dir" FlagServiceConfigDirAlias = []string{"scd"} FlagServiceEnv = "service-env" FlagServiceEnvAlias = []string{"se"} FlagServiceZone = "service-zone" FlagServiceZoneAlias = []string{"sz"} FlagEnableTLS = "tls" FlagTLSCertPath = "tls-cert-path" FlagTLSKeyPath = "tls-key-path" FlagTLSCaPath = "tls-ca-path" FlagTLSDisableHostVerification = "tls-disable-host-verification" FlagTLSServerName = "tls-server-name" FlagLastMessageID = "last-message-id" FlagConcurrency = "concurrency" FlagReportRate = "report-rate" FlagLowerShardBound = "lower-shard-bound" FlagUpperShardBound = "upper-shard-bound" FlagInputDirectory = "input-directory" FlagDataConverterPlugin = "data-converter-plugin" FlagCodecAuth = "codec-auth" FlagCodecEndpoint = "codec-endpoint" FlagWebURL = "web-ui-url" FlagHeadersProviderPlugin = "headers-provider-plugin" FlagHeadersProviderPluginOptions = "headers-provider-plugin-options" FlagVersion = "version" FlagPort = "port" FlagEnableConnection = "enable-connection" FlagFollowAlias = []string{"f"} FlagType = "type" FlagScheduleID = "schedule-id" FlagScheduleIDAlias = []string{"sid"} FlagOverlapPolicy = "overlap-policy" FlagCalendar = "calendar" FlagCalendarAlias = []string{"cal"} FlagInterval = "interval" FlagStartTime = "start-time" FlagEndTime = "end-time" FlagJitter = "jitter" FlagTimeZone = "time-zone" FlagTimeZoneAlias = []string{"tz"} FlagInitialNotes = "initial-notes" FlagInitialPaused = "initial-paused" FlagRemainingActions = "remaining-actions" FlagCatchupWindow = "catchup-window" FlagPauseOnFailure = "pause-on-failure" FlagPause = "pause" FlagUnpause = "unpause" FlagProtoType = "type" FlagHexData = "hex-data" FlagHexFile = "hex-file" FlagBinaryFile = "binary-file" FlagBase64Data = "base64-data" FlagBase64File = "base64-file" )
Flags used to specify cli command line arguments
Functions ¶
func AddSearchAttributes ¶ added in v1.16.2
AddSearchAttributes to add search attributes
func BackfillSchedule ¶ added in v1.16.2
func CancelWorkflow ¶
CancelWorkflow cancels a workflow execution
func ColorEvent ¶
func ColorEvent(e *historypb.HistoryEvent) string
ColorEvent takes an event and return string with color Event with color mapping rules:
Failed - red Timeout - yellow Canceled - magenta Completed - green Started - blue Others - default (white/black)
func CompleteActivity ¶
CompleteActivity completes an activity
func CountWorkflow ¶
CountWorkflow count number of workflows
func CreateSchedule ¶ added in v1.16.2
func DataConverter ¶
DataConverter provides a data converter over a websocket for Temporal web
func DeleteNamespace ¶ added in v1.16.2
DeleteNamespace deletes namespace.
func DeleteSchedule ¶ added in v1.16.2
func DeleteWorkflow ¶ added in v1.16.2
DeleteWorkflow deletes a workflow execution.
func DescribeBatchJob ¶
DescribeBatchJob describe the status of the batch job
func DescribeNamespace ¶
DescribeNamespace updates a namespace
func DescribeSchedule ¶ added in v1.16.2
func DescribeTaskQueue ¶
DescribeTaskQueue show pollers info of a given taskqueue
func DescribeWorkflow ¶
DescribeWorkflow show information about the specified workflow execution
func HistoryEventToString ¶
func HistoryEventToString(e *historypb.HistoryEvent, printFully bool, maxFieldLength int) string
HistoryEventToString convert HistoryEvent to string
func ListBatchJobs ¶
ListBatchJobs list the started batch jobs
func ListSchedules ¶ added in v1.16.2
func ListSearchAttributes ¶
ListSearchAttributes lists search attributes
func ListTaskQueuePartitions ¶
ListTaskQueuePartitions gets all the taskqueue partition and host information.
func ListWorkflow ¶
ListWorkflow list workflow executions based on filters
func NewContextWithCLIHeaders ¶ added in v1.16.1
func NewContextWithCLIHeaders() (context.Context, context.CancelFunc)
NewContextWithCLIHeaders creates context with version headers for CLI.
func NewContextWithTimeoutAndCLIHeaders ¶ added in v1.16.1
func NewContextWithTimeoutAndCLIHeaders(timeout time.Duration) (context.Context, context.CancelFunc)
NewContextWithTimeoutAndCLIHeaders creates context with timeout and version headers for CLI.
func QueryWorkflow ¶
QueryWorkflow query workflow execution
func QueryWorkflowUsingStackTrace ¶
QueryWorkflowUsingStackTrace query workflow execution using __stack_trace as query type
func RegisterNamespace ¶
RegisterNamespace register a namespace
func RemoveSearchAttributes ¶ added in v1.16.2
RemoveSearchAttributes to add search attributes
func ScanAllWorkflow ¶
ScanAllWorkflow list all workflow executions using Scan API.
func SetFactory ¶
func SetFactory(factory ClientFactory)
SetFactory is used to set the ClientFactory global
func SetRequiredNamespaceDataKeys ¶
func SetRequiredNamespaceDataKeys(keys []string)
SetRequiredNamespaceDataKeys will set requiredNamespaceDataKeys
func ShowHistory ¶
ShowHistory shows the history of given workflow execution based on workflowID and runID.
func SignalWorkflow ¶
SignalWorkflow signals a workflow execution
func StartWorkflow ¶ added in v1.16.2
StartWorkflow starts a new workflow execution and optionally prints progress
func TerminateBatchJob ¶
TerminateBatchJob stops abatch job
func TerminateWorkflow ¶
TerminateWorkflow terminates a workflow execution
func ToggleSchedule ¶ added in v1.16.2
func TriggerSchedule ¶ added in v1.16.2
func UpdateNamespace ¶
UpdateNamespace updates a namespace
func UpdateSchedule ¶ added in v1.16.2
Types ¶
type ClientFactory ¶
type ClientFactory interface {
FrontendClient(c *cli.Context) workflowservice.WorkflowServiceClient
OperatorClient(c *cli.Context) operatorservice.OperatorServiceClient
SDKClient(c *cli.Context, namespace string) sdkclient.Client
HealthClient(c *cli.Context) healthpb.HealthClient
}
ClientFactory is used to construct rpc clients
func NewClientFactory ¶
func NewClientFactory() ClientFactory
NewClientFactory creates a new ClientFactory
type HttpGetter ¶
HttpGetter defines http.Client.Get(...) as an interface so we can mock it
type PayloadRequest ¶
type PayloadResponse ¶
type SdkLogger ¶
type SdkLogger struct {
// contains filtered or unexported fields
}
func NewSdkLogger ¶
Source Files
¶
- activity.go
- activity_commands.go
- app.go
- batch.go
- batch_commands.go
- cluster.go
- cluster_commands.go
- commands.go
- config.go
- data_converter.go
- data_converter_commands.go
- defs.go
- factory.go
- flags.go
- namespace.go
- namespace_commands.go
- namespace_utils.go
- plugin.go
- schedule.go
- schedule_commands.go
- sdk_logger.go
- task_queue.go
- task_queue_commands.go
- use_dynamic_commands.go
- util.go
- workflow.go
- workflow_commands.go