contracts

package
v0.49.0-alpha.4 Latest Latest
Warning

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

Go to latest
Published: Oct 3, 2024 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	StickyStrategy_name = map[int32]string{
		0: "SOFT",
		1: "HARD",
	}
	StickyStrategy_value = map[string]int32{
		"SOFT": 0,
		"HARD": 1,
	}
)

Enum value maps for StickyStrategy.

View Source
var (
	WorkflowKind_name = map[int32]string{
		0: "FUNCTION",
		1: "DURABLE",
		2: "DAG",
	}
	WorkflowKind_value = map[string]int32{
		"FUNCTION": 0,
		"DURABLE":  1,
		"DAG":      2,
	}
)

Enum value maps for WorkflowKind.

View Source
var (
	ConcurrencyLimitStrategy_name = map[int32]string{
		0: "CANCEL_IN_PROGRESS",
		1: "DROP_NEWEST",
		2: "QUEUE_NEWEST",
		3: "GROUP_ROUND_ROBIN",
	}
	ConcurrencyLimitStrategy_value = map[string]int32{
		"CANCEL_IN_PROGRESS": 0,
		"DROP_NEWEST":        1,
		"QUEUE_NEWEST":       2,
		"GROUP_ROUND_ROBIN":  3,
	}
)

Enum value maps for ConcurrencyLimitStrategy.

View Source
var (
	WorkerLabelComparator_name = map[int32]string{
		0: "EQUAL",
		1: "NOT_EQUAL",
		2: "GREATER_THAN",
		3: "GREATER_THAN_OR_EQUAL",
		4: "LESS_THAN",
		5: "LESS_THAN_OR_EQUAL",
	}
	WorkerLabelComparator_value = map[string]int32{
		"EQUAL":                 0,
		"NOT_EQUAL":             1,
		"GREATER_THAN":          2,
		"GREATER_THAN_OR_EQUAL": 3,
		"LESS_THAN":             4,
		"LESS_THAN_OR_EQUAL":    5,
	}
)

Enum value maps for WorkerLabelComparator.

View Source
var (
	RateLimitDuration_name = map[int32]string{
		0: "SECOND",
		1: "MINUTE",
		2: "HOUR",
		3: "DAY",
		4: "WEEK",
		5: "MONTH",
		6: "YEAR",
	}
	RateLimitDuration_value = map[string]int32{
		"SECOND": 0,
		"MINUTE": 1,
		"HOUR":   2,
		"DAY":    3,
		"WEEK":   4,
		"MONTH":  5,
		"YEAR":   6,
	}
)

Enum value maps for RateLimitDuration.

View Source
var File_workflows_proto protoreflect.FileDescriptor
View Source
var WorkflowService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "WorkflowService",
	HandlerType: (*WorkflowServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "PutWorkflow",
			Handler:    _WorkflowService_PutWorkflow_Handler,
		},
		{
			MethodName: "ScheduleWorkflow",
			Handler:    _WorkflowService_ScheduleWorkflow_Handler,
		},
		{
			MethodName: "TriggerWorkflow",
			Handler:    _WorkflowService_TriggerWorkflow_Handler,
		},
		{
			MethodName: "PutRateLimit",
			Handler:    _WorkflowService_PutRateLimit_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "workflows.proto",
}

WorkflowService_ServiceDesc is the grpc.ServiceDesc for WorkflowService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterWorkflowServiceServer

func RegisterWorkflowServiceServer(s grpc.ServiceRegistrar, srv WorkflowServiceServer)

Types

type ConcurrencyLimitStrategy added in v0.8.0

type ConcurrencyLimitStrategy int32
const (
	ConcurrencyLimitStrategy_CANCEL_IN_PROGRESS ConcurrencyLimitStrategy = 0
	ConcurrencyLimitStrategy_DROP_NEWEST        ConcurrencyLimitStrategy = 1
	ConcurrencyLimitStrategy_QUEUE_NEWEST       ConcurrencyLimitStrategy = 2
	ConcurrencyLimitStrategy_GROUP_ROUND_ROBIN  ConcurrencyLimitStrategy = 3
)

func (ConcurrencyLimitStrategy) Descriptor added in v0.8.0

func (ConcurrencyLimitStrategy) Enum added in v0.8.0

func (ConcurrencyLimitStrategy) EnumDescriptor deprecated added in v0.8.0

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

Deprecated: Use ConcurrencyLimitStrategy.Descriptor instead.

func (ConcurrencyLimitStrategy) Number added in v0.8.0

func (ConcurrencyLimitStrategy) String added in v0.8.0

func (x ConcurrencyLimitStrategy) String() string

func (ConcurrencyLimitStrategy) Type added in v0.8.0

type CreateStepRateLimit added in v0.19.0

type CreateStepRateLimit struct {
	Key             string             `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`                                                        // (required) the key for the rate limit
	Units           *int32             `protobuf:"varint,2,opt,name=units,proto3,oneof" json:"units,omitempty"`                                             // (optional) the number of units this step consumes
	KeyExpr         *string            `protobuf:"bytes,3,opt,name=key_expr,json=keyExpr,proto3,oneof" json:"key_expr,omitempty"`                           // (optional) a CEL expression for determining the rate limit key
	UnitsExpr       *string            `protobuf:"bytes,4,opt,name=units_expr,json=unitsExpr,proto3,oneof" json:"units_expr,omitempty"`                     // (optional) a CEL expression for determining the number of units consumed
	LimitValuesExpr *string            `protobuf:"bytes,5,opt,name=limit_values_expr,json=limitValuesExpr,proto3,oneof" json:"limit_values_expr,omitempty"` // (optional) a CEL expression for determining the total amount of rate limit units
	Duration        *RateLimitDuration `protobuf:"varint,6,opt,name=duration,proto3,enum=RateLimitDuration,oneof" json:"duration,omitempty"`                // (optional) the default rate limit window to use for dynamic rate limits
	// contains filtered or unexported fields
}

