temporalcli

package
v1.6.0 Latest Latest
Warning

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

Go to latest
Published: Feb 5, 2026 License: MIT Imports: 74 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Version = "0.0.0-DEV"

Version is the value put as the default command version. This is often replaced at build time via ldflags.

Functions

func CreatePayloads

func CreatePayloads(data [][]byte, metadata map[string][][]byte, isBase64 bool) (*common.Payloads, error)

CreatePayloads creates API Payload objects from given data and metadata slices. If metadata has an entry at a data index, it is used, otherwise it uses the metadata entry at index 0.

func Execute

func Execute(ctx context.Context, options CommandOptions)

Execute runs the Temporal CLI with the given context and options. This intentionally does not return an error but rather invokes Fail on the options.

func UnmarshalProtoJSONWithOptions

func UnmarshalProtoJSONWithOptions(b []byte, m proto.Message, jsonShorthandPayloads bool) error

func VersionString

func VersionString() string

Types

type CommandContext

type CommandContext struct {
	// This context is closed on interrupt
	context.Context
	Options                   CommandOptions
	DeprecatedEnvConfigValues map[string]map[string]string
	FlagsWithEnvVars          []*pflag.Flag

	// These values may not be available until after pre-run of main command
	Printer               *printer.Printer
	Logger                *slog.Logger
	JSONOutput            bool
	JSONShorthandPayloads bool

	// Is set to true if any command actually started running. This is a hack to workaround the fact
	// that cobra does not properly exit nonzero if an unknown command/subcommand is given.
	ActuallyRanCommand bool

	// Root/current command only set inside of pre-run
	RootCommand    *TemporalCommand
	CurrentCommand *cobra.Command
}

func NewCommandContext

func NewCommandContext(ctx context.Context, options CommandOptions) (*CommandContext, context.CancelFunc, error)

NewCommandContext creates a CommandContext for use by the rest of the CLI. Among other things, this parses the env config file and modifies options/flags according to the parameters set there.

A CommandContext and CancelFunc are always returned, even in the event of an error; this is so the CommandContext can be used to print an appropriate error message.

func (*CommandContext) BindFlagEnvVar

func (c *CommandContext) BindFlagEnvVar(flag *pflag.Flag, envVar string)

func (*CommandContext) MarshalFriendlyFailureBodyText

func (c *CommandContext) MarshalFriendlyFailureBodyText(f *failure.Failure, indent string) (s string)

Starts with newline

func (*CommandContext) MarshalFriendlyJSONPayloads

func (c *CommandContext) MarshalFriendlyJSONPayloads(m *common.Payloads) (json.RawMessage, error)

func (*CommandContext) MarshalProtoJSON

func (c *CommandContext) MarshalProtoJSON(m proto.Message) ([]byte, error)

Takes payload shorthand into account, can use MarshalProtoJSONNoPayloadShorthand if needed

func (*CommandContext) MarshalProtoJSONWithOptions

func (c *CommandContext) MarshalProtoJSONWithOptions(m proto.Message, jsonShorthandPayloads bool) ([]byte, error)

func (*CommandContext) UnmarshalProtoJSON

func (c *CommandContext) UnmarshalProtoJSON(b []byte, m proto.Message) error

type CommandOptions

type CommandOptions struct {
	// IOStreams defaults to OS values.
	IOStreams

	// If empty, assumed to be os.Args[1:]
	Args []string
	// Deprecated `--env` and `--env-file` approach
	DeprecatedEnvConfig DeprecatedEnvConfig
	// If nil, [envconfig.EnvLookupOS] is used.
	EnvLookup envconfig.EnvLookup

	// Defaults to logging error then os.Exit(1)
	Fail func(error)

	AdditionalClientGRPCDialOptions []grpc.DialOption
}

type DeploymentNameOptions

type DeploymentNameOptions struct {
	Name    string
	FlagSet *pflag.FlagSet
}

func (*DeploymentNameOptions) BuildFlags

func (v *DeploymentNameOptions) BuildFlags(f *pflag.FlagSet)

type DeploymentReferenceOptions

type DeploymentReferenceOptions struct {
	SeriesName string
	BuildId    string
	FlagSet    *pflag.FlagSet
}

func (*DeploymentReferenceOptions) BuildFlags

func (v *DeploymentReferenceOptions) BuildFlags(f *pflag.FlagSet)

type DeploymentVersionOptions

type DeploymentVersionOptions struct {
	DeploymentName string
	BuildId        string
	FlagSet        *pflag.FlagSet
}

func (*DeploymentVersionOptions) BuildFlags

func (v *DeploymentVersionOptions) BuildFlags(f *pflag.FlagSet)

type DeploymentVersionOrUnversionedOptions

type DeploymentVersionOrUnversionedOptions struct {
	DeploymentName string
	BuildId        string
	Unversioned    bool
	FlagSet        *pflag.FlagSet
}

func (*DeploymentVersionOrUnversionedOptions) BuildFlags

type DeprecatedEnvConfig

type DeprecatedEnvConfig struct {
	// If unset, defaulted to $HOME/.config/temporalio/temporal.yaml
	EnvConfigFile string
	// If unset, attempts to extract --env from Args (which defaults to "default")
	EnvConfigName string
	// If true, does not do any env config reading
	DisableEnvConfig bool
}

type IOStreams

type IOStreams struct {
	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer
}

type NexusEndpointConfigOptions

type NexusEndpointConfigOptions struct {
	Description     string
	DescriptionFile string
	TargetNamespace string
	TargetTaskQueue string
	TargetUrl       string
	FlagSet         *pflag.FlagSet
}

