rules

package
v1.62.13 Latest Latest
Warning

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

Go to latest
Published: May 28, 2026 License: MIT Imports: 7 Imported by: 7

Documentation

Overview

Code generated by protoc-gen-go-helpers. DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source
var File_temporal_api_rules_v1_message_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type WorkflowRule

type WorkflowRule struct {

	// Rule creation time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Rule specification
	Spec *WorkflowRuleSpec `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"`
	// Identity of the actor that created the rule
	// (-- api-linter: core::0140::prepositions=disabled
	//
	//	aip.dev/not-precedent: It is better reflect the intent this way, we will also have updated_by. --)
	//
	// (-- api-linter: core::0142::time-field-names=disabled
	//
	//	aip.dev/not-precedent: Same as above. All other options sounds clumsy --)
	CreatedByIdentity string `protobuf:"bytes,3,opt,name=created_by_identity,json=createdByIdentity,proto3" json:"created_by_identity,omitempty"`
	// Rule description.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

WorkflowRule describes a rule that can be applied to any workflow in this namespace.

func (*WorkflowRule) Descriptor deprecated

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

Deprecated: Use WorkflowRule.ProtoReflect.Descriptor instead.

func (*WorkflowRule) Equal

func (this *WorkflowRule) Equal(that interface{}) bool

Equal returns whether two WorkflowRule values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*WorkflowRule) GetCreateTime

func (x *WorkflowRule) GetCreateTime() *timestamppb.Timestamp

func (*WorkflowRule) GetCreatedByIdentity added in v1.49.0

func (x *WorkflowRule) GetCreatedByIdentity() string

func (*WorkflowRule) GetDescription added in v1.49.0

func (x *WorkflowRule) GetDescription() string

func (*WorkflowRule) GetSpec

func (x *WorkflowRule) GetSpec() *WorkflowRuleSpec

func (*WorkflowRule) Marshal

func (val *WorkflowRule) Marshal() ([]byte, error)

Marshal an object of type WorkflowRule to the protobuf v3 wire format

func (*WorkflowRule) ProtoMessage

func (*WorkflowRule) ProtoMessage()

func (*WorkflowRule) ProtoReflect

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

func (*WorkflowRule) Reset

func (x *WorkflowRule) Reset()

func (*WorkflowRule) Size

func (val *WorkflowRule) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkflowRule) String

func (x *WorkflowRule) String() string

func (*WorkflowRule) Unmarshal

func (val *WorkflowRule) Unmarshal(buf []byte) error

Unmarshal an object of type WorkflowRule from the protobuf v3 wire format

type WorkflowRuleAction

type WorkflowRuleAction struct {

	// Supported actions.
	//
	// Types that are valid to be assigned to Variant:
	//
	//	*WorkflowRuleAction_ActivityPause
	Variant isWorkflowRuleAction_Variant `protobuf_oneof:"variant"`
	// contains filtered or unexported fields
}

func (*WorkflowRuleAction) Descriptor deprecated

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

Deprecated: Use WorkflowRuleAction.ProtoReflect.Descriptor instead.

func (*WorkflowRuleAction) Equal

func (this *WorkflowRuleAction) Equal(that interface{}) bool

Equal returns whether two WorkflowRuleAction values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*WorkflowRuleAction) GetActivityPause

func (*WorkflowRuleAction) GetVariant

func (x *WorkflowRuleAction) GetVariant() isWorkflowRuleAction_Variant

func (*WorkflowRuleAction) Marshal

func (val *WorkflowRuleAction) Marshal() ([]byte, error)

Marshal an object of type WorkflowRuleAction to the protobuf v3 wire format

func (*WorkflowRuleAction) ProtoMessage

func (*WorkflowRuleAction) ProtoMessage()

func (*WorkflowRuleAction) ProtoReflect

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

func (*WorkflowRuleAction) Reset

func (x *WorkflowRuleAction) Reset()

func (*WorkflowRuleAction) Size

func (val *WorkflowRuleAction) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkflowRuleAction) String

func (x *WorkflowRuleAction) String() string

func (*WorkflowRuleAction) Unmarshal

func (val *WorkflowRuleAction) Unmarshal(buf []byte) error

Unmarshal an object of type WorkflowRuleAction from the protobuf v3 wire format

type WorkflowRuleAction_ActionActivityPause

type WorkflowRuleAction_ActionActivityPause struct {
	// contains filtered or unexported fields
}

func (*WorkflowRuleAction_ActionActivityPause) Descriptor deprecated

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

Deprecated: Use WorkflowRuleAction_ActionActivityPause.ProtoReflect.Descriptor instead.

func (*WorkflowRuleAction_ActionActivityPause) ProtoMessage

func (*WorkflowRuleAction_ActionActivityPause) ProtoReflect

func (*WorkflowRuleAction_ActionActivityPause) Reset

func (*WorkflowRuleAction_ActionActivityPause) String

type WorkflowRuleAction_ActivityPause

type WorkflowRuleAction_ActivityPause struct {
	ActivityPause *WorkflowRuleAction_ActionActivityPause `protobuf:"bytes,1,opt,name=activity_pause,json=activityPause,proto3,oneof"`
}

type WorkflowRuleSpec