func (*CreateStepRateLimit) Descriptor deprecated added in v0.19.0

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

Deprecated: Use CreateStepRateLimit.ProtoReflect.Descriptor instead.

func (*CreateStepRateLimit) GetDuration added in v0.47.0

func (x *CreateStepRateLimit) GetDuration() RateLimitDuration

func (*CreateStepRateLimit) GetKey added in v0.19.0

func (x *CreateStepRateLimit) GetKey() string

func (*CreateStepRateLimit) GetKeyExpr added in v0.47.0

func (x *CreateStepRateLimit) GetKeyExpr() string

func (*CreateStepRateLimit) GetLimitValuesExpr added in v0.47.0

func (x *CreateStepRateLimit) GetLimitValuesExpr() string

func (*CreateStepRateLimit) GetUnits added in v0.19.0

func (x *CreateStepRateLimit) GetUnits() int32

func (*CreateStepRateLimit) GetUnitsExpr added in v0.47.0

func (x *CreateStepRateLimit) GetUnitsExpr() string

func (*CreateStepRateLimit) ProtoMessage added in v0.19.0

func (*CreateStepRateLimit) ProtoMessage()

func (*CreateStepRateLimit) ProtoReflect added in v0.19.0

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

func (*CreateStepRateLimit) Reset added in v0.19.0

func (x *CreateStepRateLimit) Reset()

func (*CreateStepRateLimit) String added in v0.19.0

func (x *CreateStepRateLimit) String() string

type CreateWorkflowJobOpts