func (*NexusEndpointConfigOptions) BuildFlags

func (v *NexusEndpointConfigOptions) BuildFlags(f *pflag.FlagSet)

type NexusEndpointIdentityOptions

type NexusEndpointIdentityOptions struct {
	Name    string
	FlagSet *pflag.FlagSet
}

func (*NexusEndpointIdentityOptions) BuildFlags

func (v *NexusEndpointIdentityOptions) BuildFlags(f *pflag.FlagSet)

type OverlapPolicyOptions

type OverlapPolicyOptions struct {
	OverlapPolicy cliext.FlagStringEnum
	FlagSet       *pflag.FlagSet
}

func (*OverlapPolicyOptions) BuildFlags

func (v *OverlapPolicyOptions) BuildFlags(f *pflag.FlagSet)

type PayloadInputOptions

type PayloadInputOptions struct {
	Input       []string
	InputFile   []string
	InputMeta   []string
	InputBase64 bool
	FlagSet     *pflag.FlagSet
}

func (*PayloadInputOptions) BuildFlags

func (v *PayloadInputOptions) BuildFlags(f *pflag.FlagSet)

type QueryModifiersOptions

type QueryModifiersOptions struct {
	RejectCondition cliext.FlagStringEnum
	Headers         []string
	FlagSet         *pflag.FlagSet
}

func (*QueryModifiersOptions) BuildFlags

func (v *QueryModifiersOptions) BuildFlags(f *pflag.FlagSet)

type RawValue

type RawValue struct{ Payload *common.Payload }

type ScheduleConfigurationOptions

type ScheduleConfigurationOptions struct {
	Calendar                []string
	CatchupWindow           cliext.FlagDuration
	Cron                    []string
	EndTime                 cliext.FlagTimestamp
	Interval                []string
	Jitter                  cliext.FlagDuration
	Notes                   string
	Paused                  bool
	PauseOnFailure          bool
	RemainingActions        int
	StartTime               cliext.FlagTimestamp
	TimeZone                string
	ScheduleSearchAttribute []string
	ScheduleMemo            []string
	FlagSet                 *pflag.FlagSet
}

func (*ScheduleConfigurationOptions) BuildFlags

func (v *ScheduleConfigurationOptions) BuildFlags(f *pflag.FlagSet)

type ScheduleIdOptions

type ScheduleIdOptions struct {
	ScheduleId string
	FlagSet    *pflag.FlagSet
}

func (*ScheduleIdOptions) BuildFlags

func (v *ScheduleIdOptions) BuildFlags(f *pflag.FlagSet)

type SharedWorkflowStartOptions

type SharedWorkflowStartOptions struct {
	WorkflowId       string
	Type             string
	TaskQueue        string
	RunTimeout       cliext.FlagDuration
	ExecutionTimeout cliext.FlagDuration
	TaskTimeout      cliext.FlagDuration
	SearchAttribute  []string
	Headers          []string
	Memo             []string
	StaticSummary    string
	StaticDetails    string
	PriorityKey      int
	FairnessKey      string
	FairnessWeight   float32
	FlagSet          *pflag.FlagSet
}

func (*SharedWorkflowStartOptions) BuildFlags

func (v *SharedWorkflowStartOptions) BuildFlags(f *pflag.FlagSet)

type SingleWorkflowOrBatchOptions

type SingleWorkflowOrBatchOptions struct {
	WorkflowId string
	Query      string
	RunId      string
	Reason     string
	Yes        bool
	Rps        float32
	Headers    []string
	FlagSet    *pflag.FlagSet
}

func (*SingleWorkflowOrBatchOptions) BuildFlags

func (v *SingleWorkflowOrBatchOptions) BuildFlags(f *pflag.FlagSet)

type TemporalActivityCommand

type TemporalActivityCommand struct {
	Parent  *TemporalCommand
	Command cobra.Command
	cliext.ClientOptions
}

func NewTemporalActivityCommand

func NewTemporalActivityCommand(cctx *CommandContext, parent *TemporalCommand) *TemporalActivityCommand

type TemporalActivityCompleteCommand

type TemporalActivityCompleteCommand struct {
	Parent  *TemporalActivityCommand
	Command cobra.Command
	WorkflowReferenceOptions
	ActivityId string
	Result     string
}

type TemporalActivityFailCommand

type TemporalActivityFailCommand struct {
	Parent  *TemporalActivityCommand
	Command cobra.Command
	WorkflowReferenceOptions
	ActivityId string
	Detail     string
	Reason     string
}

func NewTemporalActivityFailCommand

func NewTemporalActivityFailCommand(cctx *CommandContext, parent *TemporalActivityCommand) *TemporalActivityFailCommand

type TemporalActivityPauseCommand

type TemporalActivityPauseCommand struct {
	Parent  *TemporalActivityCommand
	Command cobra.Command
	WorkflowReferenceOptions
	ActivityId   string
	ActivityType string
	Identity     string
}

type TemporalActivityResetCommand

type TemporalActivityResetCommand struct {
	Parent  *TemporalActivityCommand
	Command cobra.Command
	SingleWorkflowOrBatchOptions
	ActivityId             string
	ActivityType           string
	KeepPaused             bool
	ResetAttempts          bool
	ResetHeartbeats        bool
	MatchAll               bool
	Jitter                 cliext.FlagDuration
	RestoreOriginalOptions bool
}

type TemporalActivityUnpauseCommand

type TemporalActivityUnpauseCommand struct {
	Parent  *TemporalActivityCommand
	Command cobra.Command
	SingleWorkflowOrBatchOptions
	ActivityId      string
	ActivityType    string
	ResetAttempts   bool
	ResetHeartbeats bool
	MatchAll        bool
	Jitter          cliext.FlagDuration
}