type WorkflowRuleSpec struct {

	// The id of the new workflow rule. Must be unique within the namespace.
	// Can be set by the user, and can have business meaning.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Specifies how the rule should be triggered and evaluated.
	// Currently, only "activity start" type is supported.
	//
	// Types that are valid to be assigned to Trigger:
	//
	//	*WorkflowRuleSpec_ActivityStart
	Trigger isWorkflowRuleSpec_Trigger `protobuf_oneof:"trigger"`
	// Restricted Visibility query.
	// This query is used to filter workflows in this namespace to which this rule should apply.
	// It is applied to any running workflow each time a triggering event occurs, before the trigger predicate is evaluated.
	// The following workflow attributes are supported:
	// - WorkflowType
	// - WorkflowId
	// - StartTime
	// - ExecutionStatus
	VisibilityQuery string `protobuf:"bytes,3,opt,name=visibility_query,json=visibilityQuery,proto3" json:"visibility_query,omitempty"`
	// WorkflowRuleAction to be taken when the rule is triggered and predicate is matched.
	Actions []*WorkflowRuleAction `protobuf:"bytes,4,rep,name=actions,proto3" json:"actions,omitempty"`
	// Expiration time of the rule. After this time, the rule will be deleted.
	// Can be empty if the rule should never expire.
	ExpirationTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=expiration_time,json=expirationTime,proto3" json:"expiration_time,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkflowRuleSpec) Descriptor deprecated

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

Deprecated: Use WorkflowRuleSpec.ProtoReflect.Descriptor instead.

func (*WorkflowRuleSpec) Equal

func (this *WorkflowRuleSpec) Equal(that interface{}) bool

Equal returns whether two WorkflowRuleSpec values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*WorkflowRuleSpec) GetActions

func (x *WorkflowRuleSpec) GetActions() []*WorkflowRuleAction

func (*WorkflowRuleSpec) GetActivityStart

func (*WorkflowRuleSpec) GetExpirationTime

func (x *WorkflowRuleSpec) GetExpirationTime() *timestamppb.Timestamp

func (*WorkflowRuleSpec) GetId

func (x *WorkflowRuleSpec) GetId() string

func (*WorkflowRuleSpec) GetTrigger

func (x *WorkflowRuleSpec) GetTrigger() isWorkflowRuleSpec_Trigger

func (*WorkflowRuleSpec) GetVisibilityQuery

func (x *WorkflowRuleSpec) GetVisibilityQuery() string

func (*WorkflowRuleSpec) Marshal

func (val *WorkflowRuleSpec) Marshal() ([]byte, error)

Marshal an object of type WorkflowRuleSpec to the protobuf v3 wire format

func (*WorkflowRuleSpec) ProtoMessage

func (*WorkflowRuleSpec) ProtoMessage()

func (*WorkflowRuleSpec) ProtoReflect

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

func (*WorkflowRuleSpec) Reset

func (x *WorkflowRuleSpec) Reset()

func (*WorkflowRuleSpec) Size

func (val *WorkflowRuleSpec) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkflowRuleSpec) String

func (x *WorkflowRuleSpec) String() string

func (*WorkflowRuleSpec) Unmarshal

func (val *WorkflowRuleSpec) Unmarshal(buf []byte) error

Unmarshal an object of type WorkflowRuleSpec from the protobuf v3 wire format

type WorkflowRuleSpec_ActivityStart

type WorkflowRuleSpec_ActivityStart struct {
	ActivityStart *WorkflowRuleSpec_ActivityStartingTrigger `protobuf:"bytes,2,opt,name=activity_start,json=activityStart,proto3,oneof"`
}

type WorkflowRuleSpec_ActivityStartingTrigger

type WorkflowRuleSpec_ActivityStartingTrigger struct {

	// Activity predicate is a SQL-like string filter parameter.
	// It is used to match against workflow data.
	// The following activity attributes are supported as part of the predicate:
	// - ActivityType: An Activity Type is the mapping of a name to an Activity Definition..
	// - ActivityId: The ID of the activity.
	// - ActivityAttempt: The number attempts of the activity.
	// - BackoffInterval: The current amount of time between scheduled attempts of the activity.
	// - ActivityStatus: The status of the activity. Can be one of "Scheduled", "Started", "Paused".
	// - TaskQueue: The name of the task queue the workflow specified that the activity should run on.
	// Activity predicate support the following operators:
	//   - =, !=, >, >=, <, <=
	//   - AND, OR, ()
	//   - BETWEEN ... AND
	//     STARTS_WITH
	Predicate string `protobuf:"bytes,1,opt,name=predicate,proto3" json:"predicate,omitempty"`
	// contains filtered or unexported fields
}

Activity trigger will be triggered when an activity is about to start.

func (*WorkflowRuleSpec_ActivityStartingTrigger) Descriptor deprecated

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

Deprecated: Use WorkflowRuleSpec_ActivityStartingTrigger.ProtoReflect.Descriptor instead.

func (*WorkflowRuleSpec_ActivityStartingTrigger) GetPredicate

func (*WorkflowRuleSpec_ActivityStartingTrigger) ProtoMessage

func (*WorkflowRuleSpec_ActivityStartingTrigger) ProtoReflect

func (*WorkflowRuleSpec_ActivityStartingTrigger) Reset

func (*WorkflowRuleSpec_ActivityStartingTrigger) String

Jump to

Keyboard shortcuts

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