temporalv1

package
v1.14.2 Latest Latest
Warning

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

 Go to latest Published: Jul 1, 2024 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	CLIFeature_name = map[int32]string{
		0: "CLI_FEATURE_DISALBED",
		1: "CLI_FEATURE_ENABLED",
	}
	CLIFeature_value = map[string]int32{
		"CLI_FEATURE_DISALBED": 0,
		"CLI_FEATURE_ENABLED":  1,
	}
)

Enum value maps for CLIFeature.

View Source 
var (
	IDReusePolicy_name = map[int32]string{
		0: "WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED",
		1: "WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE",
		2: "WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY",
		3: "WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE",
		4: "WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING",
	}
	IDReusePolicy_value = map[string]int32{
		"WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED":                 0,
		"WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE":             1,
		"WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY": 2,
		"WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE":            3,
		"WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING":        4,
	}
)

Enum value maps for IDReusePolicy.

View Source 
var (
	ParentClosePolicy_name = map[int32]string{
		0: "PARENT_CLOSE_POLICY_UNSPECIFIED",
		1: "PARENT_CLOSE_POLICY_TERMINATE",
		2: "PARENT_CLOSE_POLICY_ABANDON",
		3: "PARENT_CLOSE_POLICY_REQUEST_CANCEL",
	}
	ParentClosePolicy_value = map[string]int32{
		"PARENT_CLOSE_POLICY_UNSPECIFIED":    0,
		"PARENT_CLOSE_POLICY_TERMINATE":      1,
		"PARENT_CLOSE_POLICY_ABANDON":        2,
		"PARENT_CLOSE_POLICY_REQUEST_CANCEL": 3,
	}
)

Enum value maps for ParentClosePolicy.

View Source 
var (
	WaitPolicy_name = map[int32]string{
		0: "WAIT_POLICY_UNSPECIFIED",
		1: "WAIT_POLICY_ADMITTED",
		2: "WAIT_POLICY_ACCEPTED",
		3: "WAIT_POLICY_COMPLETED",
	}
	WaitPolicy_value = map[string]int32{
		"WAIT_POLICY_UNSPECIFIED": 0,
		"WAIT_POLICY_ADMITTED":    1,
		"WAIT_POLICY_ACCEPTED":    2,
		"WAIT_POLICY_COMPLETED":   3,
	}
)

Enum value maps for WaitPolicy.

View Source 
var (
	Patch_Version_name = map[int32]string{
		0: "PV_UNSPECIFIED",
		1: "PV_64",
	}
	Patch_Version_value = map[string]int32{
		"PV_UNSPECIFIED": 0,
		"PV_64":          1,
	}
)

Enum value maps for Patch_Version.

View Source 
var (
	Patch_Mode_name = map[int32]string{
		0: "PVM_ENABLED",
		1: "PVM_MARKER",
		2: "PVM_REMOVED",
		3: "PVM_DISABLED",
	}
	Patch_Mode_value = map[string]int32{
		"PVM_ENABLED":  0,
		"PVM_MARKER":   1,
		"PVM_REMOVED":  2,
		"PVM_DISABLED": 3,
	}
)

Enum value maps for Patch_Mode.

View Source 
var (
	// optional temporal.v1.ServiceOptions service = 7233;
	E_Service = &file_temporal_v1_temporal_proto_extTypes[0]
	// optional temporal.v1.CLIOptions cli = 7234;
	E_Cli = &file_temporal_v1_temporal_proto_extTypes[1]
)

Extension fields to descriptorpb.ServiceOptions.

View Source 
var (
	// optional temporal.v1.ActivityOptions activity = 7234;
	E_Activity = &file_temporal_v1_temporal_proto_extTypes[2]
	// optional temporal.v1.CommandOptions command = 7238;
	E_Command = &file_temporal_v1_temporal_proto_extTypes[3]
	// optional temporal.v1.QueryOptions query = 7235;
	E_Query = &file_temporal_v1_temporal_proto_extTypes[4]
	// optional temporal.v1.SignalOptions signal = 7236;
	E_Signal = &file_temporal_v1_temporal_proto_extTypes[5]
	// optional temporal.v1.UpdateOptions update = 7237;
	E_Update = &file_temporal_v1_temporal_proto_extTypes[6]
	// optional temporal.v1.WorkflowOptions workflow = 7233;
	E_Workflow = &file_temporal_v1_temporal_proto_extTypes[7]
)

Extension fields to descriptorpb.MethodOptions.

View Source 
var File_temporal_v1_temporal_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ActivityOptions 