type TemporalActivityUpdateOptionsCommand

type TemporalActivityUpdateOptionsCommand struct {
	Parent  *TemporalActivityCommand
	Command cobra.Command
	SingleWorkflowOrBatchOptions
	ActivityId              string
	ActivityType            string
	MatchAll                bool
	TaskQueue               string
	ScheduleToCloseTimeout  cliext.FlagDuration
	ScheduleToStartTimeout  cliext.FlagDuration
	StartToCloseTimeout     cliext.FlagDuration
	HeartbeatTimeout        cliext.FlagDuration
	RetryInitialInterval    cliext.FlagDuration
	RetryMaximumInterval    cliext.FlagDuration
	RetryBackoffCoefficient float32
	RetryMaximumAttempts    int
	RestoreOriginalOptions  bool
}

type TemporalBatchCommand

type TemporalBatchCommand struct {
	Parent  *TemporalCommand
	Command cobra.Command
	cliext.ClientOptions
}

func NewTemporalBatchCommand

func NewTemporalBatchCommand(cctx *CommandContext, parent *TemporalCommand) *TemporalBatchCommand

type TemporalBatchDescribeCommand

type TemporalBatchDescribeCommand struct {
	Parent  *TemporalBatchCommand
	Command cobra.Command
	JobId   string
}

func NewTemporalBatchDescribeCommand

func NewTemporalBatchDescribeCommand(cctx *CommandContext, parent *TemporalBatchCommand) *TemporalBatchDescribeCommand

type TemporalBatchListCommand

type TemporalBatchListCommand struct {
	Parent  *TemporalBatchCommand
	Command cobra.Command
	Limit   int
}

func NewTemporalBatchListCommand

func NewTemporalBatchListCommand(cctx *CommandContext, parent *TemporalBatchCommand) *TemporalBatchListCommand

type TemporalBatchTerminateCommand

type TemporalBatchTerminateCommand struct {
	Parent  *TemporalBatchCommand
	Command cobra.Command
	JobId   string
	Reason  string
}

func NewTemporalBatchTerminateCommand

func NewTemporalBatchTerminateCommand(cctx *CommandContext, parent *TemporalBatchCommand) *TemporalBatchTerminateCommand

type TemporalCommand

type TemporalCommand struct {
	Command cobra.Command
	cliext.CommonOptions
}

func NewTemporalCommand

func NewTemporalCommand(cctx *CommandContext) *TemporalCommand

type TemporalConfigCommand

type TemporalConfigCommand struct {
	Parent  *TemporalCommand
	Command cobra.Command
}

func NewTemporalConfigCommand

func NewTemporalConfigCommand(cctx *CommandContext, parent *TemporalCommand) *TemporalConfigCommand

type TemporalConfigDeleteCommand

type TemporalConfigDeleteCommand struct {
	Parent  *TemporalConfigCommand
	Command cobra.Command
	Prop    string
}

func NewTemporalConfigDeleteCommand

func NewTemporalConfigDeleteCommand(cctx *CommandContext, parent *TemporalConfigCommand) *TemporalConfigDeleteCommand

type TemporalConfigDeleteProfileCommand

type TemporalConfigDeleteProfileCommand struct {
	Parent  *TemporalConfigCommand
	Command cobra.Command
}

type TemporalConfigGetCommand

type TemporalConfigGetCommand struct {
	Parent  *TemporalConfigCommand
	Command cobra.Command
	Prop    string
}

func NewTemporalConfigGetCommand

func NewTemporalConfigGetCommand(cctx *CommandContext, parent *TemporalConfigCommand) *TemporalConfigGetCommand

type TemporalConfigListCommand

type TemporalConfigListCommand struct {
	Parent  *TemporalConfigCommand
	Command cobra.Command
}

func NewTemporalConfigListCommand

func NewTemporalConfigListCommand(cctx *CommandContext, parent *TemporalConfigCommand) *TemporalConfigListCommand

type TemporalConfigSetCommand

type TemporalConfigSetCommand struct {
	Parent  *TemporalConfigCommand
	Command cobra.Command
	Prop    string
	Value   string
}

func NewTemporalConfigSetCommand

func NewTemporalConfigSetCommand(cctx *CommandContext, parent *TemporalConfigCommand) *TemporalConfigSetCommand

type TemporalEnvCommand

type TemporalEnvCommand struct {
	Parent  *TemporalCommand
	Command cobra.Command
}

func NewTemporalEnvCommand

func NewTemporalEnvCommand(cctx *CommandContext, parent *TemporalCommand) *TemporalEnvCommand

type TemporalEnvDeleteCommand

type TemporalEnvDeleteCommand struct {
	Parent  *TemporalEnvCommand
	Command cobra.Command
	Key     string
}

func NewTemporalEnvDeleteCommand

func NewTemporalEnvDeleteCommand(cctx *CommandContext, parent *TemporalEnvCommand) *TemporalEnvDeleteCommand

type TemporalEnvGetCommand

type TemporalEnvGetCommand struct {
	Parent  *TemporalEnvCommand
	Command cobra.Command
	Key     string
}

func NewTemporalEnvGetCommand

func NewTemporalEnvGetCommand(cctx *CommandContext, parent *TemporalEnvCommand) *TemporalEnvGetCommand

type TemporalEnvListCommand

type TemporalEnvListCommand struct {
	Parent  *TemporalEnvCommand
	Command cobra.Command
}

func NewTemporalEnvListCommand

func NewTemporalEnvListCommand(cctx *CommandContext, parent *TemporalEnvCommand) *TemporalEnvListCommand

