contracts

type ConcurrencyLimitStrategy int32

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" json:"units,omitempty"` // (required) the number of units this step consumes
	// contains filtered or unexported fields
}

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
}

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

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

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

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
}

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

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

type RateLimitDuration int32

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
}

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

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
}

type UnimplementedWorkflowServiceServer struct {
}

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

type WorkflowConcurrencyOpts struct {
	Action        string                   `protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`                   // (required) the action id for getting the concurrency group
	MaxRuns       int32                    `protobuf:"varint,2,opt,name=max_runs,json=maxRuns,proto3" 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
	/* 131-byte string literal not displayed */
	// contains filtered or unexported fields
}

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)
}

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
}

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
}

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
}

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
}