type ActivityOptions struct {

	// Fully-qualified activity name
	Name string `protobuf:"bytes,7,opt,name=name,proto3" json:"name,omitempty"`
	// Override default task queue for activity
	TaskQueue string `protobuf:"bytes,1,opt,name=task_queue,json=taskQueue,proto3" json:"task_queue,omitempty"`
	// Total time that a workflow is willing to wait for Activity to complete
	ScheduleToCloseTimeout *durationpb.Duration `` /* 131-byte string literal not displayed */
	// Time that the Activity Task can stay in the Task Queue before it is picked up by
	// a Worker
	ScheduleToStartTimeout *durationpb.Duration `` /* 131-byte string literal not displayed */
	// Maximum time of a single Activity execution attempt
	StartToCloseTimeout *durationpb.Duration `protobuf:"bytes,4,opt,name=start_to_close_timeout,json=startToCloseTimeout,proto3" json:"start_to_close_timeout,omitempty"`
	// Heartbeat interval. Activity must call Activity.RecordHeartbeat(ctx, "my-heartbeat")
	HeartbeatTimeout *durationpb.Duration `protobuf:"bytes,5,opt,name=heartbeat_timeout,json=heartbeatTimeout,proto3" json:"heartbeat_timeout,omitempty"`
	// WaitForCancellation - Whether to wait for canceled activity to be completed
	// (activity can be failed, completed, cancel accepted)
	WaitForCancellation bool `protobuf:"varint,8,opt,name=wait_for_cancellation,json=waitForCancellation,proto3" json:"wait_for_cancellation,omitempty"`
	// Specifies how to retry an Activity if an error occurs
	RetryPolicy *RetryPolicy `protobuf:"bytes,6,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
	// contains filtered or unexported fields
}

ActivityOptions identifies an rpc method as a Temporal activity definition, and describes available activity configuration options

func (*ActivityOptions) Descriptor deprecated 

func (*ActivityOptions) Descriptor() ([]byte, []int)

Deprecated: Use ActivityOptions.ProtoReflect.Descriptor instead.

func (*ActivityOptions) GetHeartbeatTimeout added in v1.0.0 

func (x *ActivityOptions) GetHeartbeatTimeout() *durationpb.Duration

func (*ActivityOptions) GetName added in v0.8.0 

func (x *ActivityOptions) GetName() string

func (*ActivityOptions) GetRetryPolicy added in v1.0.0 

func (x *ActivityOptions) GetRetryPolicy() *RetryPolicy

func (*ActivityOptions) GetScheduleToCloseTimeout added in v1.0.0 

func (x *ActivityOptions) GetScheduleToCloseTimeout() *durationpb.Duration

func (*ActivityOptions) GetScheduleToStartTimeout added in v1.0.0 

func (x *ActivityOptions) GetScheduleToStartTimeout() *durationpb.Duration

func (*ActivityOptions) GetStartToCloseTimeout added in v1.0.0 

func (x *ActivityOptions) GetStartToCloseTimeout() *durationpb.Duration

func (*ActivityOptions) GetTaskQueue added in v1.0.0 

func (x *ActivityOptions) GetTaskQueue() string

func (*ActivityOptions) GetWaitForCancellation added in v1.12.0 

func (x *ActivityOptions) GetWaitForCancellation() bool

func (*ActivityOptions) ProtoMessage 

func (*ActivityOptions) ProtoMessage()

func (*ActivityOptions) ProtoReflect 

func (x *ActivityOptions) ProtoReflect() protoreflect.Message

func (*ActivityOptions) Reset 

func (x *ActivityOptions) Reset()

func (*ActivityOptions) String 

func (x *ActivityOptions) String() string

type CLIFeature added in v1.0.0 

type CLIFeature int32

CLIFeature enumerates cli feature statuses 

const (
	CLIFeature_CLI_FEATURE_DISALBED CLIFeature = 0
	CLIFeature_CLI_FEATURE_ENABLED  CLIFeature = 1
)

func (CLIFeature) Descriptor added in v1.0.0 

func (CLIFeature) Descriptor() protoreflect.EnumDescriptor

func (CLIFeature) Enum added in v1.0.0 

func (x CLIFeature) Enum() *CLIFeature

func (CLIFeature) EnumDescriptor deprecated added in v1.0.0 

func (CLIFeature) EnumDescriptor() ([]byte, []int)

Deprecated: Use CLIFeature.Descriptor instead.

func (CLIFeature) Number added in v1.0.0 

func (x CLIFeature) Number() protoreflect.EnumNumber

func (CLIFeature) String added in v1.0.0 

func (x CLIFeature) String() string

func (CLIFeature) Type added in v1.0.0 

func (CLIFeature) Type() protoreflect.EnumType

type CLIOptions added in v1.2.0 

type CLIOptions struct {
	Ignore bool `protobuf:"varint,1,opt,name=ignore,proto3" json:"ignore,omitempty"`
	// contains filtered or unexported fields
}

func (*CLIOptions) Descriptor deprecated added in v1.2.0 

func (*CLIOptions) Descriptor() ([]byte, []int)

Deprecated: Use CLIOptions.ProtoReflect.Descriptor instead.

func (*CLIOptions) GetIgnore added in v1.2.0 

func (x *CLIOptions) GetIgnore() bool

func (*CLIOptions) ProtoMessage added in v1.2.0 

func (*CLIOptions) ProtoMessage()

func (*CLIOptions) ProtoReflect added in v1.2.0 

func (x *CLIOptions) ProtoReflect() protoreflect.Message

func (*CLIOptions) Reset added in v1.2.0 

func (x *CLIOptions) Reset()

func (*CLIOptions) String added in v1.2.0 

func (x *CLIOptions) String() string

type CommandOptions added in v1.2.0 

type CommandOptions struct {
	Ignore bool `protobuf:"varint,1,opt,name=ignore,proto3" json:"ignore,omitempty"`
	// contains filtered or unexported fields
}

func (*CommandOptions) Descriptor deprecated added in v1.2.0 

func (*CommandOptions) Descriptor() ([]byte, []int)

Deprecated: Use CommandOptions.ProtoReflect.Descriptor instead.

func (*CommandOptions) GetIgnore added in v1.2.0 

func (x *CommandOptions) GetIgnore() bool

func (*CommandOptions) ProtoMessage added in v1.2.0 

func (*CommandOptions) ProtoMessage()

func (*CommandOptions) ProtoReflect added in v1.2.0 

func (x *CommandOptions) ProtoReflect() protoreflect.Message

func (*CommandOptions) Reset added in v1.2.0 

func (x *CommandOptions) Reset()

func (*CommandOptions) String added in v1.2.0 

func (x *CommandOptions) String() string

type IDReusePolicy added in v0.2.0 

type IDReusePolicy int32

IDReusePolicy defines how new runs of a workflow with a particular ID may or may not be allowed. Note that it is *never* valid to have two actively running instances of the same workflow id. 

const (
	IDReusePolicy_WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED IDReusePolicy = 0
	// Allow starting a workflow execution using the same workflow id.
	IDReusePolicy_WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE IDReusePolicy = 1
	// Allow starting a workflow execution using the same workflow id, only when the last
	// execution's final state is one of [terminated, cancelled, timed out, failed].
	IDReusePolicy_WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY IDReusePolicy = 2
	// Do not permit re-use of the workflow id for this workflow. Future start workflow requests
	// could potentially change the policy, allowing re-use of the workflow id.
	IDReusePolicy_WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE IDReusePolicy = 3
	// If a workflow is running using the same workflow ID, terminate it and start a new one.
	// If no running workflow, then the behavior is the same as ALLOW_DUPLICATE
	IDReusePolicy_WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING IDReusePolicy = 4
)

func (IDReusePolicy) Descriptor added in v0.2.0 

func (IDReusePolicy) Descriptor() protoreflect.EnumDescriptor

func (IDReusePolicy) Enum added in v0.2.0 

func (x IDReusePolicy) Enum() *IDReusePolicy

func (IDReusePolicy) EnumDescriptor deprecated added in v0.2.0 

func (IDReusePolicy) EnumDescriptor() ([]byte, []int)

Deprecated: Use IDReusePolicy.Descriptor instead.

func (IDReusePolicy) Number added in v0.2.0 

func (x IDReusePolicy) Number() protoreflect.EnumNumber

func (IDReusePolicy) String added in v0.2.0 

func (x IDReusePolicy) String() string

func (IDReusePolicy) Type added in v0.2.0 

func (IDReusePolicy) Type() protoreflect.EnumType

type ParentClosePolicy added in v0.3.0 

type ParentClosePolicy int32

Defines how child workflows will react to their parent completing 

const (
	ParentClosePolicy_PARENT_CLOSE_POLICY_UNSPECIFIED ParentClosePolicy = 0
	// The child workflow will also terminate
	ParentClosePolicy_PARENT_CLOSE_POLICY_TERMINATE ParentClosePolicy = 1
	// The child workflow will do nothing
	ParentClosePolicy_PARENT_CLOSE_POLICY_ABANDON ParentClosePolicy = 2
	// Cancellation will be requested of the child workflow
	ParentClosePolicy_PARENT_CLOSE_POLICY_REQUEST_CANCEL ParentClosePolicy = 3
)

func (ParentClosePolicy) Descriptor added in v0.3.0 

func (ParentClosePolicy) Descriptor() protoreflect.EnumDescriptor

func (ParentClosePolicy) Enum added in v0.3.0 

func (x ParentClosePolicy) Enum() *ParentClosePolicy

func (ParentClosePolicy) EnumDescriptor deprecated added in v0.3.0 

func (ParentClosePolicy) EnumDescriptor() ([]byte, []int)

Deprecated: Use ParentClosePolicy.Descriptor instead.

func (ParentClosePolicy) Number added in v0.3.0 

func (x ParentClosePolicy) Number() protoreflect.EnumNumber

func (ParentClosePolicy) String added in v0.3.0 

func (x ParentClosePolicy) String() string

func (ParentClosePolicy) Type added in v0.3.0 

func (ParentClosePolicy) Type() protoreflect.EnumType

type Patch added in v1.13.0 

type Patch struct {
	Version Patch_Version `protobuf:"varint,1,opt,name=version,proto3,enum=temporal.v1.Patch_Version" json:"version,omitempty"`
	Mode    Patch_Mode    `protobuf:"varint,2,opt,name=mode,proto3,enum=temporal.v1.Patch_Mode" json:"mode,omitempty"`
	// contains filtered or unexported fields
}

Patch describes how a nondeterministic fix/feature introduced to generated code is implemented. By default, all patches are introduced in PVM_ENABLED mode. Once rollout of updated code has been completed and old workflows have closed and retention window passed (or certain that replay is no longer a risk), the prior code can be removed by switching to PVM_MARKER or removed entirely with PVM_REMOVED. Patch code can also be disabled explicitly using PVM_DISABLED.

func (*Patch) Descriptor deprecated added in v1.13.0 

func (*Patch) Descriptor() ([]byte, []int)

Deprecated: Use Patch.ProtoReflect.Descriptor instead.

func (*Patch) GetMode added in v1.13.0 

func (x *Patch) GetMode() Patch_Mode

func (*Patch) GetVersion added in v1.13.0 

func (x *Patch) GetVersion() Patch_Version

func (*Patch) ProtoMessage added in v1.13.0 

func (*Patch) ProtoMessage()

func (*Patch) ProtoReflect added in v1.13.0 

func (x *Patch) ProtoReflect() protoreflect.Message

func (*Patch) Reset added in v1.13.0 

func (x *Patch) Reset()

func (*Patch) String added in v1.13.0 

func (x *Patch) String() string

type Patch_Mode added in v1.13.0 

type Patch_Mode int32

enumerates all supported patch configurations 

const (
	// both patch and prior code present behind workflow versioning
	Patch_PVM_ENABLED Patch_Mode = 0
	// only patch code present, workflow version marker present
	Patch_PVM_MARKER Patch_Mode = 1
	// only patch code present, workflow version marker removed
	Patch_PVM_REMOVED Patch_Mode = 2
	// only prior code present, no patch code or workflow version marker introduced
	Patch_PVM_DISABLED Patch_Mode = 3
)

func (Patch_Mode) Descriptor added in v1.13.0 

func (Patch_Mode) Descriptor() protoreflect.EnumDescriptor

func (Patch_Mode) Enum added in v1.13.0 

func (x Patch_Mode) Enum() *Patch_Mode

func (Patch_Mode) EnumDescriptor deprecated added in v1.13.0 

func (Patch_Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use Patch_Mode.Descriptor instead.

func (Patch_Mode) Number added in v1.13.0 

func (x Patch_Mode) Number() protoreflect.EnumNumber

func (Patch_Mode) String added in v1.13.0 

func (x Patch_Mode) String() string

func (Patch_Mode) Type added in v1.13.0 

func (Patch_Mode) Type() protoreflect.EnumType

type Patch_Version added in v1.13.0 

type Patch_Version int32

enumerates all defined patch versions 

const (
	Patch_PV_UNSPECIFIED Patch_Version = 0
	// wraps expression evaluation in local activities within workflow contexts
	// details: https://cludden.github.io/protoc-gen-go-temporal/docs/guides/fix-versions#fix_version_64_expression_evaluation_local_activity
	Patch_PV_64 Patch_Version = 1
)

func (Patch_Version) Descriptor added in v1.13.0 

func (Patch_Version) Descriptor() protoreflect.EnumDescriptor

func (Patch_Version) Enum added in v1.13.0 

func (x Patch_Version) Enum() *Patch_Version

func (Patch_Version) EnumDescriptor deprecated added in v1.13.0 

func (Patch_Version) EnumDescriptor() ([]byte, []int)

Deprecated: Use Patch_Version.Descriptor instead.

func (Patch_Version) Number added in v1.13.0 

func (x Patch_Version) Number() protoreflect.EnumNumber

func (Patch_Version) String added in v1.13.0 

func (x Patch_Version) String() string

func (Patch_Version) Type added in v1.13.0 

func (Patch_Version) Type() protoreflect.EnumType

type QueryOptions 

type QueryOptions struct {

	// Fully-qualified query name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// XNS can be used to configure default activity options for xns workflow executions
	Xns *XNSActivityOptions `protobuf:"bytes,2,opt,name=xns,proto3" json:"xns,omitempty"`
	// Configure patches, by default, patches are introduced in enabled mode
	Patches []*Patch `protobuf:"bytes,3,rep,name=patches,proto3" json:"patches,omitempty"`
	// contains filtered or unexported fields
}

QueryOptions identifies an rpc method as a Temporal query definition, and describes available query configuration options

func (*QueryOptions) Descriptor deprecated 

func (*QueryOptions) Descriptor() ([]byte, []int)

Deprecated: Use QueryOptions.ProtoReflect.Descriptor instead.

func (*QueryOptions) GetName added in v1.0.0 

func (x *QueryOptions) GetName() string

func (*QueryOptions) GetPatches added in v1.13.0 

func (x *QueryOptions) GetPatches() []*Patch

func (*QueryOptions) GetXns added in v1.5.0 

func (x *QueryOptions) GetXns() *XNSActivityOptions

func (*QueryOptions) ProtoMessage 

func (*QueryOptions) ProtoMessage()

func (*QueryOptions) ProtoReflect 

func (x *QueryOptions) ProtoReflect() protoreflect.Message

func (*QueryOptions) Reset 

func (x *QueryOptions) Reset()

func (*QueryOptions) String 

func (x *QueryOptions) String() string

type RetryPolicy added in v0.3.0 

type RetryPolicy struct {
	InitialInterval        *durationpb.Duration `protobuf:"bytes,1,opt,name=initial_interval,json=initialInterval,proto3" json:"initial_interval,omitempty"`
	BackoffCoefficient     float64              `protobuf:"fixed64,2,opt,name=backoff_coefficient,json=backoffCoefficient,proto3" json:"backoff_coefficient,omitempty"`
	MaxInterval            *durationpb.Duration `protobuf:"bytes,3,opt,name=max_interval,json=maxInterval,proto3" json:"max_interval,omitempty"`
	MaxAttempts            int32                `protobuf:"varint,4,opt,name=max_attempts,json=maxAttempts,proto3" json:"max_attempts,omitempty"`
	NonRetryableErrorTypes []string             `` /* 131-byte string literal not displayed */
	// contains filtered or unexported fields
}

RetryPolicy describes configuration for activity or child workflow retries

func (*RetryPolicy) Descriptor deprecated added in v0.3.0 

func (*RetryPolicy) Descriptor() ([]byte, []int)

Deprecated: Use RetryPolicy.ProtoReflect.Descriptor instead.

func (*RetryPolicy) GetBackoffCoefficient added in v0.3.0 

func (x *RetryPolicy) GetBackoffCoefficient() float64

func (*RetryPolicy) GetInitialInterval added in v0.3.0 

func (x *RetryPolicy) GetInitialInterval() *durationpb.Duration

func (*RetryPolicy) GetMaxAttempts added in v0.3.0 

func (x *RetryPolicy) GetMaxAttempts() int32

func (*RetryPolicy) GetMaxInterval added in v0.3.0 

func (x *RetryPolicy) GetMaxInterval() *durationpb.Duration

func (*RetryPolicy) GetNonRetryableErrorTypes added in v0.3.0 

func (x *RetryPolicy) GetNonRetryableErrorTypes() []string

func (*RetryPolicy) ProtoMessage added in v0.3.0 

func (*RetryPolicy) ProtoMessage()

func (*RetryPolicy) ProtoReflect added in v0.3.0 

func (x *RetryPolicy) ProtoReflect() protoreflect.Message

func (*RetryPolicy) Reset added in v0.3.0 

func (x *RetryPolicy) Reset()

func (*RetryPolicy) String added in v0.3.0 

func (x *RetryPolicy) String() string

type ServiceOptions added in v0.2.0 

type ServiceOptions struct {

	// Configure patches, by default, patches are introduced in enabled mode
	Patches []*Patch `protobuf:"bytes,3,rep,name=patches,proto3" json:"patches,omitempty"`
	// Default namespace for child workflows, activities
	//
	// Deprecated: Marked as deprecated in temporal/v1/temporal.proto.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// Default task queue for all workflows, activities
	TaskQueue string `protobuf:"bytes,1,opt,name=task_queue,json=taskQueue,proto3" json:"task_queue,omitempty"`
	// contains filtered or unexported fields
}

ServiceOptions provides options that can be used to define common configuration shared by all methods

func (*ServiceOptions) Descriptor deprecated added in v0.2.0 

func (*ServiceOptions) Descriptor() ([]byte, []int)

Deprecated: Use ServiceOptions.ProtoReflect.Descriptor instead.

func (*ServiceOptions) GetNamespace deprecated added in v0.5.0 

func (x *ServiceOptions) GetNamespace() string

Deprecated: Marked as deprecated in temporal/v1/temporal.proto.

func (*ServiceOptions) GetPatches added in v1.13.0 

func (x *ServiceOptions) GetPatches() []*Patch

func (*ServiceOptions) GetTaskQueue added in v0.2.0 

func (x *ServiceOptions) GetTaskQueue() string

func (*ServiceOptions) ProtoMessage added in v0.2.0 

func (*ServiceOptions) ProtoMessage()

func (*ServiceOptions) ProtoReflect added in v0.2.0 

func (x *ServiceOptions) ProtoReflect() protoreflect.Message

func (*ServiceOptions) Reset added in v0.2.0 

func (x *ServiceOptions) Reset()

func (*ServiceOptions) String added in v0.2.0 

func (x *ServiceOptions) String() string

type SignalOptions 

type SignalOptions struct {

	// Fully-qualified signal name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// XNS can be used to configure default activity options for xns workflow executions
	Xns *XNSActivityOptions `protobuf:"bytes,2,opt,name=xns,proto3" json:"xns,omitempty"`
	// Configure patches, by default, patches are introduced in enabled mode
	Patches []*Patch `protobuf:"bytes,3,rep,name=patches,proto3" json:"patches,omitempty"`
	// contains filtered or unexported fields
}

SignalOptions identifies an rpc method as a Temporal singal definition, and describes available signal configuration options

func (*SignalOptions) Descriptor deprecated 

func (*SignalOptions) Descriptor() ([]byte, []int)

Deprecated: Use SignalOptions.ProtoReflect.Descriptor instead.

func (*SignalOptions) GetName added in v1.0.0 

func (x *SignalOptions) GetName() string

func (*SignalOptions) GetPatches added in v1.13.0 

func (x *SignalOptions) GetPatches() []*Patch

func (*SignalOptions) GetXns added in v1.5.0 

func (x *SignalOptions) GetXns() *XNSActivityOptions

func (*SignalOptions) ProtoMessage 

func (*SignalOptions) ProtoMessage()

func (*SignalOptions) ProtoReflect 

func (x *SignalOptions) ProtoReflect() protoreflect.Message

func (*SignalOptions) Reset 

func (x *SignalOptions) Reset()

func (*SignalOptions) String 

func (x *SignalOptions) String() string

type UpdateOptions added in v1.0.0 

type UpdateOptions struct {

	// ID expression
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Fully-qualified update name
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// Configure patches, by default, patches are introduced in enabled mode
	Patches []*Patch `protobuf:"bytes,6,rep,name=patches,proto3" json:"patches,omitempty"`
	// Include validation hook
	Validate bool `protobuf:"varint,2,opt,name=validate,proto3" json:"validate,omitempty"`
	// Default wait policy if not specified
	WaitForStage WaitPolicy `` /* 128-byte string literal not displayed */
	// Deprecated: Marked as deprecated in temporal/v1/temporal.proto.
	WaitPolicy WaitPolicy `protobuf:"varint,3,opt,name=wait_policy,json=waitPolicy,proto3,enum=temporal.v1.WaitPolicy" json:"wait_policy,omitempty"`
	// XNS can be used to configure default activity options for xns workflow executions
	Xns *XNSActivityOptions `protobuf:"bytes,5,opt,name=xns,proto3" json:"xns,omitempty"`
	// contains filtered or unexported fields
}

UpdateOptions identifies an rpc method as a Temporal update definition, and describes available update configuration options

func (*UpdateOptions) Descriptor deprecated added in v1.0.0 

func (*UpdateOptions) Descriptor() ([]byte, []int)

Deprecated: Use UpdateOptions.ProtoReflect.Descriptor instead.

func (*UpdateOptions) GetId added in v1.0.0 

func (x *UpdateOptions) GetId() string

func (*UpdateOptions) GetName added in v1.0.0 

func (x *UpdateOptions) GetName() string

func (*UpdateOptions) GetPatches added in v1.13.0 

func (x *UpdateOptions) GetPatches() []*Patch

func (*UpdateOptions) GetValidate added in v1.0.0 

func (x *UpdateOptions) GetValidate() bool

func (*UpdateOptions) GetWaitForStage added in v1.14.0 

func (x *UpdateOptions) GetWaitForStage() WaitPolicy

func (*UpdateOptions) GetWaitPolicy deprecated added in v1.0.0 

func (x *UpdateOptions) GetWaitPolicy() WaitPolicy

Deprecated: Marked as deprecated in temporal/v1/temporal.proto.

func (*UpdateOptions) GetXns added in v1.5.0 

func (x *UpdateOptions) GetXns() *XNSActivityOptions

func (*UpdateOptions) ProtoMessage added in v1.0.0 

func (*UpdateOptions) ProtoMessage()

func (*UpdateOptions) ProtoReflect added in v1.0.0 

func (x *UpdateOptions) ProtoReflect() protoreflect.Message

func (*UpdateOptions) Reset added in v1.0.0 

func (x *UpdateOptions) Reset()

func (*UpdateOptions) String added in v1.0.0 

func (x *UpdateOptions) String() string

type WaitPolicy added in v1.0.0 

type WaitPolicy int32

WaitPolicy used to indicate to the server how long the client wishes to wait for a return value from an UpdateWorkflow RPC 

const (
	WaitPolicy_WAIT_POLICY_UNSPECIFIED WaitPolicy = 0
	WaitPolicy_WAIT_POLICY_ADMITTED    WaitPolicy = 1
	WaitPolicy_WAIT_POLICY_ACCEPTED    WaitPolicy = 2
	WaitPolicy_WAIT_POLICY_COMPLETED   WaitPolicy = 3
)

func (WaitPolicy) Descriptor added in v1.0.0 

func (WaitPolicy) Descriptor() protoreflect.EnumDescriptor

func (WaitPolicy) Enum added in v1.0.0 

func (x WaitPolicy) Enum() *WaitPolicy

func (WaitPolicy) EnumDescriptor deprecated added in v1.0.0 

func (WaitPolicy) EnumDescriptor() ([]byte, []int)

Deprecated: Use WaitPolicy.Descriptor instead.

func (WaitPolicy) Number added in v1.0.0 

func (x WaitPolicy) Number() protoreflect.EnumNumber

func (WaitPolicy) String added in v1.0.0 

func (x WaitPolicy) String() string

func (WaitPolicy) Type added in v1.0.0 

func (WaitPolicy) Type() protoreflect.EnumType

type WorkflowOptions 

type WorkflowOptions struct {

	// Fully-qualified workflow name
	Name string `protobuf:"bytes,14,opt,name=name,proto3" json:"name,omitempty"`
	// List of additional names to register the workflow under. This can be used to migrate
	// to new naming conventions without breaking workflow history or existing clients.
	Aliases []string `protobuf:"bytes,17,rep,name=aliases,proto3" json:"aliases,omitempty"`
	// Queries supported by this workflow
	Query []*WorkflowOptions_Query `protobuf:"bytes,1,rep,name=query,proto3" json:"query,omitempty"`
	// Signals supported by this workflow
	Signal []*WorkflowOptions_Signal `protobuf:"bytes,2,rep,name=signal,proto3" json:"signal,omitempty"`
	// Updates supported by this workflow
	Update []*WorkflowOptions_Update `protobuf:"bytes,3,rep,name=update,proto3" json:"update,omitempty"`
	// The timeout for duration of workflow execution.
	// It includes retries and continue as new. Use WorkflowRunTimeout to limit execution time
	// of a single workflow run.
	ExecutionTimeout *durationpb.Duration `protobuf:"bytes,4,opt,name=execution_timeout,json=executionTimeout,proto3" json:"execution_timeout,omitempty"`
	// Id expression
	Id string `protobuf:"bytes,5,opt,name=id,proto3" json:"id,omitempty"`
	// Whether server allow reuse of workflow ID
	IdReusePolicy IDReusePolicy `` /* 134-byte string literal not displayed */
	// Specifies default namespace for child workflows
	//
	// Deprecated: Marked as deprecated in temporal/v1/temporal.proto.
	Namespace string `protobuf:"bytes,7,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// Specifies a default parent close policy for child workflows
	ParentClosePolicy ParentClosePolicy `` /* 150-byte string literal not displayed */
	// Configure patches, by default, patches are introduced in enabled mode
	Patches []*Patch `protobuf:"bytes,18,rep,name=patches,proto3" json:"patches,omitempty"`
	// Specifies how to retry an Workflow if an error occurs
	RetryPolicy *RetryPolicy `protobuf:"bytes,9,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
	// The timeout for duration of a single workflow run.
	RunTimeout *durationpb.Duration `protobuf:"bytes,10,opt,name=run_timeout,json=runTimeout,proto3" json:"run_timeout,omitempty"`
	// Bloblang mapping defining default workflow search attributes
	SearchAttributes string `protobuf:"bytes,15,opt,name=search_attributes,json=searchAttributes,proto3" json:"search_attributes,omitempty"`
	// Override service task queeu
	TaskQueue string `protobuf:"bytes,11,opt,name=task_queue,json=taskQueue,proto3" json:"task_queue,omitempty"`
	// The timeout for processing workflow task from the time the worker
	// pulled this task. If a workflow task is lost, it is retried after this timeout.
	// The resolution is seconds.
	TaskTimeout *durationpb.Duration `protobuf:"bytes,12,opt,name=task_timeout,json=taskTimeout,proto3" json:"task_timeout,omitempty"`
	// WaitForCancellation specifies whether to wait for canceled child workflow to be ended
	// (child workflow can be ended as: completed/failed/timedout/terminated/canceled)
	WaitForCancellation bool `protobuf:"varint,13,opt,name=wait_for_cancellation,json=waitForCancellation,proto3" json:"wait_for_cancellation,omitempty"`
	// XNS can be used to configure default activity options for xns workflow executions
	Xns *XNSActivityOptions `protobuf:"bytes,16,opt,name=xns,proto3" json:"xns,omitempty"`
	// contains filtered or unexported fields
}

WorkflowOptions identifies an rpc method as a Temporal workflow definition, and describes available workflow configuration options

func (*WorkflowOptions) Descriptor deprecated 

func (*WorkflowOptions) Descriptor() ([]byte, []int)

Deprecated: Use WorkflowOptions.ProtoReflect.Descriptor instead.

func (*WorkflowOptions) GetAliases added in v1.11.0 

func (x *WorkflowOptions) GetAliases() []string

func (*WorkflowOptions) GetExecutionTimeout added in v1.0.0 

func (x *WorkflowOptions) GetExecutionTimeout() *durationpb.Duration

func (*WorkflowOptions) GetId added in v1.0.0 

func (x *WorkflowOptions) GetId() string

func (*WorkflowOptions) GetIdReusePolicy added in v1.0.0 

func (x *WorkflowOptions) GetIdReusePolicy() IDReusePolicy

func (*WorkflowOptions) GetName added in v0.8.0 

func (x *WorkflowOptions) GetName() string

func (*WorkflowOptions) GetNamespace deprecated added in v1.0.0 

func (x *WorkflowOptions) GetNamespace() string

Deprecated: Marked as deprecated in temporal/v1/temporal.proto.

func (*WorkflowOptions) GetParentClosePolicy added in v1.0.0 

func (x *WorkflowOptions) GetParentClosePolicy() ParentClosePolicy

func (*WorkflowOptions) GetPatches added in v1.13.0 

func (x *WorkflowOptions) GetPatches() []*Patch

func (*WorkflowOptions) GetQuery 

func (x *WorkflowOptions) GetQuery() []*WorkflowOptions_Query

func (*WorkflowOptions) GetRetryPolicy added in v1.0.0 

func (x *WorkflowOptions) GetRetryPolicy() *RetryPolicy

func (*WorkflowOptions) GetRunTimeout added in v1.0.0 

func (x *WorkflowOptions) GetRunTimeout() *durationpb.Duration

func (*WorkflowOptions) GetSearchAttributes added in v1.0.0 

func (x *WorkflowOptions) GetSearchAttributes() string

func (*WorkflowOptions) GetSignal 

func (x *WorkflowOptions) GetSignal() []*WorkflowOptions_Signal

func (*WorkflowOptions) GetTaskQueue added in v1.0.0 

func (x *WorkflowOptions) GetTaskQueue() string

func (*WorkflowOptions) GetTaskTimeout added in v1.0.0 

func (x *WorkflowOptions) GetTaskTimeout() *durationpb.Duration

func (*WorkflowOptions) GetUpdate added in v1.0.0 

func (x *WorkflowOptions) GetUpdate() []*WorkflowOptions_Update

func (*WorkflowOptions) GetWaitForCancellation added in v1.0.0 

func (x *WorkflowOptions) GetWaitForCancellation() bool

func (*WorkflowOptions) GetXns added in v1.5.0 

func (x *WorkflowOptions) GetXns() *XNSActivityOptions

func (*WorkflowOptions) ProtoMessage 

func (*WorkflowOptions) ProtoMessage()

func (*WorkflowOptions) ProtoReflect 

func (x *WorkflowOptions) ProtoReflect() protoreflect.Message

func (*WorkflowOptions) Reset 

func (x *WorkflowOptions) Reset()

func (*WorkflowOptions) String 

func (x *WorkflowOptions) String() string

type WorkflowOptions_Query 

type WorkflowOptions_Query struct {

	// Query name
	Ref string `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// XNS can be used to configure default activity options for xns workflow executions
	Xns *XNSActivityOptions `protobuf:"bytes,2,opt,name=xns,proto3" json:"xns,omitempty"`
	// contains filtered or unexported fields
}