type TemporalEnvSetCommand

type TemporalEnvSetCommand struct {
	Parent  *TemporalEnvCommand
	Command cobra.Command
	Key     string
	Value   string
}

func NewTemporalEnvSetCommand

func NewTemporalEnvSetCommand(cctx *CommandContext, parent *TemporalEnvCommand) *TemporalEnvSetCommand

type TemporalOperatorClusterCommand

type TemporalOperatorClusterCommand struct {
	Parent  *TemporalOperatorCommand
	Command cobra.Command
}

type TemporalOperatorClusterDescribeCommand

type TemporalOperatorClusterDescribeCommand struct {
	Parent  *TemporalOperatorClusterCommand
	Command cobra.Command
	Detail  bool
}

type TemporalOperatorClusterHealthCommand

type TemporalOperatorClusterHealthCommand struct {
	Parent  *TemporalOperatorClusterCommand
	Command cobra.Command
}

type TemporalOperatorClusterListCommand

type TemporalOperatorClusterListCommand struct {
	Parent  *TemporalOperatorClusterCommand
	Command cobra.Command
	Limit   int
}

type TemporalOperatorClusterRemoveCommand

type TemporalOperatorClusterRemoveCommand struct {
	Parent  *TemporalOperatorClusterCommand
	Command cobra.Command
	Name    string
}

type TemporalOperatorClusterSystemCommand

type TemporalOperatorClusterSystemCommand struct {
	Parent  *TemporalOperatorClusterCommand
	Command cobra.Command
}

type TemporalOperatorClusterUpsertCommand

type TemporalOperatorClusterUpsertCommand struct {
	Parent            *TemporalOperatorClusterCommand
	Command           cobra.Command
	FrontendAddress   string
	EnableConnection  bool
	EnableReplication bool
}

type TemporalOperatorCommand

type TemporalOperatorCommand struct {
	Parent  *TemporalCommand
	Command cobra.Command
	cliext.ClientOptions
}

func NewTemporalOperatorCommand

func NewTemporalOperatorCommand(cctx *CommandContext, parent *TemporalCommand) *TemporalOperatorCommand

type TemporalOperatorNamespaceCommand

type TemporalOperatorNamespaceCommand struct {
	Parent  *TemporalOperatorCommand
	Command cobra.Command
}

type TemporalOperatorNamespaceCreateCommand

type TemporalOperatorNamespaceCreateCommand struct {
	Parent                  *TemporalOperatorNamespaceCommand
	Command                 cobra.Command
	ActiveCluster           string
	Cluster                 []string
	Data                    []string
	Description             string
	Email                   string
	Global                  bool
	HistoryArchivalState    cliext.FlagStringEnum
	HistoryUri              string
	Retention               cliext.FlagDuration
	VisibilityArchivalState cliext.FlagStringEnum
	VisibilityUri           string
}

type TemporalOperatorNamespaceDeleteCommand

type TemporalOperatorNamespaceDeleteCommand struct {
	Parent  *TemporalOperatorNamespaceCommand
	Command cobra.Command
	Yes     bool
}

type TemporalOperatorNamespaceDescribeCommand

type TemporalOperatorNamespaceDescribeCommand struct {
	Parent      *TemporalOperatorNamespaceCommand
	Command     cobra.Command
	NamespaceId string
}

type TemporalOperatorNamespaceListCommand

type TemporalOperatorNamespaceListCommand struct {
	Parent  *TemporalOperatorNamespaceCommand
	Command cobra.Command
}

type TemporalOperatorNamespaceUpdateCommand

type TemporalOperatorNamespaceUpdateCommand struct {
	Parent                  *TemporalOperatorNamespaceCommand
	Command                 cobra.Command
	ActiveCluster           string
	Cluster                 []string
	Data                    []string
	Description             string
	Email                   string
	PromoteGlobal           bool
	HistoryArchivalState    cliext.FlagStringEnum
	HistoryUri              string
	ReplicationState        cliext.FlagStringEnum
	Retention               cliext.FlagDuration
	VisibilityArchivalState cliext.FlagStringEnum
	VisibilityUri           string
}

type TemporalOperatorNexusCommand

type TemporalOperatorNexusCommand struct {
	Parent  *TemporalOperatorCommand
	Command cobra.Command
}

type TemporalOperatorNexusEndpointCommand

type TemporalOperatorNexusEndpointCommand struct {
	Parent  *TemporalOperatorNexusCommand
	Command cobra.Command
}

type TemporalOperatorNexusEndpointListCommand

type TemporalOperatorNexusEndpointListCommand struct {
	Parent  *TemporalOperatorNexusEndpointCommand
	Command cobra.Command
}

type TemporalOperatorSearchAttributeCommand

type TemporalOperatorSearchAttributeCommand struct {
	Parent  *TemporalOperatorCommand
	Command cobra.Command
}

type TemporalOperatorSearchAttributeCreateCommand

type TemporalOperatorSearchAttributeCreateCommand struct {
	Parent  *TemporalOperatorSearchAttributeCommand
	Command cobra.Command
	Name    []string
	Type    cliext.FlagStringEnumArray
}

type TemporalOperatorSearchAttributeListCommand

type TemporalOperatorSearchAttributeListCommand struct {
	Parent  *TemporalOperatorSearchAttributeCommand
	Command cobra.Command
}

type TemporalOperatorSearchAttributeRemoveCommand

type TemporalOperatorSearchAttributeRemoveCommand struct {
	Parent  *TemporalOperatorSearchAttributeCommand
	Command cobra.Command
	Name    []string
	Yes     bool
}