type CreateWorkflowJobOpts struct {
	Name        string                    `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`               // (required) the job name
	Description string                    `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // (optional) the job description
	Steps       []*CreateWorkflowStepOpts `protobuf:"bytes,4,rep,name=steps,proto3" json:"steps,omitempty"`             // (required) the job steps
	// contains filtered or unexported fields
}

CreateWorkflowJobOpts represents options to create a workflow job.

func (*CreateWorkflowJobOpts) Descriptor deprecated

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

Deprecated: Use CreateWorkflowJobOpts.ProtoReflect.Descriptor instead.

func (*CreateWorkflowJobOpts) GetDescription

func (x *CreateWorkflowJobOpts) GetDescription() string

func (*CreateWorkflowJobOpts) GetName

func (x *CreateWorkflowJobOpts) GetName() string

func (*CreateWorkflowJobOpts) GetSteps

func (*CreateWorkflowJobOpts) ProtoMessage

func (*CreateWorkflowJobOpts) ProtoMessage()

func (*CreateWorkflowJobOpts) ProtoReflect

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

func (*CreateWorkflowJobOpts) Reset

func (x *CreateWorkflowJobOpts) Reset()

func (*CreateWorkflowJobOpts) String

func (x *CreateWorkflowJobOpts) String() string

type CreateWorkflowStepOpts

type CreateWorkflowStepOpts struct {
	ReadableId   string                          `protobuf:"bytes,1,opt,name=readable_id,json=readableId,proto3" json:"readable_id,omitempty"` // (required) the step name
	Action       string                          `protobuf:"bytes,2,opt,name=action,proto3" json:"action,omitempty"`                           // (required) the step action id
	Timeout      string                          `protobuf:"bytes,3,opt,name=timeout,proto3" json:"timeout,omitempty"`                         // (optional) the step timeout
	Inputs       string                          `protobuf:"bytes,4,opt,name=inputs,proto3" json:"inputs,omitempty"`                           // (optional) the step inputs, assuming string representation of JSON
	Parents      []string                        `protobuf:"bytes,5,rep,name=parents,proto3" json:"parents,omitempty"`                         // (optional) the step parents. if none are passed in, this is a root step
	UserData     string                          `protobuf:"bytes,6,opt,name=user_data,json=userData,proto3" json:"user_data,omitempty"`       // (optional) the custom step user data, assuming string representation of JSON
	Retries      int32                           `protobuf:"varint,7,opt,name=retries,proto3" json:"retries,omitempty"`                        // (optional) the number of retries for the step, default 0
	RateLimits   []*CreateStepRateLimit          `protobuf:"bytes,8,rep,name=rate_limits,json=rateLimits,proto3" json:"rate_limits,omitempty"` // (optional) the rate limits for the step
	WorkerLabels map[string]*DesiredWorkerLabels ``                                                                                            // (optional) the desired worker affinity state for the step
	/* 185-byte string literal not displayed */
	// contains filtered or unexported fields
}

CreateWorkflowStepOpts represents options to create a workflow step.

func (*CreateWorkflowStepOpts) Descriptor deprecated

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

Deprecated: Use CreateWorkflowStepOpts.ProtoReflect.Descriptor instead.

func (*CreateWorkflowStepOpts) GetAction

func (x *CreateWorkflowStepOpts) GetAction() string

func (*CreateWorkflowStepOpts) GetInputs

func (x *CreateWorkflowStepOpts) GetInputs() string

func (*CreateWorkflowStepOpts) GetParents

func (x *CreateWorkflowStepOpts) GetParents() []string

func (*CreateWorkflowStepOpts) GetRateLimits added in v0.19.0

func (x *CreateWorkflowStepOpts) GetRateLimits() []*CreateStepRateLimit

func (*CreateWorkflowStepOpts) GetReadableId

func (x *CreateWorkflowStepOpts) GetReadableId() string

func (*CreateWorkflowStepOpts) GetRetries added in v0.11.0

func (x *CreateWorkflowStepOpts) GetRetries() int32

func (*CreateWorkflowStepOpts) GetTimeout

func (x *CreateWorkflowStepOpts) GetTimeout() string

func (*CreateWorkflowStepOpts) GetUserData added in v0.10.2

func (x *CreateWorkflowStepOpts) GetUserData() string

func (*CreateWorkflowStepOpts) GetWorkerLabels added in v0.40.0

func (x *CreateWorkflowStepOpts) GetWorkerLabels() map[string]*DesiredWorkerLabels

func (*CreateWorkflowStepOpts) ProtoMessage

func (*CreateWorkflowStepOpts) ProtoMessage()

func (*CreateWorkflowStepOpts) ProtoReflect

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

func (*CreateWorkflowStepOpts) Reset

func (x *CreateWorkflowStepOpts) Reset()

func (*CreateWorkflowStepOpts) String

func (x *CreateWorkflowStepOpts) String() string

type CreateWorkflowVersionOpts

type CreateWorkflowVersionOpts struct {
	Name              string                   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`                                                      // (required) the workflow name
	Description       string                   `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`                                        // (optional) the workflow description
	Version           string                   `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`                                                // (required) the workflow version
	EventTriggers     []string                 `protobuf:"bytes,4,rep,name=event_triggers,json=eventTriggers,proto3" json:"event_triggers,omitempty"`               // (optional) event triggers for the workflow
	CronTriggers      []string                 `protobuf:"bytes,5,rep,name=cron_triggers,json=cronTriggers,proto3" json:"cron_triggers,omitempty"`                  // (optional) cron triggers for the workflow
	ScheduledTriggers []*timestamppb.Timestamp `protobuf:"bytes,6,rep,name=scheduled_triggers,json=scheduledTriggers,proto3" json:"scheduled_triggers,omitempty"`   // (optional) scheduled triggers for the workflow
	Jobs              []*CreateWorkflowJobOpts `protobuf:"bytes,7,rep,name=jobs,proto3" json:"jobs,omitempty"`                                                      // (required) the workflow jobs
	Concurrency       *WorkflowConcurrencyOpts `protobuf:"bytes,8,opt,name=concurrency,proto3" json:"concurrency,omitempty"`                                        // (optional) the workflow concurrency options
	ScheduleTimeout   *string                  `protobuf:"bytes,9,opt,name=schedule_timeout,json=scheduleTimeout,proto3,oneof" json:"schedule_timeout,omitempty"`   // (optional) the timeout for the schedule
	CronInput         *string                  `protobuf:"bytes,10,opt,name=cron_input,json=cronInput,proto3,oneof" json:"cron_input,omitempty"`                    // (optional) the input for the cron trigger
	OnFailureJob      *CreateWorkflowJobOpts   `protobuf:"bytes,11,opt,name=on_failure_job,json=onFailureJob,proto3,oneof" json:"on_failure_job,omitempty"`         // (optional) the job to run on failure
	Sticky            *StickyStrategy          `protobuf:"varint,12,opt,name=sticky,proto3,enum=StickyStrategy,oneof" json:"sticky,omitempty"`                      // (optional) the sticky strategy for assigning steps to workers
	Kind              *WorkflowKind            `protobuf:"varint,13,opt,name=kind,proto3,enum=WorkflowKind,oneof" json:"kind,omitempty"`                            // (optional) the kind of workflow
	DefaultPriority   *int32                   `protobuf:"varint,14,opt,name=default_priority,json=defaultPriority,proto3,oneof" json:"default_priority,omitempty"` // (optional) the priority of the workflow
	// contains filtered or unexported fields
}

CreateWorkflowVersionOpts represents options to create a workflow version.

func (*CreateWorkflowVersionOpts) Descriptor deprecated

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

Deprecated: Use CreateWorkflowVersionOpts.ProtoReflect.Descriptor instead.

func (*CreateWorkflowVersionOpts) GetConcurrency added in v0.8.0

func (*CreateWorkflowVersionOpts) GetCronInput added in v0.19.0

func (x *CreateWorkflowVersionOpts) GetCronInput() string

func (*CreateWorkflowVersionOpts) GetCronTriggers

func (x *CreateWorkflowVersionOpts) GetCronTriggers() []string

func (*CreateWorkflowVersionOpts) GetDefaultPriority added in v0.43.0

func (x *CreateWorkflowVersionOpts) GetDefaultPriority() int32

func (*CreateWorkflowVersionOpts) GetDescription

func (x *CreateWorkflowVersionOpts) GetDescription() string

func (*CreateWorkflowVersionOpts) GetEventTriggers

func (x *CreateWorkflowVersionOpts) GetEventTriggers() []string

func (*CreateWorkflowVersionOpts) GetJobs

func (*CreateWorkflowVersionOpts) GetKind added in v0.41.0

func (*CreateWorkflowVersionOpts) GetName

func (x *CreateWorkflowVersionOpts) GetName() string

func (*CreateWorkflowVersionOpts) GetOnFailureJob added in v0.25.0

func (x *CreateWorkflowVersionOpts) GetOnFailureJob() *CreateWorkflowJobOpts