Query identifies a query supported by the worklow

func (*WorkflowOptions_Query) Descriptor deprecated 

func (*WorkflowOptions_Query) Descriptor() ([]byte, []int)

Deprecated: Use WorkflowOptions_Query.ProtoReflect.Descriptor instead.

func (*WorkflowOptions_Query) GetRef 

func (x *WorkflowOptions_Query) GetRef() string

func (*WorkflowOptions_Query) GetXns added in v1.5.0 

func (x *WorkflowOptions_Query) GetXns() *XNSActivityOptions

func (*WorkflowOptions_Query) ProtoMessage 

func (*WorkflowOptions_Query) ProtoMessage()

func (*WorkflowOptions_Query) ProtoReflect 

func (x *WorkflowOptions_Query) ProtoReflect() protoreflect.Message

func (*WorkflowOptions_Query) Reset 

func (x *WorkflowOptions_Query) Reset()

func (*WorkflowOptions_Query) String 

func (x *WorkflowOptions_Query) String() string

type WorkflowOptions_Signal 

type WorkflowOptions_Signal struct {

	// Signal name
	Ref string `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// Include convenience method for signal with start
	Start bool `protobuf:"varint,2,opt,name=start,proto3" json:"start,omitempty"`
	// XNS can be used to configure default activity options for xns workflow executions
	Xns *XNSActivityOptions `protobuf:"bytes,3,opt,name=xns,proto3" json:"xns,omitempty"`
	// contains filtered or unexported fields
}

Signal identifies a signal supported by the workflow

func (*WorkflowOptions_Signal) Descriptor deprecated 

func (*WorkflowOptions_Signal) Descriptor() ([]byte, []int)

Deprecated: Use WorkflowOptions_Signal.ProtoReflect.Descriptor instead.

func (*WorkflowOptions_Signal) GetRef 

func (x *WorkflowOptions_Signal) GetRef() string

func (*WorkflowOptions_Signal) GetStart added in v0.2.0 

func (x *WorkflowOptions_Signal) GetStart() bool

func (*WorkflowOptions_Signal) GetXns added in v1.5.0 

func (x *WorkflowOptions_Signal) GetXns() *XNSActivityOptions

func (*WorkflowOptions_Signal) ProtoMessage 

func (*WorkflowOptions_Signal) ProtoMessage()

func (*WorkflowOptions_Signal) ProtoReflect 

func (x *WorkflowOptions_Signal) ProtoReflect() protoreflect.Message

func (*WorkflowOptions_Signal) Reset 

func (x *WorkflowOptions_Signal) Reset()

func (*WorkflowOptions_Signal) String 

func (x *WorkflowOptions_Signal) String() string

type WorkflowOptions_Update added in v1.0.0 

type WorkflowOptions_Update struct {

	// Update name
	Ref string `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// XNS can be used to configure default activity options for xns workflow executions
	Xns *XNSActivityOptions `protobuf:"bytes,2,opt,name=xns,proto3" json:"xns,omitempty"`
	// contains filtered or unexported fields
}