type TemporalScheduleBackfillCommand

type TemporalScheduleBackfillCommand struct {
	Parent  *TemporalScheduleCommand
	Command cobra.Command
	OverlapPolicyOptions
	ScheduleIdOptions
	EndTime   cliext.FlagTimestamp
	StartTime cliext.FlagTimestamp
}

type TemporalScheduleCommand

type TemporalScheduleCommand struct {
	Parent  *TemporalCommand
	Command cobra.Command
	cliext.ClientOptions
}

func NewTemporalScheduleCommand

func NewTemporalScheduleCommand(cctx *CommandContext, parent *TemporalCommand) *TemporalScheduleCommand

type TemporalScheduleDeleteCommand

type TemporalScheduleDeleteCommand struct {
	Parent  *TemporalScheduleCommand
	Command cobra.Command
	ScheduleIdOptions
}

type TemporalScheduleDescribeCommand

type TemporalScheduleDescribeCommand struct {
	Parent  *TemporalScheduleCommand
	Command cobra.Command
	ScheduleIdOptions
}

type TemporalScheduleListCommand

type TemporalScheduleListCommand struct {
	Parent     *TemporalScheduleCommand
	Command    cobra.Command
	Long       bool
	ReallyLong bool
	Query      string
}

func NewTemporalScheduleListCommand

func NewTemporalScheduleListCommand(cctx *CommandContext, parent *TemporalScheduleCommand) *TemporalScheduleListCommand

type TemporalScheduleToggleCommand

type TemporalScheduleToggleCommand struct {
	Parent  *TemporalScheduleCommand
	Command cobra.Command
	ScheduleIdOptions
	Pause   bool
	Reason  string
	Unpause bool
}

type TemporalScheduleTriggerCommand

type TemporalScheduleTriggerCommand struct {
	Parent  *TemporalScheduleCommand
	Command cobra.Command
	ScheduleIdOptions
	OverlapPolicyOptions
}

type TemporalServerCommand

type TemporalServerCommand struct {
	Parent  *TemporalCommand
	Command cobra.Command
}

func NewTemporalServerCommand

func NewTemporalServerCommand(cctx *CommandContext, parent *TemporalCommand) *TemporalServerCommand

type TemporalServerStartDevCommand

type TemporalServerStartDevCommand struct {
	Parent             *TemporalServerCommand
	Command            cobra.Command
	DbFilename         string
	Namespace          []string
	Port               int
	HttpPort           int
	MetricsPort        int
	UiPort             int
	Headless           bool
	Ip                 string
	UiIp               string
	UiPublicPath       string
	UiAssetPath        string
	UiCodecEndpoint    string
	SqlitePragma       []string
	DynamicConfigValue []string
	LogConfig          bool
	SearchAttribute    []string
}

func NewTemporalServerStartDevCommand

func NewTemporalServerStartDevCommand(cctx *CommandContext, parent *TemporalServerCommand) *TemporalServerStartDevCommand

type TemporalTaskQueueCommand

type TemporalTaskQueueCommand struct {
	Parent  *TemporalCommand
	Command cobra.Command
	cliext.ClientOptions
}

func NewTemporalTaskQueueCommand

func NewTemporalTaskQueueCommand(cctx *CommandContext, parent *TemporalCommand) *TemporalTaskQueueCommand

type TemporalTaskQueueConfigCommand

type TemporalTaskQueueConfigCommand struct {
	Parent  *TemporalTaskQueueCommand
	Command cobra.Command
}

type TemporalTaskQueueConfigGetCommand

type TemporalTaskQueueConfigGetCommand struct {
	Parent        *TemporalTaskQueueConfigCommand
	Command       cobra.Command
	TaskQueue     string
	TaskQueueType cliext.FlagStringEnum
}

type TemporalTaskQueueConfigSetCommand

type TemporalTaskQueueConfigSetCommand struct {
	Parent                     *TemporalTaskQueueConfigCommand
	Command                    cobra.Command
	TaskQueue                  string
	TaskQueueType              cliext.FlagStringEnum
	QueueRpsLimit              string
	QueueRpsLimitReason        string
	FairnessKeyRpsLimitDefault string
	FairnessKeyRpsLimitReason  string
}

type TemporalTaskQueueDescribeCommand

type TemporalTaskQueueDescribeCommand struct {
	Parent              *TemporalTaskQueueCommand
	Command             cobra.Command
	TaskQueue           string
	TaskQueueType       cliext.FlagStringEnumArray
	SelectBuildId       []string
	SelectUnversioned   bool
	SelectAllActive     bool
	ReportReachability  bool
	LegacyMode          bool
	TaskQueueTypeLegacy cliext.FlagStringEnum
	PartitionsLegacy    int
	DisableStats        bool
	ReportConfig        bool
}

type TemporalTaskQueueGetBuildIdReachabilityCommand

type TemporalTaskQueueGetBuildIdReachabilityCommand struct {
	Parent           *TemporalTaskQueueCommand
	Command          cobra.Command
	BuildId          []string
	ReachabilityType cliext.FlagStringEnum
	TaskQueue        []string
}

type TemporalTaskQueueGetBuildIdsCommand

type TemporalTaskQueueGetBuildIdsCommand struct {
	Parent    *TemporalTaskQueueCommand
	Command   cobra.Command
	TaskQueue string
	MaxSets   int
}

type TemporalTaskQueueListPartitionCommand

type TemporalTaskQueueListPartitionCommand struct {
	Parent    *TemporalTaskQueueCommand
	Command   cobra.Command
	TaskQueue string
}

type TemporalTaskQueueUpdateBuildIdsAddNewCompatibleCommand