func (*CreateWorkflowVersionOpts) GetScheduleTimeout added in v0.13.2

func (x *CreateWorkflowVersionOpts) GetScheduleTimeout() string

func (*CreateWorkflowVersionOpts) GetScheduledTriggers

func (x *CreateWorkflowVersionOpts) GetScheduledTriggers() []*timestamppb.Timestamp

func (*CreateWorkflowVersionOpts) GetSticky added in v0.40.0

func (*CreateWorkflowVersionOpts) GetVersion

func (x *CreateWorkflowVersionOpts) GetVersion() string

func (*CreateWorkflowVersionOpts) ProtoMessage

func (*CreateWorkflowVersionOpts) ProtoMessage()

func (*CreateWorkflowVersionOpts) ProtoReflect

func (*CreateWorkflowVersionOpts) Reset

func (x *CreateWorkflowVersionOpts) Reset()

func (*CreateWorkflowVersionOpts) String

func (x *CreateWorkflowVersionOpts) String() string

type DesiredWorkerLabels added in v0.40.0

type DesiredWorkerLabels struct {

	// value of the affinity
	StrValue *string `protobuf:"bytes,1,opt,name=strValue,proto3,oneof" json:"strValue,omitempty"`
	IntValue *int32  `protobuf:"varint,2,opt,name=intValue,proto3,oneof" json:"intValue,omitempty"`
	// *
	// (optional) Specifies whether the affinity setting is required.
	// If required, the worker will not accept actions that do not have a truthy affinity setting.
	//
	// Defaults to false.
	Required *bool `protobuf:"varint,3,opt,name=required,proto3,oneof" json:"required,omitempty"`
	// *
	// (optional) Specifies the comparator for the affinity setting.
	// If not set, the default is EQUAL.
	Comparator *WorkerLabelComparator `protobuf:"varint,4,opt,name=comparator,proto3,enum=WorkerLabelComparator,oneof" json:"comparator,omitempty"`
	// *
	// (optional) Specifies the weight of the affinity setting.
	// If not set, the default is 100.
	Weight *int32 `protobuf:"varint,5,opt,name=weight,proto3,oneof" json:"weight,omitempty"`
	// contains filtered or unexported fields
}

func (*DesiredWorkerLabels) Descriptor deprecated added in v0.40.0

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

Deprecated: Use DesiredWorkerLabels.ProtoReflect.Descriptor instead.

func (*DesiredWorkerLabels) GetComparator added in v0.40.0

func (x *DesiredWorkerLabels) GetComparator() WorkerLabelComparator

func (*DesiredWorkerLabels) GetIntValue added in v0.40.0

func (x *DesiredWorkerLabels) GetIntValue() int32

func (*DesiredWorkerLabels) GetRequired added in v0.40.0

func (x *DesiredWorkerLabels) GetRequired() bool

func (*DesiredWorkerLabels) GetStrValue added in v0.40.0

func (x *DesiredWorkerLabels) GetStrValue() string

func (*DesiredWorkerLabels) GetWeight added in v0.40.0

func (x *DesiredWorkerLabels) GetWeight() int32

func (*DesiredWorkerLabels) ProtoMessage added in v0.40.0

func (*DesiredWorkerLabels) ProtoMessage()

func (*DesiredWorkerLabels) ProtoReflect added in v0.40.0

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

func (*DesiredWorkerLabels) Reset added in v0.40.0

func (x *DesiredWorkerLabels) Reset()

func (*DesiredWorkerLabels) String added in v0.40.0

func (x *DesiredWorkerLabels) String() string

type ListWorkflowsRequest

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

ListWorkflowsRequest is the request for ListWorkflows.

func (*ListWorkflowsRequest) Descriptor deprecated

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

Deprecated: Use ListWorkflowsRequest.ProtoReflect.Descriptor instead.

func (*ListWorkflowsRequest) ProtoMessage

func (*ListWorkflowsRequest) ProtoMessage()

func (*ListWorkflowsRequest) ProtoReflect

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

func (*ListWorkflowsRequest) Reset

func (x *ListWorkflowsRequest) Reset()

func (*ListWorkflowsRequest) String

func (x *ListWorkflowsRequest) String() string

type PutRateLimitRequest added in v0.19.0

type PutRateLimitRequest struct {

	// (required) the global key for the rate limit
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// (required) the max limit for the rate limit (per unit of time)
	Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// (required) the duration of time for the rate limit (second|minute|hour)
	Duration RateLimitDuration `protobuf:"varint,3,opt,name=duration,proto3,enum=RateLimitDuration" json:"duration,omitempty"`
	// contains filtered or unexported fields
}

func (*PutRateLimitRequest) Descriptor deprecated added in v0.19.0

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

Deprecated: Use PutRateLimitRequest.ProtoReflect.Descriptor instead.

func (*PutRateLimitRequest) GetDuration added in v0.19.0

func (x *PutRateLimitRequest) GetDuration() RateLimitDuration

func (*PutRateLimitRequest) GetKey added in v0.19.0

func (x *PutRateLimitRequest) GetKey() string

func (*PutRateLimitRequest) GetLimit added in v0.19.0

func (x *PutRateLimitRequest) GetLimit() int32

func (*PutRateLimitRequest) ProtoMessage added in v0.19.0

func (*PutRateLimitRequest) ProtoMessage()

func (*PutRateLimitRequest) ProtoReflect added in v0.19.0

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

func (*PutRateLimitRequest) Reset added in v0.19.0