Update identifies an update supported by the workflow

func (*WorkflowOptions_Update) Descriptor deprecated added in v1.0.0 

func (*WorkflowOptions_Update) Descriptor() ([]byte, []int)

Deprecated: Use WorkflowOptions_Update.ProtoReflect.Descriptor instead.

func (*WorkflowOptions_Update) GetRef added in v1.0.0 

func (x *WorkflowOptions_Update) GetRef() string

func (*WorkflowOptions_Update) GetXns added in v1.5.0 

func (x *WorkflowOptions_Update) GetXns() *XNSActivityOptions

func (*WorkflowOptions_Update) ProtoMessage added in v1.0.0 

func (*WorkflowOptions_Update) ProtoMessage()

func (*WorkflowOptions_Update) ProtoReflect added in v1.0.0 

func (x *WorkflowOptions_Update) ProtoReflect() protoreflect.Message

func (*WorkflowOptions_Update) Reset added in v1.0.0 

func (x *WorkflowOptions_Update) Reset()

func (*WorkflowOptions_Update) String added in v1.0.0 

func (x *WorkflowOptions_Update) String() string

type XNSActivityOptions added in v1.5.0 

type XNSActivityOptions struct {

	// Fully-qualified xns activity name
	Name string `protobuf:"bytes,7,opt,name=name,proto3" json:"name,omitempty"`
	// Override default task queue for activity
	TaskQueue string `protobuf:"bytes,1,opt,name=task_queue,json=taskQueue,proto3" json:"task_queue,omitempty"`
	// Total time that a workflow is willing to wait for Activity to complete
	ScheduleToCloseTimeout *durationpb.Duration `` /* 131-byte string literal not displayed */
	// Time that the Activity Task can stay in the Task Queue before it is picked up by
	// a Worker
	ScheduleToStartTimeout *durationpb.Duration `` /* 131-byte string literal not displayed */
	// Maximum time of a single Activity execution attempt
	StartToCloseTimeout *durationpb.Duration `protobuf:"bytes,4,opt,name=start_to_close_timeout,json=startToCloseTimeout,proto3" json:"start_to_close_timeout,omitempty"`
	// HeartbeatInterval configures the default heartbeat interval
	HeartbeatInterval *durationpb.Duration `protobuf:"bytes,8,opt,name=heartbeat_interval,json=heartbeatInterval,proto3" json:"heartbeat_interval,omitempty"`
	// Heartbeat timeout. Activity must call Activity.RecordHeartbeat(ctx, "my-heartbeat")
	HeartbeatTimeout *durationpb.Duration `protobuf:"bytes,5,opt,name=heartbeat_timeout,json=heartbeatTimeout,proto3" json:"heartbeat_timeout,omitempty"`
	// Specifies how to retry an Activity if an error occurs
	RetryPolicy *RetryPolicy `protobuf:"bytes,6,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
	// Specifies how activity cancellation is propagated for xns activities that support it
	ParentClosePolicy ParentClosePolicy `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*XNSActivityOptions) Descriptor deprecated added in v1.5.0 

func (*XNSActivityOptions) Descriptor() ([]byte, []int)

Deprecated: Use XNSActivityOptions.ProtoReflect.Descriptor instead.

func (*XNSActivityOptions) GetHeartbeatInterval added in v1.5.0 

func (x *XNSActivityOptions) GetHeartbeatInterval() *durationpb.Duration

func (*XNSActivityOptions) GetHeartbeatTimeout added in v1.5.0 

func (x *XNSActivityOptions) GetHeartbeatTimeout() *durationpb.Duration

func (*XNSActivityOptions) GetName added in v1.5.0 

func (x *XNSActivityOptions) GetName() string

func (*XNSActivityOptions) GetParentClosePolicy added in v1.13.1 

func (x *XNSActivityOptions) GetParentClosePolicy() ParentClosePolicy

func (*XNSActivityOptions) GetRetryPolicy added in v1.5.0 

func (x *XNSActivityOptions) GetRetryPolicy() *RetryPolicy

func (*XNSActivityOptions) GetScheduleToCloseTimeout added in v1.5.0 

func (x *XNSActivityOptions) GetScheduleToCloseTimeout() *durationpb.Duration

func (*XNSActivityOptions) GetScheduleToStartTimeout added in v1.5.0 

func (x *XNSActivityOptions) GetScheduleToStartTimeout() *durationpb.Duration

func (*XNSActivityOptions) GetStartToCloseTimeout added in v1.5.0 

func (x *XNSActivityOptions) GetStartToCloseTimeout() *durationpb.Duration

func (*XNSActivityOptions) GetTaskQueue added in v1.5.0 

func (x *XNSActivityOptions) GetTaskQueue() string

func (*XNSActivityOptions) ProtoMessage added in v1.5.0 

func (*XNSActivityOptions) ProtoMessage()

func (*XNSActivityOptions) ProtoReflect added in v1.5.0 

func (x *XNSActivityOptions) ProtoReflect() protoreflect.Message

func (*XNSActivityOptions) Reset added in v1.5.0 

func (x *XNSActivityOptions) Reset()

func (*XNSActivityOptions) String added in v1.5.0 

func (x *XNSActivityOptions) String() string

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.