type TemporalTaskQueueUpdateBuildIdsAddNewCompatibleCommand struct {
	Parent                    *TemporalTaskQueueUpdateBuildIdsCommand
	Command                   cobra.Command
	BuildId                   string
	TaskQueue                 string
	ExistingCompatibleBuildId string
	SetAsDefault              bool
}

type TemporalTaskQueueUpdateBuildIdsAddNewDefaultCommand

type TemporalTaskQueueUpdateBuildIdsAddNewDefaultCommand struct {
	Parent    *TemporalTaskQueueUpdateBuildIdsCommand
	Command   cobra.Command
	BuildId   string
	TaskQueue string
}

type TemporalTaskQueueUpdateBuildIdsCommand

type TemporalTaskQueueUpdateBuildIdsCommand struct {
	Parent  *TemporalTaskQueueCommand
	Command cobra.Command
}

type TemporalTaskQueueUpdateBuildIdsPromoteIdInSetCommand

type TemporalTaskQueueUpdateBuildIdsPromoteIdInSetCommand struct {
	Parent    *TemporalTaskQueueUpdateBuildIdsCommand
	Command   cobra.Command
	BuildId   string
	TaskQueue string
}

type TemporalTaskQueueUpdateBuildIdsPromoteSetCommand

type TemporalTaskQueueUpdateBuildIdsPromoteSetCommand struct {
	Parent    *TemporalTaskQueueUpdateBuildIdsCommand
	Command   cobra.Command
	BuildId   string
	TaskQueue string
}

type TemporalTaskQueueVersioningAddRedirectRuleCommand

type TemporalTaskQueueVersioningAddRedirectRuleCommand struct {
	Parent        *TemporalTaskQueueVersioningCommand
	Command       cobra.Command
	SourceBuildId string
	TargetBuildId string
	Yes           bool
}

type TemporalTaskQueueVersioningCommand

type TemporalTaskQueueVersioningCommand struct {
	Parent    *TemporalTaskQueueCommand
	Command   cobra.Command
	TaskQueue string
}

type TemporalTaskQueueVersioningCommitBuildIdCommand

type TemporalTaskQueueVersioningCommitBuildIdCommand struct {
	Parent  *TemporalTaskQueueVersioningCommand
	Command cobra.Command
	BuildId string
	Force   bool
	Yes     bool
}

type TemporalTaskQueueVersioningDeleteAssignmentRuleCommand

type TemporalTaskQueueVersioningDeleteAssignmentRuleCommand struct {
	Parent    *TemporalTaskQueueVersioningCommand
	Command   cobra.Command
	RuleIndex int
	Force     bool
	Yes       bool
}

type TemporalTaskQueueVersioningDeleteRedirectRuleCommand

type TemporalTaskQueueVersioningDeleteRedirectRuleCommand struct {
	Parent        *TemporalTaskQueueVersioningCommand
	Command       cobra.Command
	SourceBuildId string
	Yes           bool
}

type TemporalTaskQueueVersioningGetRulesCommand

type TemporalTaskQueueVersioningGetRulesCommand struct {
	Parent  *TemporalTaskQueueVersioningCommand
	Command cobra.Command
}

type TemporalTaskQueueVersioningInsertAssignmentRuleCommand

type TemporalTaskQueueVersioningInsertAssignmentRuleCommand struct {
	Parent     *TemporalTaskQueueVersioningCommand
	Command    cobra.Command
	BuildId    string
	RuleIndex  int
	Percentage int
	Yes        bool
}

type TemporalTaskQueueVersioningReplaceAssignmentRuleCommand

type TemporalTaskQueueVersioningReplaceAssignmentRuleCommand struct {
	Parent     *TemporalTaskQueueVersioningCommand
	Command    cobra.Command
	BuildId    string
	RuleIndex  int
	Percentage int
	Yes        bool
	Force      bool
}

type TemporalTaskQueueVersioningReplaceRedirectRuleCommand

type TemporalTaskQueueVersioningReplaceRedirectRuleCommand struct {
	Parent        *TemporalTaskQueueVersioningCommand
	Command       cobra.Command
	SourceBuildId string
	TargetBuildId string
	Yes           bool
}

type TemporalWorkerCommand

type TemporalWorkerCommand struct {
	Parent  *TemporalCommand
	Command cobra.Command
	cliext.ClientOptions
}

func NewTemporalWorkerCommand

func NewTemporalWorkerCommand(cctx *CommandContext, parent *TemporalCommand) *TemporalWorkerCommand

type TemporalWorkerDeploymentCommand

type TemporalWorkerDeploymentCommand struct {
	Parent  *TemporalWorkerCommand
	Command cobra.Command
}

func NewTemporalWorkerDeploymentCommand

func NewTemporalWorkerDeploymentCommand(cctx *CommandContext, parent *TemporalWorkerCommand) *TemporalWorkerDeploymentCommand

type TemporalWorkerDeploymentDeleteCommand

type TemporalWorkerDeploymentDeleteCommand struct {
	Parent  *TemporalWorkerDeploymentCommand
	Command cobra.Command
	DeploymentNameOptions
}

type TemporalWorkerDeploymentDeleteVersionCommand

type TemporalWorkerDeploymentDeleteVersionCommand struct {
	Parent  *TemporalWorkerDeploymentCommand
	Command cobra.Command
	DeploymentVersionOptions
	SkipDrainage bool
}

type TemporalWorkerDeploymentDescribeCommand

type TemporalWorkerDeploymentDescribeCommand struct {
	Parent  *TemporalWorkerDeploymentCommand
	Command cobra.Command
	DeploymentNameOptions
}