func (x *PutRateLimitRequest) Reset()

func (*PutRateLimitRequest) String added in v0.19.0

func (x *PutRateLimitRequest) String() string

type PutRateLimitResponse added in v0.19.0

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

func (*PutRateLimitResponse) Descriptor deprecated added in v0.19.0

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

Deprecated: Use PutRateLimitResponse.ProtoReflect.Descriptor instead.

func (*PutRateLimitResponse) ProtoMessage added in v0.19.0

func (*PutRateLimitResponse) ProtoMessage()

func (*PutRateLimitResponse) ProtoReflect added in v0.19.0

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

func (*PutRateLimitResponse) Reset added in v0.19.0

func (x *PutRateLimitResponse) Reset()

func (*PutRateLimitResponse) String added in v0.19.0

func (x *PutRateLimitResponse) String() string

type PutWorkflowRequest

type PutWorkflowRequest struct {
	Opts *CreateWorkflowVersionOpts `protobuf:"bytes,1,opt,name=opts,proto3" json:"opts,omitempty"`
	// contains filtered or unexported fields
}

func (*PutWorkflowRequest) Descriptor deprecated

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

Deprecated: Use PutWorkflowRequest.ProtoReflect.Descriptor instead.

func (*PutWorkflowRequest) GetOpts

func (*PutWorkflowRequest) ProtoMessage

func (*PutWorkflowRequest) ProtoMessage()

func (*PutWorkflowRequest) ProtoReflect

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

func (*PutWorkflowRequest) Reset

func (x *PutWorkflowRequest) Reset()

func (*PutWorkflowRequest) String

func (x *PutWorkflowRequest) String() string

type RateLimitDuration added in v0.19.0

type RateLimitDuration int32
const (
	RateLimitDuration_SECOND RateLimitDuration = 0
	RateLimitDuration_MINUTE RateLimitDuration = 1
	RateLimitDuration_HOUR   RateLimitDuration = 2
	RateLimitDuration_DAY    RateLimitDuration = 3
	RateLimitDuration_WEEK   RateLimitDuration = 4
	RateLimitDuration_MONTH  RateLimitDuration = 5
	RateLimitDuration_YEAR   RateLimitDuration = 6
)

func (RateLimitDuration) Descriptor added in v0.19.0

func (RateLimitDuration) Enum added in v0.19.0

func (RateLimitDuration) EnumDescriptor deprecated added in v0.19.0

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

Deprecated: Use RateLimitDuration.Descriptor instead.

func (RateLimitDuration) Number added in v0.19.0

func (RateLimitDuration) String added in v0.19.0

func (x RateLimitDuration) String() string

func (RateLimitDuration) Type added in v0.19.0

type ScheduleWorkflowRequest

type ScheduleWorkflowRequest struct {
	Name      string                   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Schedules []*timestamppb.Timestamp `protobuf:"bytes,2,rep,name=schedules,proto3" json:"schedules,omitempty"`
	// (optional) the input data for the workflow
	Input string `protobuf:"bytes,3,opt,name=input,proto3" json:"input,omitempty"`
	// (optional) the parent workflow run id
	ParentId *string `protobuf:"bytes,4,opt,name=parent_id,json=parentId,proto3,oneof" json:"parent_id,omitempty"`
	// (optional) the parent step run id
	ParentStepRunId *string `protobuf:"bytes,5,opt,name=parent_step_run_id,json=parentStepRunId,proto3,oneof" json:"parent_step_run_id,omitempty"`
	// (optional) the index of the child workflow. if this is set, matches on the index or the
	// child key will be a no-op, even if the schedule has changed.
	ChildIndex *int32 `protobuf:"varint,6,opt,name=child_index,json=childIndex,proto3,oneof" json:"child_index,omitempty"`
	// (optional) the key for the child. if this is set, matches on the index or the
	// child key will be a no-op, even if the schedule has changed.
	ChildKey *string `protobuf:"bytes,7,opt,name=child_key,json=childKey,proto3,oneof" json:"child_key,omitempty"`
	// contains filtered or unexported fields
}

func (*ScheduleWorkflowRequest) Descriptor deprecated

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

Deprecated: Use ScheduleWorkflowRequest.ProtoReflect.Descriptor instead.

func (*ScheduleWorkflowRequest) GetChildIndex added in v0.18.0

func (x *ScheduleWorkflowRequest) GetChildIndex() int32

func (*ScheduleWorkflowRequest) GetChildKey added in v0.18.0

func (x *ScheduleWorkflowRequest) GetChildKey() string

func (*ScheduleWorkflowRequest) GetInput

func (x *ScheduleWorkflowRequest) GetInput() string

func (*ScheduleWorkflowRequest) GetName added in v0.17.0

func (x *ScheduleWorkflowRequest) GetName() string

func (*ScheduleWorkflowRequest) GetParentId added in v0.18.0

func (x *ScheduleWorkflowRequest) GetParentId() string

func (*ScheduleWorkflowRequest) GetParentStepRunId added in v0.18.0

func (x *ScheduleWorkflowRequest) GetParentStepRunId() string

func (*ScheduleWorkflowRequest) GetSchedules

func (x *ScheduleWorkflowRequest) GetSchedules() []*timestamppb.Timestamp

func (*ScheduleWorkflowRequest) ProtoMessage

func (*ScheduleWorkflowRequest) ProtoMessage()

func (*ScheduleWorkflowRequest) ProtoReflect

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

func (*ScheduleWorkflowRequest) Reset

