temporalv1

package
v0.8.0 Latest Latest
Warning

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

Go to latest
Published: Jun 23, 2023 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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 (
	// optional temporal.v1.WorkflowOptions workflow = 7233;
	E_Workflow = &file_temporal_v1_temporal_proto_extTypes[1]
	// optional temporal.v1.ActivityOptions activity = 7234;
	E_Activity = &file_temporal_v1_temporal_proto_extTypes[2]
	// optional temporal.v1.QueryOptions query = 7235;
	E_Query = &file_temporal_v1_temporal_proto_extTypes[3]
	// optional temporal.v1.SignalOptions signal = 7236;
	E_Signal = &file_temporal_v1_temporal_proto_extTypes[4]
)

Extension fields to descriptorpb.MethodOptions.

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

Extension fields to descriptorpb.ServiceOptions.

View Source
var File_temporal_v1_temporal_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ActivityOptions

type ActivityOptions struct {

	// Default configuration for ActivityOptions
	DefaultOptions *ActivityOptions_StartOptions `protobuf:"bytes,1,opt,name=default_options,json=defaultOptions,proto3" json:"default_options,omitempty"`
	// Activity name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,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) GetDefaultOptions

func (x *ActivityOptions) GetDefaultOptions() *ActivityOptions_StartOptions

func (*ActivityOptions) GetName added in v0.8.0

func (x *ActivityOptions) GetName() string

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 ActivityOptions_StartOptions

type ActivityOptions_StartOptions struct {

	// 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"`
	// 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
}

func (*ActivityOptions_StartOptions) Descriptor deprecated

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

Deprecated: Use ActivityOptions_StartOptions.ProtoReflect.Descriptor instead.

func (*ActivityOptions_StartOptions) GetHeartbeatTimeout

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

func (*ActivityOptions_StartOptions) GetRetryPolicy added in v0.2.0

func (x *ActivityOptions_StartOptions) GetRetryPolicy() *RetryPolicy

func (*ActivityOptions_StartOptions) GetScheduleToCloseTimeout

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

func (*ActivityOptions_StartOptions) GetScheduleToStartTimeout

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

func (*ActivityOptions_StartOptions) GetStartToCloseTimeout

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

func (*ActivityOptions_StartOptions) GetTaskQueue

func (x *ActivityOptions_StartOptions) GetTaskQueue() string

func (*ActivityOptions_StartOptions) ProtoMessage

func (*ActivityOptions_StartOptions) ProtoMessage()

func (*ActivityOptions_StartOptions) ProtoReflect

func (*ActivityOptions_StartOptions) Reset

func (x *ActivityOptions_StartOptions) Reset()

func (*ActivityOptions_StartOptions) 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) 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 (IDReusePolicy) String added in v0.2.0

func (x IDReusePolicy) String() string

func (IDReusePolicy) Type added in v0.2.0

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) Enum added in v0.3.0

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 (ParentClosePolicy) String added in v0.3.0

func (x ParentClosePolicy) String() string

func (ParentClosePolicy) Type added in v0.3.0

type QueryOptions

type QueryOptions struct {
	// 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) 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 {

	// Default namespace for child workflows, activities
	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
}

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

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

Deprecated: Use ServiceOptions.ProtoReflect.Descriptor instead.

func (*ServiceOptions) GetNamespace added in v0.5.0

func (x *ServiceOptions) GetNamespace() string

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 {
	// contains filtered or unexported fields
}

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

func (*SignalOptions) Descriptor deprecated

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

Deprecated: Use SignalOptions.ProtoReflect.Descriptor instead.

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 WorkflowOptions

type WorkflowOptions struct {

	// 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"`
	// Default configuration for StartWorklowOptions, ExecuteChildWorkflowOptions
	DefaultOptions *WorkflowOptions_StartOptions `protobuf:"bytes,6,opt,name=default_options,json=defaultOptions,proto3" json:"default_options,omitempty"`
	// Workflow name
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,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) GetDefaultOptions

func (x *WorkflowOptions) GetDefaultOptions() *WorkflowOptions_StartOptions

func (*WorkflowOptions) GetName added in v0.8.0

func (x *WorkflowOptions) GetName() string

func (*WorkflowOptions) GetQuery

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

func (*WorkflowOptions) GetSignal

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

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"`
	// 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) 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"`
	// 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) 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_StartOptions

type WorkflowOptions_StartOptions struct {

	// 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,6,opt,name=execution_timeout,json=executionTimeout,proto3" json:"execution_timeout,omitempty"`
	// Id expression
	Id string `protobuf:"bytes,12,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
	Namespace string `protobuf:"bytes,9,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// Specifies a default parent close policy for child workflows
	ParentClosePolicy ParentClosePolicy `` /* 151-byte string literal not displayed */
	// Specifies how to retry an Workflow if an error occurs
	RetryPolicy *RetryPolicy `protobuf:"bytes,2,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,7,opt,name=run_timeout,json=runTimeout,proto3" json:"run_timeout,omitempty"`
	// Override service task queeu
	TaskQueue string `protobuf:"bytes,1,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,8,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,11,opt,name=wait_for_cancellation,json=waitForCancellation,proto3" json:"wait_for_cancellation,omitempty"`
	// contains filtered or unexported fields
}

StartOptions describes default options for ExecuteWorkflow and ExecuteChildWorkflow

func (*WorkflowOptions_StartOptions) Descriptor deprecated

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

Deprecated: Use WorkflowOptions_StartOptions.ProtoReflect.Descriptor instead.

func (*WorkflowOptions_StartOptions) GetExecutionTimeout added in v0.2.0

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

func (*WorkflowOptions_StartOptions) GetId added in v0.7.0

func (*WorkflowOptions_StartOptions) GetIdReusePolicy added in v0.2.0

func (x *WorkflowOptions_StartOptions) GetIdReusePolicy() IDReusePolicy

func (*WorkflowOptions_StartOptions) GetNamespace added in v0.3.0

func (x *WorkflowOptions_StartOptions) GetNamespace() string

func (*WorkflowOptions_StartOptions) GetParentClosePolicy added in v0.3.0

func (x *WorkflowOptions_StartOptions) GetParentClosePolicy() ParentClosePolicy

func (*WorkflowOptions_StartOptions) GetRetryPolicy added in v0.7.5

func (x *WorkflowOptions_StartOptions) GetRetryPolicy() *RetryPolicy

func (*WorkflowOptions_StartOptions) GetRunTimeout added in v0.2.0

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

func (*WorkflowOptions_StartOptions) GetTaskQueue

func (x *WorkflowOptions_StartOptions) GetTaskQueue() string

func (*WorkflowOptions_StartOptions) GetTaskTimeout added in v0.2.0

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

func (*WorkflowOptions_StartOptions) GetWaitForCancellation added in v0.3.0

func (x *WorkflowOptions_StartOptions) GetWaitForCancellation() bool

func (*WorkflowOptions_StartOptions) ProtoMessage

func (*WorkflowOptions_StartOptions) ProtoMessage()

func (*WorkflowOptions_StartOptions) ProtoReflect

func (*WorkflowOptions_StartOptions) Reset

func (x *WorkflowOptions_StartOptions) Reset()

func (*WorkflowOptions_StartOptions) String

Jump to

Keyboard shortcuts

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