type TemporalWorkerDeploymentDescribeVersionCommand

type TemporalWorkerDeploymentDescribeVersionCommand struct {
	Parent  *TemporalWorkerDeploymentCommand
	Command cobra.Command
	DeploymentVersionOptions
	ReportTaskQueueStats bool
}

type TemporalWorkerDeploymentListCommand

type TemporalWorkerDeploymentListCommand struct {
	Parent  *TemporalWorkerDeploymentCommand
	Command cobra.Command
}

type TemporalWorkerDeploymentManagerIdentityCommand

type TemporalWorkerDeploymentManagerIdentityCommand struct {
	Parent  *TemporalWorkerDeploymentCommand
	Command cobra.Command
}

type TemporalWorkerDeploymentManagerIdentitySetCommand

type TemporalWorkerDeploymentManagerIdentitySetCommand struct {
	Parent          *TemporalWorkerDeploymentManagerIdentityCommand
	Command         cobra.Command
	ManagerIdentity string
	Self            bool
	DeploymentName  string
	Yes             bool
}

type TemporalWorkerDeploymentManagerIdentityUnsetCommand

type TemporalWorkerDeploymentManagerIdentityUnsetCommand struct {
	Parent         *TemporalWorkerDeploymentManagerIdentityCommand
	Command        cobra.Command
	DeploymentName string
	Yes            bool
}

type TemporalWorkerDeploymentSetCurrentVersionCommand

type TemporalWorkerDeploymentSetCurrentVersionCommand struct {
	Parent  *TemporalWorkerDeploymentCommand
	Command cobra.Command
	DeploymentVersionOrUnversionedOptions
	IgnoreMissingTaskQueues bool
	AllowNoPollers          bool
	Yes                     bool
}

type TemporalWorkerDeploymentSetRampingVersionCommand

type TemporalWorkerDeploymentSetRampingVersionCommand struct {
	Parent  *TemporalWorkerDeploymentCommand
	Command cobra.Command
	DeploymentVersionOrUnversionedOptions
	Percentage              float32
	Delete                  bool
	IgnoreMissingTaskQueues bool
	AllowNoPollers          bool
	Yes                     bool
}

type TemporalWorkerDeploymentUpdateVersionMetadataCommand

type TemporalWorkerDeploymentUpdateVersionMetadataCommand struct {
	Parent  *TemporalWorkerDeploymentCommand
	Command cobra.Command
	DeploymentVersionOptions
	Metadata      []string
	RemoveEntries []string
}

type TemporalWorkerDescribeCommand

type TemporalWorkerDescribeCommand struct {
	Parent            *TemporalWorkerCommand
	Command           cobra.Command
	WorkerInstanceKey string
}

func NewTemporalWorkerDescribeCommand

func NewTemporalWorkerDescribeCommand(cctx *CommandContext, parent *TemporalWorkerCommand) *TemporalWorkerDescribeCommand

type TemporalWorkerListCommand

type TemporalWorkerListCommand struct {
	Parent  *TemporalWorkerCommand
	Command cobra.Command
	Query   string
	Limit   int
}

func NewTemporalWorkerListCommand

func NewTemporalWorkerListCommand(cctx *CommandContext, parent *TemporalWorkerCommand) *TemporalWorkerListCommand

type TemporalWorkflowCancelCommand

type TemporalWorkflowCancelCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	SingleWorkflowOrBatchOptions
}

type TemporalWorkflowCommand

type TemporalWorkflowCommand struct {
	Parent  *TemporalCommand
	Command cobra.Command
	cliext.ClientOptions
}

func NewTemporalWorkflowCommand

func NewTemporalWorkflowCommand(cctx *CommandContext, parent *TemporalCommand) *TemporalWorkflowCommand

type TemporalWorkflowCountCommand

type TemporalWorkflowCountCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	Query   string
}

type TemporalWorkflowDeleteCommand

type TemporalWorkflowDeleteCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	SingleWorkflowOrBatchOptions
}

type TemporalWorkflowDescribeCommand

type TemporalWorkflowDescribeCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	WorkflowReferenceOptions
	ResetPoints bool
	Raw         bool
}

type TemporalWorkflowExecuteUpdateWithStartCommand

type TemporalWorkflowExecuteUpdateWithStartCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	SharedWorkflowStartOptions
	WorkflowStartOptions
	PayloadInputOptions
	UpdateName                string
	UpdateFirstExecutionRunId string
	UpdateId                  string
	RunId                     string
	UpdateInput               []string
	UpdateInputFile           []string
	UpdateInputMeta           []string
	UpdateInputBase64         bool
}

type TemporalWorkflowFixHistoryJsonCommand

type TemporalWorkflowFixHistoryJsonCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	Source  string
	Target  string
}

type TemporalWorkflowListCommand

type TemporalWorkflowListCommand struct {
	Parent   *TemporalWorkflowCommand
	Command  cobra.Command
	Query    string
	Archived bool
	Limit    int
	PageSize int
}

func NewTemporalWorkflowListCommand

func NewTemporalWorkflowListCommand(cctx *CommandContext, parent *TemporalWorkflowCommand) *TemporalWorkflowListCommand

type TemporalWorkflowPauseCommand

type TemporalWorkflowPauseCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	WorkflowReferenceOptions
	Reason string
}

type TemporalWorkflowResetCommand

type TemporalWorkflowResetCommand struct {
	Parent         *TemporalWorkflowCommand
	Command        cobra.Command
	WorkflowId     string
	RunId          string
	EventId        int
	Reason         string
	ReapplyType    cliext.FlagStringEnum
	ReapplyExclude cliext.FlagStringEnumArray
	Type           cliext.FlagStringEnum
	BuildId        string
	Query          string
	Yes            bool
}