func (x *ScheduleWorkflowRequest) Reset()

func (*ScheduleWorkflowRequest) String

func (x *ScheduleWorkflowRequest) String() string

type StickyStrategy added in v0.40.0

type StickyStrategy int32
const (
	StickyStrategy_SOFT StickyStrategy = 0
	StickyStrategy_HARD StickyStrategy = 1
)

func (StickyStrategy) Descriptor added in v0.40.0

func (StickyStrategy) Enum added in v0.40.0

func (x StickyStrategy) Enum() *StickyStrategy

func (StickyStrategy) EnumDescriptor deprecated added in v0.40.0

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

Deprecated: Use StickyStrategy.Descriptor instead.

func (StickyStrategy) Number added in v0.40.0

func (StickyStrategy) String added in v0.40.0

func (x StickyStrategy) String() string

func (StickyStrategy) Type added in v0.40.0

type TriggerWorkflowRequest added in v0.9.0

type TriggerWorkflowRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// (optional) the input data for the workflow
	Input string `protobuf:"bytes,2,opt,name=input,proto3" json:"input,omitempty"`
	// (optional) the parent workflow run id
	ParentId *string `protobuf:"bytes,3,opt,name=parent_id,json=parentId,proto3,oneof" json:"parent_id,omitempty"`
	// (optional) the parent step run id
	ParentStepRunId *string `protobuf:"bytes,4,opt,name=parent_step_run_id,json=parentStepRunId,proto3,oneof" json:"parent_step_run_id,omitempty"`
	// (optional) the index of the child workflow. if this is set, matches on the index or the
	// child key will return an existing workflow run if the parent id, parent step run id, and
	// child index/key match an existing workflow run.
	ChildIndex *int32 `protobuf:"varint,5,opt,name=child_index,json=childIndex,proto3,oneof" json:"child_index,omitempty"`
	// (optional) the key for the child. if this is set, matches on the index or the
	// child key will return an existing workflow run if the parent id, parent step run id, and
	// child index/key match an existing workflow run.
	ChildKey *string `protobuf:"bytes,6,opt,name=child_key,json=childKey,proto3,oneof" json:"child_key,omitempty"`
	// (optional) additional metadata for the workflow
	AdditionalMetadata *string `protobuf:"bytes,7,opt,name=additional_metadata,json=additionalMetadata,proto3,oneof" json:"additional_metadata,omitempty"`
	// (optional) desired worker id for the workflow run,
	// requires the workflow definition to have a sticky strategy
	DesiredWorkerId *string `protobuf:"bytes,8,opt,name=desired_worker_id,json=desiredWorkerId,proto3,oneof" json:"desired_worker_id,omitempty"`
	// (optional) override for the priority of the workflow steps, will set all steps to this priority
	Priority *int32 `protobuf:"varint,9,opt,name=priority,proto3,oneof" json:"priority,omitempty"`
	// contains filtered or unexported fields
}

func (*TriggerWorkflowRequest) Descriptor deprecated added in v0.9.0

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

Deprecated: Use TriggerWorkflowRequest.ProtoReflect.Descriptor instead.

func (*TriggerWorkflowRequest) GetAdditionalMetadata added in v0.25.0

func (x *TriggerWorkflowRequest) GetAdditionalMetadata() string

func (*TriggerWorkflowRequest) GetChildIndex added in v0.18.0

func (x *TriggerWorkflowRequest) GetChildIndex() int32

func (*TriggerWorkflowRequest) GetChildKey added in v0.18.0

func (x *TriggerWorkflowRequest) GetChildKey() string

func (*TriggerWorkflowRequest) GetDesiredWorkerId added in v0.40.0

func (x *TriggerWorkflowRequest) GetDesiredWorkerId() string

func (*TriggerWorkflowRequest) GetInput added in v0.9.0

func (x *TriggerWorkflowRequest) GetInput() string

func (*TriggerWorkflowRequest) GetName added in v0.9.0

func (x *TriggerWorkflowRequest) GetName() string

func (*TriggerWorkflowRequest) GetParentId added in v0.18.0

func (x *TriggerWorkflowRequest) GetParentId() string

func (*TriggerWorkflowRequest) GetParentStepRunId added in v0.18.0

func (x *TriggerWorkflowRequest) GetParentStepRunId() string

func (*TriggerWorkflowRequest) GetPriority added in v0.43.0

func (x *TriggerWorkflowRequest) GetPriority() int32

func (*TriggerWorkflowRequest) ProtoMessage added in v0.9.0

func (*TriggerWorkflowRequest) ProtoMessage()

func (*TriggerWorkflowRequest) ProtoReflect added in v0.9.0

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

func (*TriggerWorkflowRequest) Reset added in v0.9.0

func (x *TriggerWorkflowRequest) Reset()

func (*TriggerWorkflowRequest) String added in v0.9.0

func (x *TriggerWorkflowRequest) String() string

type TriggerWorkflowResponse added in v0.9.0

type TriggerWorkflowResponse struct {
	WorkflowRunId string `protobuf:"bytes,1,opt,name=workflow_run_id,json=workflowRunId,proto3" json:"workflow_run_id,omitempty"`
	// contains filtered or unexported fields
}

func (*TriggerWorkflowResponse) Descriptor deprecated added in v0.9.0

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

Deprecated: Use TriggerWorkflowResponse.ProtoReflect.Descriptor instead.

func (*TriggerWorkflowResponse) GetWorkflowRunId added in v0.9.0

func (x *TriggerWorkflowResponse) GetWorkflowRunId() string

func (*TriggerWorkflowResponse) ProtoMessage added in v0.9.0

func (*TriggerWorkflowResponse) ProtoMessage()

func (*TriggerWorkflowResponse) ProtoReflect added in v0.9.0

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

func (*TriggerWorkflowResponse) Reset added in v0.9.0

func (x *TriggerWorkflowResponse) Reset()

func (*TriggerWorkflowResponse) String added in v0.9.0

func (x *TriggerWorkflowResponse) String() string

type UnimplementedWorkflowServiceServer

type UnimplementedWorkflowServiceServer struct {
}

UnimplementedWorkflowServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedWorkflowServiceServer) PutRateLimit added in v0.19.0

func (UnimplementedWorkflowServiceServer) PutWorkflow

func (UnimplementedWorkflowServiceServer) ScheduleWorkflow

func (UnimplementedWorkflowServiceServer) TriggerWorkflow added in v0.9.0

type UnsafeWorkflowServiceServer

type UnsafeWorkflowServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeWorkflowServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WorkflowServiceServer will result in compilation errors.

type WorkerLabelComparator added in v0.40.0

type WorkerLabelComparator int32
const (
	WorkerLabelComparator_EQUAL                 WorkerLabelComparator = 0
	WorkerLabelComparator_NOT_EQUAL             WorkerLabelComparator = 1
	WorkerLabelComparator_GREATER_THAN          WorkerLabelComparator = 2
	WorkerLabelComparator_GREATER_THAN_OR_EQUAL WorkerLabelComparator = 3
	WorkerLabelComparator_LESS_THAN             WorkerLabelComparator = 4
	WorkerLabelComparator_LESS_THAN_OR_EQUAL    WorkerLabelComparator = 5
)

func (WorkerLabelComparator) Descriptor added in v0.40.0

func (WorkerLabelComparator) Enum added in v0.40.0

func (WorkerLabelComparator) EnumDescriptor deprecated added in v0.40.0

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

Deprecated: Use WorkerLabelComparator.Descriptor instead.

func (WorkerLabelComparator) Number added in v0.40.0

func (WorkerLabelComparator) String added in v0.40.0

func (x WorkerLabelComparator) String() string

func (WorkerLabelComparator) Type added in v0.40.0

type WorkflowConcurrencyOpts added in v0.8.0

type WorkflowConcurrencyOpts struct {
	Action        *string                   `protobuf:"bytes,1,opt,name=action,proto3,oneof" json:"action,omitempty"`                   // (optional) the action id for getting the concurrency group
	MaxRuns       *int32                    `protobuf:"varint,2,opt,name=max_runs,json=maxRuns,proto3,oneof" json:"max_runs,omitempty"` // (optional) the maximum number of concurrent workflow runs, default 1
	LimitStrategy *ConcurrencyLimitStrategy ``                                                                                          // (optional) the strategy to use when the concurrency limit is reached, default CANCEL_IN_PROGRESS
	/* 137-byte string literal not displayed */
	Expression *string `protobuf:"bytes,4,opt,name=expression,proto3,oneof" json:"expression,omitempty"` // (optional) the expression to use for concurrency
	// contains filtered or unexported fields
}

func (*WorkflowConcurrencyOpts) Descriptor deprecated added in v0.8.0

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

Deprecated: Use WorkflowConcurrencyOpts.ProtoReflect.Descriptor instead.

func (*WorkflowConcurrencyOpts) GetAction added in v0.8.0

func (x *WorkflowConcurrencyOpts) GetAction() string

func (*WorkflowConcurrencyOpts) GetExpression added in v0.45.0

func (x *WorkflowConcurrencyOpts) GetExpression() string

func (*WorkflowConcurrencyOpts) GetLimitStrategy added in v0.8.0

func (x *WorkflowConcurrencyOpts) GetLimitStrategy() ConcurrencyLimitStrategy

func (*WorkflowConcurrencyOpts) GetMaxRuns added in v0.8.0

func (x *WorkflowConcurrencyOpts) GetMaxRuns() int32

func (*WorkflowConcurrencyOpts) ProtoMessage added in v0.8.0

func (*WorkflowConcurrencyOpts) ProtoMessage()

func (*WorkflowConcurrencyOpts) ProtoReflect added in v0.8.0

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

func (*WorkflowConcurrencyOpts) Reset added in v0.8.0

func (x *WorkflowConcurrencyOpts) Reset()

func (*WorkflowConcurrencyOpts) String added in v0.8.0

func (x *WorkflowConcurrencyOpts) String() string

type WorkflowKind added in v0.41.0

type WorkflowKind int32
const (
	WorkflowKind_FUNCTION WorkflowKind = 0
	WorkflowKind_DURABLE  WorkflowKind = 1
	WorkflowKind_DAG      WorkflowKind = 2
)

func (WorkflowKind) Descriptor added in v0.41.0

func (WorkflowKind) Enum added in v0.41.0

func (x WorkflowKind) Enum() *WorkflowKind

func (WorkflowKind) EnumDescriptor deprecated added in v0.41.0

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

Deprecated: Use WorkflowKind.Descriptor instead.

func (WorkflowKind) Number added in v0.41.0

func (WorkflowKind) String added in v0.41.0

func (x WorkflowKind) String() string

func (WorkflowKind) Type added in v0.41.0

type WorkflowServiceClient

type WorkflowServiceClient interface {
	PutWorkflow(ctx context.Context, in *PutWorkflowRequest, opts ...grpc.CallOption) (*WorkflowVersion, error)
	ScheduleWorkflow(ctx context.Context, in *ScheduleWorkflowRequest, opts ...grpc.CallOption) (*WorkflowVersion, error)
	TriggerWorkflow(ctx context.Context, in *TriggerWorkflowRequest, opts ...grpc.CallOption) (*TriggerWorkflowResponse, error)
	PutRateLimit(ctx context.Context, in *PutRateLimitRequest, opts ...grpc.CallOption) (*PutRateLimitResponse, error)
}

WorkflowServiceClient is the client API for WorkflowService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type WorkflowServiceServer

type WorkflowServiceServer interface {
	PutWorkflow(context.Context, *PutWorkflowRequest) (*WorkflowVersion, error)
	ScheduleWorkflow(context.Context, *ScheduleWorkflowRequest) (*WorkflowVersion, error)
	TriggerWorkflow(context.Context, *TriggerWorkflowRequest) (*TriggerWorkflowResponse, error)
	PutRateLimit(context.Context, *PutRateLimitRequest) (*PutRateLimitResponse, error)
	// contains filtered or unexported methods
}

WorkflowServiceServer is the server API for WorkflowService service. All implementations must embed UnimplementedWorkflowServiceServer for forward compatibility

type WorkflowTriggerCronRef

type WorkflowTriggerCronRef struct {
	ParentId string `protobuf:"bytes,1,opt,name=parent_id,json=parentId,proto3" json:"parent_id,omitempty"`
	Cron     string `protobuf:"bytes,2,opt,name=cron,proto3" json:"cron,omitempty"`
	// contains filtered or unexported fields
}

WorkflowTriggerCronRef represents the WorkflowTriggerCronRef model.

func (*WorkflowTriggerCronRef) Descriptor deprecated

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

Deprecated: Use WorkflowTriggerCronRef.ProtoReflect.Descriptor instead.

func (*WorkflowTriggerCronRef) GetCron

func (x *WorkflowTriggerCronRef) GetCron() string

func (*WorkflowTriggerCronRef) GetParentId

func (x *WorkflowTriggerCronRef) GetParentId() string

func (*WorkflowTriggerCronRef) ProtoMessage

func (*WorkflowTriggerCronRef) ProtoMessage()

func (*WorkflowTriggerCronRef) ProtoReflect

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

func (*WorkflowTriggerCronRef) Reset

func (x *WorkflowTriggerCronRef) Reset()

func (*WorkflowTriggerCronRef) String

func (x *WorkflowTriggerCronRef) String() string

type WorkflowTriggerEventRef

type WorkflowTriggerEventRef struct {
	ParentId string `protobuf:"bytes,1,opt,name=parent_id,json=parentId,proto3" json:"parent_id,omitempty"`
	EventKey string `protobuf:"bytes,2,opt,name=event_key,json=eventKey,proto3" json:"event_key,omitempty"`
	// contains filtered or unexported fields
}

WorkflowTriggerEventRef represents the WorkflowTriggerEventRef model.

func (*WorkflowTriggerEventRef) Descriptor deprecated

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

Deprecated: Use WorkflowTriggerEventRef.ProtoReflect.Descriptor instead.

func (*WorkflowTriggerEventRef) GetEventKey

func (x *WorkflowTriggerEventRef) GetEventKey() string

func (*WorkflowTriggerEventRef) GetParentId

func (x *WorkflowTriggerEventRef) GetParentId() string

func (*WorkflowTriggerEventRef) ProtoMessage

func (*WorkflowTriggerEventRef) ProtoMessage()

func (*WorkflowTriggerEventRef) ProtoReflect

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

func (*WorkflowTriggerEventRef) Reset

func (x *WorkflowTriggerEventRef) Reset()

func (*WorkflowTriggerEventRef) String

func (x *WorkflowTriggerEventRef) String() string

type WorkflowVersion

type WorkflowVersion struct {
	Id         string                 `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	CreatedAt  *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	UpdatedAt  *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	Version    string                 `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"`
	Order      int32                  `protobuf:"varint,6,opt,name=order,proto3" json:"order,omitempty"`
	WorkflowId string                 `protobuf:"bytes,7,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"`
	// contains filtered or unexported fields
}

WorkflowVersion represents the WorkflowVersion model.

func (*WorkflowVersion) Descriptor deprecated

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

Deprecated: Use WorkflowVersion.ProtoReflect.Descriptor instead.

func (*WorkflowVersion) GetCreatedAt

func (x *WorkflowVersion) GetCreatedAt() *timestamppb.Timestamp

func (*WorkflowVersion) GetId

func (x *WorkflowVersion) GetId() string

func (*WorkflowVersion) GetOrder

func (x *WorkflowVersion) GetOrder() int32

func (*WorkflowVersion) GetUpdatedAt

func (x *WorkflowVersion) GetUpdatedAt() *timestamppb.Timestamp

func (*WorkflowVersion) GetVersion

func (x *WorkflowVersion) GetVersion() string

func (*WorkflowVersion) GetWorkflowId

func (x *WorkflowVersion) GetWorkflowId() string

func (*WorkflowVersion) ProtoMessage

func (*WorkflowVersion) ProtoMessage()

func (*WorkflowVersion) ProtoReflect

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

func (*WorkflowVersion) Reset

func (x *WorkflowVersion) Reset()

func (*WorkflowVersion) String

func (x *WorkflowVersion) String() string

Jump to

Keyboard shortcuts

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