type TemporalWorkflowResetWithWorkflowUpdateOptionsCommand

type TemporalWorkflowResetWithWorkflowUpdateOptionsCommand struct {
	Parent  *TemporalWorkflowResetCommand
	Command cobra.Command
	WorkflowUpdateOptionsOptions
}

type TemporalWorkflowResultCommand

type TemporalWorkflowResultCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	WorkflowReferenceOptions
}

type TemporalWorkflowShowCommand

type TemporalWorkflowShowCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	WorkflowReferenceOptions
	Follow   bool
	Detailed bool
}

func NewTemporalWorkflowShowCommand

func NewTemporalWorkflowShowCommand(cctx *CommandContext, parent *TemporalWorkflowCommand) *TemporalWorkflowShowCommand

type TemporalWorkflowSignalCommand

type TemporalWorkflowSignalCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	SingleWorkflowOrBatchOptions
	PayloadInputOptions
	Name string
}

type TemporalWorkflowSignalWithStartCommand

type TemporalWorkflowSignalWithStartCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	SharedWorkflowStartOptions
	WorkflowStartOptions
	PayloadInputOptions
	SignalName        string
	SignalInput       []string
	SignalInputFile   []string
	SignalInputMeta   []string
	SignalInputBase64 bool
}

type TemporalWorkflowStackCommand

type TemporalWorkflowStackCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	WorkflowReferenceOptions
	RejectCondition cliext.FlagStringEnum
}

type TemporalWorkflowStartUpdateWithStartCommand

type TemporalWorkflowStartUpdateWithStartCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	SharedWorkflowStartOptions
	WorkflowStartOptions
	PayloadInputOptions
	UpdateName                string
	UpdateFirstExecutionRunId string
	UpdateWaitForStage        cliext.FlagStringEnum
	UpdateId                  string
	RunId                     string
	UpdateInput               []string
	UpdateInputFile           []string
	UpdateInputMeta           []string
	UpdateInputBase64         bool
}

type TemporalWorkflowTerminateCommand

type TemporalWorkflowTerminateCommand struct {
	Parent     *TemporalWorkflowCommand
	Command    cobra.Command
	WorkflowId string
	Query      string
	RunId      string
	Reason     string
	Yes        bool
	Rps        float32
}

type TemporalWorkflowTraceCommand

type TemporalWorkflowTraceCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	WorkflowReferenceOptions
	Fold        []string
	NoFold      bool
	Depth       int
	Concurrency int
}

type TemporalWorkflowUnpauseCommand

type TemporalWorkflowUnpauseCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	WorkflowReferenceOptions
	Reason string
}

type TemporalWorkflowUpdateCommand

type TemporalWorkflowUpdateCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
}

type TemporalWorkflowUpdateDescribeCommand

type TemporalWorkflowUpdateDescribeCommand struct {
	Parent  *TemporalWorkflowUpdateCommand
	Command cobra.Command
	UpdateTargetingOptions
}

type TemporalWorkflowUpdateOptionsCommand

type TemporalWorkflowUpdateOptionsCommand struct {
	Parent  *TemporalWorkflowCommand
	Command cobra.Command
	SingleWorkflowOrBatchOptions
	VersioningOverrideBehavior       cliext.FlagStringEnum
	VersioningOverrideDeploymentName string
	VersioningOverrideBuildId        string
}

type TemporalWorkflowUpdateResultCommand

type TemporalWorkflowUpdateResultCommand struct {
	Parent  *TemporalWorkflowUpdateCommand
	Command cobra.Command
	UpdateTargetingOptions
}

type UpdateStartingOptions

type UpdateStartingOptions struct {
	Name                string
	FirstExecutionRunId string
	WorkflowId          string
	UpdateId            string
	RunId               string
	Headers             []string
	FlagSet             *pflag.FlagSet
}

func (*UpdateStartingOptions) BuildFlags

func (v *UpdateStartingOptions) BuildFlags(f *pflag.FlagSet)

type UpdateTargetingOptions

type UpdateTargetingOptions struct {
	WorkflowId string
	UpdateId   string
	RunId      string
	FlagSet    *pflag.FlagSet
}

func (*UpdateTargetingOptions) BuildFlags

func (v *UpdateTargetingOptions) BuildFlags(f *pflag.FlagSet)

type WorkflowReferenceOptions

type WorkflowReferenceOptions struct {
	WorkflowId string
	RunId      string
	FlagSet    *pflag.FlagSet
}

func (*WorkflowReferenceOptions) BuildFlags

func (v *WorkflowReferenceOptions) BuildFlags(f *pflag.FlagSet)

type WorkflowStartOptions

type WorkflowStartOptions struct {
	Cron             string
	FailExisting     bool
	StartDelay       cliext.FlagDuration
	IdReusePolicy    cliext.FlagStringEnum
	IdConflictPolicy cliext.FlagStringEnum
	FlagSet          *pflag.FlagSet
}

func (*WorkflowStartOptions) BuildFlags

func (v *WorkflowStartOptions) BuildFlags(f *pflag.FlagSet)

type WorkflowUpdateOptionsOptions

type WorkflowUpdateOptionsOptions struct {
	VersioningOverrideBehavior       cliext.FlagStringEnum
	VersioningOverrideDeploymentName string
	VersioningOverrideBuildId        string
	FlagSet                          *pflag.FlagSet
}

func (*WorkflowUpdateOptionsOptions) BuildFlags

func (v *WorkflowUpdateOptionsOptions) BuildFlags(f *pflag.FlagSet)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL