workflowsv1

package
v0.0.0-...-68a25c6 Latest Latest
Warning

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

 Go to latest Published: Nov 20, 2024 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	JobService_SubmitJob_FullMethodName    = "/workflows.v1.JobService/SubmitJob"
	JobService_GetJob_FullMethodName       = "/workflows.v1.JobService/GetJob"
	JobService_RetryJob_FullMethodName     = "/workflows.v1.JobService/RetryJob"
	JobService_CancelJob_FullMethodName    = "/workflows.v1.JobService/CancelJob"
	JobService_VisualizeJob_FullMethodName = "/workflows.v1.JobService/VisualizeJob"
	JobService_ListJobs_FullMethodName     = "/workflows.v1.JobService/ListJobs"
)
View Source 
const (
	RecurrentTaskService_ListStorageLocations_FullMethodName  = "/workflows.v1.RecurrentTaskService/ListStorageLocations"
	RecurrentTaskService_GetStorageLocation_FullMethodName    = "/workflows.v1.RecurrentTaskService/GetStorageLocation"
	RecurrentTaskService_CreateStorageLocation_FullMethodName = "/workflows.v1.RecurrentTaskService/CreateStorageLocation"
	RecurrentTaskService_DeleteStorageLocation_FullMethodName = "/workflows.v1.RecurrentTaskService/DeleteStorageLocation"
	RecurrentTaskService_ListRecurrentTasks_FullMethodName    = "/workflows.v1.RecurrentTaskService/ListRecurrentTasks"
	RecurrentTaskService_GetRecurrentTask_FullMethodName      = "/workflows.v1.RecurrentTaskService/GetRecurrentTask"
	RecurrentTaskService_CreateRecurrentTask_FullMethodName   = "/workflows.v1.RecurrentTaskService/CreateRecurrentTask"
	RecurrentTaskService_UpdateRecurrentTask_FullMethodName   = "/workflows.v1.RecurrentTaskService/UpdateRecurrentTask"
	RecurrentTaskService_DeleteRecurrentTask_FullMethodName   = "/workflows.v1.RecurrentTaskService/DeleteRecurrentTask"
)
View Source 
const (
	TaskService_NextTask_FullMethodName        = "/workflows.v1.TaskService/NextTask"
	TaskService_TaskFailed_FullMethodName      = "/workflows.v1.TaskService/TaskFailed"
	TaskService_ExtendTaskLease_FullMethodName = "/workflows.v1.TaskService/ExtendTaskLease"
)
View Source 
const (
	WorkflowsService_CreateCluster_FullMethodName = "/workflows.v1.WorkflowsService/CreateCluster"
	WorkflowsService_GetCluster_FullMethodName    = "/workflows.v1.WorkflowsService/GetCluster"
	WorkflowsService_DeleteCluster_FullMethodName = "/workflows.v1.WorkflowsService/DeleteCluster"
	WorkflowsService_ListClusters_FullMethodName  = "/workflows.v1.WorkflowsService/ListClusters"
)
View Source 
const (
	DiagramService_Render_FullMethodName = "/workflows.v1.DiagramService/Render"
)

Variables

View Source 
var (
	JobState_name = map[int32]string{
		0: "JOB_STATE_UNSPECIFIED",
		1: "JOB_STATE_QUEUED",
		2: "JOB_STATE_STARTED",
		3: "JOB_STATE_COMPLETED",
	}
	JobState_value = map[string]int32{
		"JOB_STATE_UNSPECIFIED": 0,
		"JOB_STATE_QUEUED":      1,
		"JOB_STATE_STARTED":     2,
		"JOB_STATE_COMPLETED":   3,
	}
)

Enum value maps for JobState.

View Source 
var (
	TaskState_name = map[int32]string{
		0: "TASK_STATE_UNSPECIFIED",
		1: "TASK_STATE_QUEUED",
		2: "TASK_STATE_RUNNING",
		3: "TASK_STATE_COMPUTED",
		4: "TASK_STATE_FAILED",
		5: "TASK_STATE_CANCELLED",
	}
	TaskState_value = map[string]int32{
		"TASK_STATE_UNSPECIFIED": 0,
		"TASK_STATE_QUEUED":      1,
		"TASK_STATE_RUNNING":     2,
		"TASK_STATE_COMPUTED":    3,
		"TASK_STATE_FAILED":      4,
		"TASK_STATE_CANCELLED":   5,
	}
)

Enum value maps for TaskState.

View Source 
var (
	StorageType_name = map[int32]string{
		0: "STORAGE_TYPE_UNSPECIFIED",
		1: "STORAGE_TYPE_GCS",
		2: "STORAGE_TYPE_S3",
		3: "STORAGE_TYPE_FS",
	}
	StorageType_value = map[string]int32{
		"STORAGE_TYPE_UNSPECIFIED": 0,
		"STORAGE_TYPE_GCS":         1,
		"STORAGE_TYPE_S3":          2,
		"STORAGE_TYPE_FS":          3,
	}
)

Enum value maps for StorageType.

View Source 
var (
	StorageEventType_name = map[int32]string{
		0: "STORAGE_EVENT_TYPE_UNSPECIFIED",
		1: "STORAGE_EVENT_TYPE_CREATED",
	}
	StorageEventType_value = map[string]int32{
		"STORAGE_EVENT_TYPE_UNSPECIFIED": 0,
		"STORAGE_EVENT_TYPE_CREATED":     1,
	}
)

Enum value maps for StorageEventType.

View Source 
var DiagramService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "workflows.v1.DiagramService",
	HandlerType: (*DiagramServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Render",
			Handler:    _DiagramService_Render_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "workflows/v1/diagram.proto",
}

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

View Source 
var File_workflows_v1_core_proto protoreflect.FileDescriptor
View Source 
var File_workflows_v1_diagram_proto protoreflect.FileDescriptor
View Source 
var File_workflows_v1_job_proto protoreflect.FileDescriptor
View Source 
var File_workflows_v1_recurrent_task_proto protoreflect.FileDescriptor
View Source 
var File_workflows_v1_task_proto protoreflect.FileDescriptor
View Source 
var File_workflows_v1_workflows_proto protoreflect.FileDescriptor
View Source 
var JobService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "workflows.v1.JobService",
	HandlerType: (*JobServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SubmitJob",
			Handler:    _JobService_SubmitJob_Handler,
		},
		{
			MethodName: "GetJob",
			Handler:    _JobService_GetJob_Handler,
		},
		{
			MethodName: "RetryJob",
			Handler:    _JobService_RetryJob_Handler,
		},
		{
			MethodName: "CancelJob",
			Handler:    _JobService_CancelJob_Handler,
		},
		{
			MethodName: "VisualizeJob",
			Handler:    _JobService_VisualizeJob_Handler,
		},
		{
			MethodName: "ListJobs",
			Handler:    _JobService_ListJobs_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "workflows/v1/job.proto",
}

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

View Source 
var RecurrentTaskService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "workflows.v1.RecurrentTaskService",
	HandlerType: (*RecurrentTaskServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListStorageLocations",
			Handler:    _RecurrentTaskService_ListStorageLocations_Handler,
		},
		{
			MethodName: "GetStorageLocation",
			Handler:    _RecurrentTaskService_GetStorageLocation_Handler,
		},
		{
			MethodName: "CreateStorageLocation",
			Handler:    _RecurrentTaskService_CreateStorageLocation_Handler,
		},
		{
			MethodName: "DeleteStorageLocation",
			Handler:    _RecurrentTaskService_DeleteStorageLocation_Handler,
		},
		{
			MethodName: "ListRecurrentTasks",
			Handler:    _RecurrentTaskService_ListRecurrentTasks_Handler,
		},
		{
			MethodName: "GetRecurrentTask",
			Handler:    _RecurrentTaskService_GetRecurrentTask_Handler,
		},
		{
			MethodName: "CreateRecurrentTask",
			Handler:    _RecurrentTaskService_CreateRecurrentTask_Handler,
		},
		{
			MethodName: "UpdateRecurrentTask",
			Handler:    _RecurrentTaskService_UpdateRecurrentTask_Handler,
		},
		{
			MethodName: "DeleteRecurrentTask",
			Handler:    _RecurrentTaskService_DeleteRecurrentTask_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "workflows/v1/recurrent_task.proto",
}

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

View Source 
var TaskService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "workflows.v1.TaskService",
	HandlerType: (*TaskServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "NextTask",
			Handler:    _TaskService_NextTask_Handler,
		},
		{
			MethodName: "TaskFailed",
			Handler:    _TaskService_TaskFailed_Handler,
		},
		{
			MethodName: "ExtendTaskLease",
			Handler:    _TaskService_ExtendTaskLease_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "workflows/v1/task.proto",
}

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

View Source 
var WorkflowsService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "workflows.v1.WorkflowsService",
	HandlerType: (*WorkflowsServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateCluster",
			Handler:    _WorkflowsService_CreateCluster_Handler,
		},
		{
			MethodName: "GetCluster",
			Handler:    _WorkflowsService_GetCluster_Handler,
		},
		{
			MethodName: "DeleteCluster",
			Handler:    _WorkflowsService_DeleteCluster_Handler,
		},
		{
			MethodName: "ListClusters",
			Handler:    _WorkflowsService_ListClusters_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "workflows/v1/workflows.proto",
}

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

Functions

func RegisterDiagramServiceServer 

func RegisterDiagramServiceServer(s grpc.ServiceRegistrar, srv DiagramServiceServer)

func RegisterJobServiceServer 

func RegisterJobServiceServer(s grpc.ServiceRegistrar, srv JobServiceServer)

func RegisterRecurrentTaskServiceServer 

func RegisterRecurrentTaskServiceServer(s grpc.ServiceRegistrar, srv RecurrentTaskServiceServer)

func RegisterTaskServiceServer 

func RegisterTaskServiceServer(s grpc.ServiceRegistrar, srv TaskServiceServer)

func RegisterWorkflowsServiceServer 

func RegisterWorkflowsServiceServer(s grpc.ServiceRegistrar, srv WorkflowsServiceServer)

Types

type CancelJobRequest 

type CancelJobRequest struct {

	// The job to cancel.
	JobId *UUID `protobuf:"bytes,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// contains filtered or unexported fields
}

CancelJobRequest requests a cancel of a job.

func (*CancelJobRequest) Descriptor deprecated 

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

Deprecated: Use CancelJobRequest.ProtoReflect.Descriptor instead.

func (*CancelJobRequest) GetJobId 

func (x *CancelJobRequest) GetJobId() *UUID

func (*CancelJobRequest) ProtoMessage 

func (*CancelJobRequest) ProtoMessage()

func (*CancelJobRequest) ProtoReflect 

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

func (*CancelJobRequest) Reset 

func (x *CancelJobRequest) Reset()

func (*CancelJobRequest) String 

func (x *CancelJobRequest) String() string

type CancelJobResponse 

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

CancelJobResponse is the response to a CancelJobRequest.

func (*CancelJobResponse) Descriptor deprecated 

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

Deprecated: Use CancelJobResponse.ProtoReflect.Descriptor instead.

func (*CancelJobResponse) ProtoMessage 

func (*CancelJobResponse) ProtoMessage()

func (*CancelJobResponse) ProtoReflect 

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

func (*CancelJobResponse) Reset 

func (x *CancelJobResponse) Reset()

func (*CancelJobResponse) String 

func (x *CancelJobResponse) String() string

type Cluster 

type Cluster struct {

	// 1 is reserved for a potential id field in the future.
	Slug        string `protobuf:"bytes,2,opt,name=slug,proto3" json:"slug,omitempty"`                                  // The unique slug of the cluster within the namespace.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"` // The display name of the cluster.
	// contains filtered or unexported fields
}

A cluster is a grouping of tasks that are related.

func (*Cluster) Descriptor deprecated 

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

Deprecated: Use Cluster.ProtoReflect.Descriptor instead.

func (*Cluster) GetDisplayName 

func (x *Cluster) GetDisplayName() string

func (*Cluster) GetSlug 

func (x *Cluster) GetSlug() string

func (*Cluster) ProtoMessage 

func (*Cluster) ProtoMessage()

func (*Cluster) ProtoReflect 

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

func (*Cluster) Reset 

func (x *Cluster) Reset()

func (*Cluster) String 

func (x *Cluster) String() string

type ComputedTask 

type ComputedTask struct {
	Id *UUID `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // The id of the task that has been computed.
	// A display name for the task that has been computed for visualization purposes.
	// If not set, the display message specified upon task submission will be kept.
	Display  string            `protobuf:"bytes,2,opt,name=display,proto3" json:"display,omitempty"`
	SubTasks []*TaskSubmission `protobuf:"bytes,3,rep,name=sub_tasks,json=subTasks,proto3" json:"sub_tasks,omitempty"` // A list of sub-tasks that the just computed task spawned.
	// contains filtered or unexported fields
}

ComputedTask is a message specifying a task that has been computed by the task runner.

func (*ComputedTask) Descriptor deprecated 

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

Deprecated: Use ComputedTask.ProtoReflect.Descriptor instead.

func (*ComputedTask) GetDisplay 

func (x *ComputedTask) GetDisplay() string

func (*ComputedTask) GetId 

func (x *ComputedTask) GetId() *UUID

func (*ComputedTask) GetSubTasks 

func (x *ComputedTask) GetSubTasks() []*TaskSubmission

func (*ComputedTask) ProtoMessage 

func (*ComputedTask) ProtoMessage()

func (*ComputedTask) ProtoReflect 

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

func (*ComputedTask) Reset 

func (x *ComputedTask) Reset()

func (*ComputedTask) String 

func (x *ComputedTask) String() string

type CreateClusterRequest 

type CreateClusterRequest struct {

	// The name of the cluster.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

CreateClusterRequest creates a new cluster.

func (*CreateClusterRequest) Descriptor deprecated 

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

Deprecated: Use CreateClusterRequest.ProtoReflect.Descriptor instead.

func (*CreateClusterRequest) GetName 

func (x *CreateClusterRequest) GetName() string

func (*CreateClusterRequest) ProtoMessage 

func (*CreateClusterRequest) ProtoMessage()

func (*CreateClusterRequest) ProtoReflect 

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

func (*CreateClusterRequest) Reset 

func (x *CreateClusterRequest) Reset()

func (*CreateClusterRequest) String 

func (x *CreateClusterRequest) String() string

type CronTrigger 

type CronTrigger struct {
	Id       *UUID  `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`             // Unique identifier for the trigger
	Schedule string `protobuf:"bytes,2,opt,name=schedule,proto3" json:"schedule,omitempty"` // A cron schedule for the trigger, e.g. "0 0 * * *" (every day at midnight)
	// contains filtered or unexported fields
}

CronTrigger is a trigger that will trigger a task submission on a schedule.

func (*CronTrigger) Descriptor deprecated 

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

Deprecated: Use CronTrigger.ProtoReflect.Descriptor instead.

func (*CronTrigger) GetId 

func (x *CronTrigger) GetId() *UUID

func (*CronTrigger) GetSchedule 

func (x *CronTrigger) GetSchedule() string

func (*CronTrigger) ProtoMessage 

func (*CronTrigger) ProtoMessage()

func (*CronTrigger) ProtoReflect 

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

func (*CronTrigger) Reset 

func (x *CronTrigger) Reset()

func (*CronTrigger) String 

func (x *CronTrigger) String() string

type DeleteClusterRequest 

type DeleteClusterRequest struct {

	// The slug of the cluster to delete.
	ClusterSlug string `protobuf:"bytes,1,opt,name=cluster_slug,json=clusterSlug,proto3" json:"cluster_slug,omitempty"`
	// contains filtered or unexported fields
}

DeleteClusterRequest deletes an existing cluster.

func (*DeleteClusterRequest) Descriptor deprecated 

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

Deprecated: Use DeleteClusterRequest.ProtoReflect.Descriptor instead.

func (*DeleteClusterRequest) GetClusterSlug 

func (x *DeleteClusterRequest) GetClusterSlug() string

func (*DeleteClusterRequest) ProtoMessage 

func (*DeleteClusterRequest) ProtoMessage()

func (*DeleteClusterRequest) ProtoReflect 

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

func (*DeleteClusterRequest) Reset 

func (x *DeleteClusterRequest) Reset()

func (*DeleteClusterRequest) String 

func (x *DeleteClusterRequest) String() string

type DeleteClusterResponse 

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

DeleteClusterResponse is the response to DeleteClusterRequest.

func (*DeleteClusterResponse) Descriptor deprecated 

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

Deprecated: Use DeleteClusterResponse.ProtoReflect.Descriptor instead.

func (*DeleteClusterResponse) ProtoMessage 

func (*DeleteClusterResponse) ProtoMessage()

func (*DeleteClusterResponse) ProtoReflect 

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

func (*DeleteClusterResponse) Reset 

func (x *DeleteClusterResponse) Reset()

func (*DeleteClusterResponse) String 

func (x *DeleteClusterResponse) String() string

type Diagram 

type Diagram struct {
	Svg []byte `protobuf:"bytes,1,opt,name=svg,proto3" json:"svg,omitempty"`
	// contains filtered or unexported fields
}

A rendered diagram

func (*Diagram) Descriptor deprecated 

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

Deprecated: Use Diagram.ProtoReflect.Descriptor instead.

func (*Diagram) GetSvg 

func (x *Diagram) GetSvg() []byte

func (*Diagram) ProtoMessage 

func (*Diagram) ProtoMessage()

func (*Diagram) ProtoReflect 

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

func (*Diagram) Reset 

func (x *Diagram) Reset()

func (*Diagram) String 

func (x *Diagram) String() string

type DiagramServiceClient 

type DiagramServiceClient interface {
	Render(ctx context.Context, in *RenderDiagramRequest, opts ...grpc.CallOption) (*Diagram, error)
}

DiagramServiceClient is the client API for DiagramService 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.

The diagram service

func NewDiagramServiceClient 

func NewDiagramServiceClient(cc grpc.ClientConnInterface) DiagramServiceClient

type DiagramServiceServer 

type DiagramServiceServer interface {
	Render(context.Context, *RenderDiagramRequest) (*Diagram, error)
	// contains filtered or unexported methods
}

DiagramServiceServer is the server API for DiagramService service. All implementations must embed UnimplementedDiagramServiceServer for forward compatibility.

The diagram service

type GetClusterRequest 

type GetClusterRequest struct {

	// The slug of the cluster to get details for.
	ClusterSlug string `protobuf:"bytes,1,opt,name=cluster_slug,json=clusterSlug,proto3" json:"cluster_slug,omitempty"`
	// contains filtered or unexported fields
}

GetClusterRequest requests details for a cluster.

func (*GetClusterRequest) Descriptor deprecated 

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

Deprecated: Use GetClusterRequest.ProtoReflect.Descriptor instead.

func (*GetClusterRequest) GetClusterSlug 

func (x *GetClusterRequest) GetClusterSlug() string

func (*GetClusterRequest) ProtoMessage 

func (*GetClusterRequest) ProtoMessage()

func (*GetClusterRequest) ProtoReflect 

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

func (*GetClusterRequest) Reset 

func (x *GetClusterRequest) Reset()

func (*GetClusterRequest) String 

func (x *GetClusterRequest) String() string

type GetJobRequest 

type GetJobRequest struct {

	// The ID of the job to get details for.
	JobId *UUID `protobuf:"bytes,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// contains filtered or unexported fields
}

GetJobRequest requests details for a job.

func (*GetJobRequest) Descriptor deprecated 

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

Deprecated: Use GetJobRequest.ProtoReflect.Descriptor instead.

func (*GetJobRequest) GetJobId 

func (x *GetJobRequest) GetJobId() *UUID

func (*GetJobRequest) ProtoMessage 

func (*GetJobRequest) ProtoMessage()

func (*GetJobRequest) ProtoReflect 

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

func (*GetJobRequest) Reset 

func (x *GetJobRequest) Reset()

func (*GetJobRequest) String 

func (x *GetJobRequest) String() string

type IDInterval 

type IDInterval struct {
	StartId string `protobuf:"bytes,1,opt,name=start_id,json=startId,proto3" json:"start_id,omitempty"` // The id of the first data point in the interval.
	EndId   string `protobuf:"bytes,2,opt,name=end_id,json=endId,proto3" json:"end_id,omitempty"`       // The id of the last data point in the interval.
	// We use exclusive for start and inclusive for end, because that way when both are false
	// we have a half-open interval [start, end) which is the default behaviour we want to achieve.
	// Flag indicating whether the start id is exclusive.
	// If true, the datapoint with the given start id is not included in the interval.
	StartExclusive bool `protobuf:"varint,3,opt,name=start_exclusive,json=startExclusive,proto3" json:"start_exclusive,omitempty"`
	// Flag indicating whether the end id is inclusive.
	// If true, the datapoint with the given end id is included in the interval.
	EndInclusive bool `protobuf:"varint,4,opt,name=end_inclusive,json=endInclusive,proto3" json:"end_inclusive,omitempty"`
	// contains filtered or unexported fields
}

An ID interval

func (*IDInterval) Descriptor deprecated 

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

Deprecated: Use IDInterval.ProtoReflect.Descriptor instead.

func (*IDInterval) GetEndId 

func (x *IDInterval) GetEndId() string

func (*IDInterval) GetEndInclusive 

func (x *IDInterval) GetEndInclusive() bool

func (*IDInterval) GetStartExclusive 

func (x *IDInterval) GetStartExclusive() bool

func (*IDInterval) GetStartId 

func (x *IDInterval) GetStartId() string

func (*IDInterval) ProtoMessage 

func (*IDInterval) ProtoMessage()

func (*IDInterval) ProtoReflect 

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

func (*IDInterval) Reset 

func (x *IDInterval) Reset()

func (*IDInterval) String 

func (x *IDInterval) String() string

type Job 

type Job struct {
	Id          *UUID                  `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name        string                 `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	TraceParent string                 `protobuf:"bytes,3,opt,name=trace_parent,json=traceParent,proto3" json:"trace_parent,omitempty"`
	Completed   bool                   `protobuf:"varint,4,opt,name=completed,proto3" json:"completed,omitempty"`                       // deprecated: use state instead
	Canceled    bool                   `protobuf:"varint,5,opt,name=canceled,proto3" json:"canceled,omitempty"`                         // Whether the job has been canceled.
	State       JobState               `protobuf:"varint,6,opt,name=state,proto3,enum=workflows.v1.JobState" json:"state,omitempty"`    // The current state of the job.
	SubmittedAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=submitted_at,json=submittedAt,proto3" json:"submitted_at,omitempty"` // The time the job was submitted.
	StartedAt   *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=started_at,json=startedAt,proto3" json:"started_at,omitempty"`       // The time the job started running.
	// contains filtered or unexported fields
}

A job is a logical grouping of tasks that are related.

func (*Job) Descriptor deprecated 

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

Deprecated: Use Job.ProtoReflect.Descriptor instead.

func (*Job) GetCanceled 

func (x *Job) GetCanceled() bool

func (*Job) GetCompleted 

func (x *Job) GetCompleted() bool

func (*Job) GetId 

func (x *Job) GetId() *UUID

func (*Job) GetName 

func (x *Job) GetName() string

func (*Job) GetStartedAt 

func (x *Job) GetStartedAt() *timestamppb.Timestamp

func (*Job) GetState 

func (x *Job) GetState() JobState

func (*Job) GetSubmittedAt 

func (x *Job) GetSubmittedAt() *timestamppb.Timestamp

func (*Job) GetTraceParent 

func (x *Job) GetTraceParent() string

func (*Job) ProtoMessage 

func (*Job) ProtoMessage()

func (*Job) ProtoReflect 

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

func (*Job) Reset 

func (x *Job) Reset()

func (*Job) String 

func (x *Job) String() string

type JobServiceClient 

type JobServiceClient interface {
	SubmitJob(ctx context.Context, in *SubmitJobRequest, opts ...grpc.CallOption) (*Job, error)
	GetJob(ctx context.Context, in *GetJobRequest, opts ...grpc.CallOption) (*Job, error)
	RetryJob(ctx context.Context, in *RetryJobRequest, opts ...grpc.CallOption) (*RetryJobResponse, error)
	CancelJob(ctx context.Context, in *CancelJobRequest, opts ...grpc.CallOption) (*CancelJobResponse, error)
	VisualizeJob(ctx context.Context, in *VisualizeJobRequest, opts ...grpc.CallOption) (*Diagram, error)
	ListJobs(ctx context.Context, in *ListJobsRequest, opts ...grpc.CallOption) (*ListJobsResponse, error)
}

JobServiceClient is the client API for JobService 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.

A service for interacting with jobs.

func NewJobServiceClient 

func NewJobServiceClient(cc grpc.ClientConnInterface) JobServiceClient

type JobServiceServer 

type JobServiceServer interface {
	SubmitJob(context.Context, *SubmitJobRequest) (*Job, error)
	GetJob(context.Context, *GetJobRequest) (*Job, error)
	RetryJob(context.Context, *RetryJobRequest) (*RetryJobResponse, error)
	CancelJob(context.Context, *CancelJobRequest) (*CancelJobResponse, error)
	VisualizeJob(context.Context, *VisualizeJobRequest) (*Diagram, error)
	ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)
	// contains filtered or unexported methods
}

JobServiceServer is the server API for JobService service. All implementations must embed UnimplementedJobServiceServer for forward compatibility.

A service for interacting with jobs.

type JobState 

type JobState int32

The state of a job. 

const (
	JobState_JOB_STATE_UNSPECIFIED JobState = 0
	// The job is queued and waiting to be run.
	JobState_JOB_STATE_QUEUED JobState = 1
	// At least one task of the job has been started.
	JobState_JOB_STATE_STARTED JobState = 2
	// All tasks of the job have been completed.
	JobState_JOB_STATE_COMPLETED JobState = 3
)

func (JobState) Descriptor 

func (JobState) Descriptor() protoreflect.EnumDescriptor

func (JobState) Enum 

func (x JobState) Enum() *JobState

func (JobState) EnumDescriptor deprecated 

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

Deprecated: Use JobState.Descriptor instead.

func (JobState) Number 

func (x JobState) Number() protoreflect.EnumNumber

func (JobState) String 

func (x JobState) String() string

func (JobState) Type 

func (JobState) Type() protoreflect.EnumType

type ListClustersRequest 

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

ListClustersRequest lists all clusters.

func (*ListClustersRequest) Descriptor deprecated 

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

Deprecated: Use ListClustersRequest.ProtoReflect.Descriptor instead.

func (*ListClustersRequest) ProtoMessage 

func (*ListClustersRequest) ProtoMessage()

func (*ListClustersRequest) ProtoReflect 

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

func (*ListClustersRequest) Reset 

func (x *ListClustersRequest) Reset()

func (*ListClustersRequest) String 

func (x *ListClustersRequest) String() string

type ListClustersResponse 

type ListClustersResponse struct {

	// The clusters.
	Clusters []*Cluster `protobuf:"bytes,1,rep,name=clusters,proto3" json:"clusters,omitempty"`
	// contains filtered or unexported fields
}

ListClustersResponse is the response to ListClustersRequest.

func (*ListClustersResponse) Descriptor deprecated 

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

Deprecated: Use ListClustersResponse.ProtoReflect.Descriptor instead.

func (*ListClustersResponse) GetClusters 

func (x *ListClustersResponse) GetClusters() []*Cluster

func (*ListClustersResponse) ProtoMessage 

func (*ListClustersResponse) ProtoMessage()

func (*ListClustersResponse) ProtoReflect 

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

func (*ListClustersResponse) Reset 

func (x *ListClustersResponse) Reset()

func (*ListClustersResponse) String 

func (x *ListClustersResponse) String() string

type ListJobsRequest 

type ListJobsRequest struct {

	// The ID interval for which jobs are requested.
	IdInterval *IDInterval `protobuf:"bytes,1,opt,name=id_interval,json=idInterval,proto3" json:"id_interval,omitempty"`
	// The pagination parameters for this request.
	Page *Pagination `protobuf:"bytes,2,opt,name=page,proto3,oneof" json:"page,omitempty"`
	// contains filtered or unexported fields
}

ListJobsRequest requests a list of jobs.

func (*ListJobsRequest) Descriptor deprecated 

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

Deprecated: Use ListJobsRequest.ProtoReflect.Descriptor instead.

func (*ListJobsRequest) GetIdInterval 

func (x *ListJobsRequest) GetIdInterval() *IDInterval

func (*ListJobsRequest) GetPage 

func (x *ListJobsRequest) GetPage() *Pagination

func (*ListJobsRequest) ProtoMessage 

func (*ListJobsRequest) ProtoMessage()

func (*ListJobsRequest) ProtoReflect 

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

func (*ListJobsRequest) Reset 

func (x *ListJobsRequest) Reset()

func (*ListJobsRequest) String 

func (x *ListJobsRequest) String() string

type ListJobsResponse 

type ListJobsResponse struct {

	// The jobs.
	Jobs []*Job `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"`
	// The pagination parameters for the next page.
	NextPage *Pagination `protobuf:"bytes,3,opt,name=next_page,json=nextPage,proto3,oneof" json:"next_page,omitempty"`
	// contains filtered or unexported fields
}

A list of jobs.

func (*ListJobsResponse) Descriptor deprecated 

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

Deprecated: Use ListJobsResponse.ProtoReflect.Descriptor instead.

func (*ListJobsResponse) GetJobs 

func (x *ListJobsResponse) GetJobs() []*Job

func (*ListJobsResponse) GetNextPage 

func (x *ListJobsResponse) GetNextPage() *Pagination

func (*ListJobsResponse) ProtoMessage 

func (*ListJobsResponse) ProtoMessage()

func (*ListJobsResponse) ProtoReflect 

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

func (*ListJobsResponse) Reset 

func (x *ListJobsResponse) Reset()

func (*ListJobsResponse) String 

func (x *ListJobsResponse) String() string

type NextTaskRequest 

type NextTaskRequest struct {
	ComputedTask *ComputedTask `protobuf:"bytes,1,opt,name=computed_task,json=computedTask,proto3,oneof" json:"computed_task,omitempty"` // The task that has been computed. If not set, the next task will
	// The capabilities of the task runner, and therefore the potential tasks that can be run by that task runner.
	NextTaskToRun *NextTaskToRun `protobuf:"bytes,2,opt,name=next_task_to_run,json=nextTaskToRun,proto3,oneof" json:"next_task_to_run,omitempty"`
	// contains filtered or unexported fields
}

NextTaskRequest is the request for requesting the next task to run and marking a task as computed.

func (*NextTaskRequest) Descriptor deprecated 

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

Deprecated: Use NextTaskRequest.ProtoReflect.Descriptor instead.

func (*NextTaskRequest) GetComputedTask 

func (x *NextTaskRequest) GetComputedTask() *ComputedTask

func (*NextTaskRequest) GetNextTaskToRun 

func (x *NextTaskRequest) GetNextTaskToRun() *NextTaskToRun

func (*NextTaskRequest) ProtoMessage 

func (*NextTaskRequest) ProtoMessage()

func (*NextTaskRequest) ProtoReflect 

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

func (*NextTaskRequest) Reset 

func (x *NextTaskRequest) Reset()

func (*NextTaskRequest) String 

func (x *NextTaskRequest) String() string

type NextTaskResponse 

type NextTaskResponse struct {
	NextTask *Task `protobuf:"bytes,1,opt,name=next_task,json=nextTask,proto3" json:"next_task,omitempty"`
	// contains filtered or unexported fields
}

NextTaskResponse is the response to the NextTask request. Right now it only contains the next task to run. Wrapped in a message to allow adding more fields later if needed.

func (*NextTaskResponse) Descriptor deprecated 

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

Deprecated: Use NextTaskResponse.ProtoReflect.Descriptor instead.

func (*NextTaskResponse) GetNextTask 

func (x *NextTaskResponse) GetNextTask() *Task

func (*NextTaskResponse) ProtoMessage 

func (*NextTaskResponse) ProtoMessage()

func (*NextTaskResponse) ProtoReflect 

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

func (*NextTaskResponse) Reset 

func (x *NextTaskResponse) Reset()

func (*NextTaskResponse) String 

func (x *NextTaskResponse) String() string

type NextTaskToRun 

type NextTaskToRun struct {
	ClusterSlug string            `protobuf:"bytes,1,opt,name=cluster_slug,json=clusterSlug,proto3" json:"cluster_slug,omitempty"` // The cluster that this task runner is running on.
	Identifiers []*TaskIdentifier `protobuf:"bytes,2,rep,name=identifiers,proto3" json:"identifiers,omitempty"`                    // The task identifiers that this task runner can run.
	// contains filtered or unexported fields
}

NextTaskToRun is a message specifying the capabilities of the task runner, and therefore the potential tasks that can be run by that task runner.

func (*NextTaskToRun) Descriptor deprecated 

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

Deprecated: Use NextTaskToRun.ProtoReflect.Descriptor instead.

func (*NextTaskToRun) GetClusterSlug 

func (x *NextTaskToRun) GetClusterSlug() string

func (*NextTaskToRun) GetIdentifiers 

func (x *NextTaskToRun) GetIdentifiers() []*TaskIdentifier

func (*NextTaskToRun) ProtoMessage 

func (*NextTaskToRun) ProtoMessage()

func (*NextTaskToRun) ProtoReflect 

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

func (*NextTaskToRun) Reset 

func (x *NextTaskToRun) Reset()

func (*NextTaskToRun) String 

func (x *NextTaskToRun) String() string

type Pagination 

type Pagination struct {

	// The maximum number of entries to return.
	Limit *int64 `protobuf:"varint,1,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// Return entries starting after this entry.
	// This is the id of the last entry returned in the previous page as the next parameter in each paginated query.
	StartingAfter *string `protobuf:"bytes,2,opt,name=starting_after,json=startingAfter,proto3,oneof" json:"starting_after,omitempty"`
	// contains filtered or unexported fields
}

Pagination information for paginated queries

func (*Pagination) Descriptor deprecated 

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

Deprecated: Use Pagination.ProtoReflect.Descriptor instead.

func (*Pagination) GetLimit 

func (x *Pagination) GetLimit() int64

func (*Pagination) GetStartingAfter 

func (x *Pagination) GetStartingAfter() string

func (*Pagination) ProtoMessage 

func (*Pagination) ProtoMessage()

func (*Pagination) ProtoReflect 

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

func (*Pagination) Reset 

func (x *Pagination) Reset()

func (*Pagination) String 

func (x *Pagination) String() string

type RecurrentTask 

type RecurrentTask struct {

	// Details of the event that triggered the task. This is a serialized protobuf message. The type of the message
	// depends on the type of the trigger, either StorageEventTriggerEvent or CronTriggerEvent.
	TriggerEvent []byte `protobuf:"bytes,1,opt,name=trigger_event,json=triggerEvent,proto3" json:"trigger_event,omitempty"`
	Args         []byte `protobuf:"bytes,2,opt,name=args,proto3" json:"args,omitempty"` // Additional, user-defined arguments for the task, to be deserialized by the task itself
	// contains filtered or unexported fields
}

RecurrentTask is an actual submitted task that was triggered by a recurrent task prototype. It contains the trigger arguments of the event that triggered the task, and the custom, user-defined task arguments.

func (*RecurrentTask) Descriptor deprecated 

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

Deprecated: Use RecurrentTask.ProtoReflect.Descriptor instead.

func (*RecurrentTask) GetArgs 

func (x *RecurrentTask) GetArgs() []byte

func (*RecurrentTask) GetTriggerEvent 

func (x *RecurrentTask) GetTriggerEvent() []byte

func (*RecurrentTask) ProtoMessage 

func (*RecurrentTask) ProtoMessage()

func (*RecurrentTask) ProtoReflect 

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

func (*RecurrentTask) Reset 

func (x *RecurrentTask) Reset()

func (*RecurrentTask) String 

func (x *RecurrentTask) String() string

type RecurrentTaskPrototype 

type RecurrentTaskPrototype struct {
	Id                   *UUID                  `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`                                                                   // Unique identifier for the trigger
	Name                 string                 `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`                                                               // A human-readable name for the trigger
	Prototype            *TaskSubmission        `protobuf:"bytes,3,opt,name=prototype,proto3" json:"prototype,omitempty"`                                                     // The task submission to trigger
	StorageEventTriggers []*StorageEventTrigger `protobuf:"bytes,4,rep,name=storage_event_triggers,json=storageEventTriggers,proto3" json:"storage_event_triggers,omitempty"` // The storage event triggers that will trigger the task
	CronTriggers         []*CronTrigger         `protobuf:"bytes,5,rep,name=cron_triggers,json=cronTriggers,proto3" json:"cron_triggers,omitempty"`                           // The cron triggers that will trigger the task
	// contains filtered or unexported fields
}

RecurrentTaskPrototype is a task prototype that can result in many submitted tasks. Task submissions are triggered by NRT triggers, such as bucket triggers or cron triggers.

func (*RecurrentTaskPrototype) Descriptor deprecated 

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

Deprecated: Use RecurrentTaskPrototype.ProtoReflect.Descriptor instead.

func (*RecurrentTaskPrototype) GetCronTriggers 

func (x *RecurrentTaskPrototype) GetCronTriggers() []*CronTrigger

func (*RecurrentTaskPrototype) GetId 

func (x *RecurrentTaskPrototype) GetId() *UUID

func (*RecurrentTaskPrototype) GetName 

func (x *RecurrentTaskPrototype) GetName() string

func (*RecurrentTaskPrototype) GetPrototype 

func (x *RecurrentTaskPrototype) GetPrototype() *TaskSubmission

func (*RecurrentTaskPrototype) GetStorageEventTriggers 

func (x *RecurrentTaskPrototype) GetStorageEventTriggers() []*StorageEventTrigger

func (*RecurrentTaskPrototype) ProtoMessage 

func (*RecurrentTaskPrototype) ProtoMessage()

func (*RecurrentTaskPrototype) ProtoReflect 

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

func (*RecurrentTaskPrototype) Reset 

func (x *RecurrentTaskPrototype) Reset()

func (*RecurrentTaskPrototype) String 

func (x *RecurrentTaskPrototype) String() string

type RecurrentTaskServiceClient 

type RecurrentTaskServiceClient interface {
	// ListStorageLocations lists all the storage buckets that are available for use as bucket triggers.
	ListStorageLocations(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*StorageLocations, error)
	// GetStorageLocation gets a storage location by its ID.
	GetStorageLocation(ctx context.Context, in *UUID, opts ...grpc.CallOption) (*StorageLocation, error)
	// CreateStorageLocation creates a new storage bucket.
	CreateStorageLocation(ctx context.Context, in *StorageLocation, opts ...grpc.CallOption) (*StorageLocation, error)
	// DeleteStorageLocation deletes a storage location.
	DeleteStorageLocation(ctx context.Context, in *UUID, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// ListRecurrentTasks lists all the recurrent tasks that are currently registered in a namespace.
	ListRecurrentTasks(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*RecurrentTasks, error)
	// GetRecurrentTask gets a recurrent task by its ID.
	GetRecurrentTask(ctx context.Context, in *UUID, opts ...grpc.CallOption) (*RecurrentTaskPrototype, error)
	// CreateRecurrentTask creates a new recurrent task in a namespace.
	CreateRecurrentTask(ctx context.Context, in *RecurrentTaskPrototype, opts ...grpc.CallOption) (*RecurrentTaskPrototype, error)
	// UpdateRecurrentTask updates a recurrent task in a namespace.
	UpdateRecurrentTask(ctx context.Context, in *RecurrentTaskPrototype, opts ...grpc.CallOption) (*RecurrentTaskPrototype, error)
	// DeleteRecurrentTask deletes a recurrent task from a namespace.
	DeleteRecurrentTask(ctx context.Context, in *UUID, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

RecurrentTaskServiceClient is the client API for RecurrentTaskService 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.

RecurrentTaskService is a service for managing recurrent tasks. Currently, we support two types of triggers for recurrent tasks: - Bucket triggers, which triggers tasks when an object is uploaded to a storage bucket that matches a glob pattern - Cron triggers, which triggers tasks on a schedule

func NewRecurrentTaskServiceClient 

func NewRecurrentTaskServiceClient(cc grpc.ClientConnInterface) RecurrentTaskServiceClient

type RecurrentTaskServiceServer 

type RecurrentTaskServiceServer interface {
	// ListStorageLocations lists all the storage buckets that are available for use as bucket triggers.
	ListStorageLocations(context.Context, *emptypb.Empty) (*StorageLocations, error)
	// GetStorageLocation gets a storage location by its ID.
	GetStorageLocation(context.Context, *UUID) (*StorageLocation, error)
	// CreateStorageLocation creates a new storage bucket.
	CreateStorageLocation(context.Context, *StorageLocation) (*StorageLocation, error)
	// DeleteStorageLocation deletes a storage location.
	DeleteStorageLocation(context.Context, *UUID) (*emptypb.Empty, error)
	// ListRecurrentTasks lists all the recurrent tasks that are currently registered in a namespace.
	ListRecurrentTasks(context.Context, *emptypb.Empty) (*RecurrentTasks, error)
	// GetRecurrentTask gets a recurrent task by its ID.
	GetRecurrentTask(context.Context, *UUID) (*RecurrentTaskPrototype, error)
	// CreateRecurrentTask creates a new recurrent task in a namespace.
	CreateRecurrentTask(context.Context, *RecurrentTaskPrototype) (*RecurrentTaskPrototype, error)
	// UpdateRecurrentTask updates a recurrent task in a namespace.
	UpdateRecurrentTask(context.Context, *RecurrentTaskPrototype) (*RecurrentTaskPrototype, error)
	// DeleteRecurrentTask deletes a recurrent task from a namespace.
	DeleteRecurrentTask(context.Context, *UUID) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

RecurrentTaskServiceServer is the server API for RecurrentTaskService service. All implementations must embed UnimplementedRecurrentTaskServiceServer for forward compatibility.

RecurrentTaskService is a service for managing recurrent tasks. Currently, we support two types of triggers for recurrent tasks: - Bucket triggers, which triggers tasks when an object is uploaded to a storage bucket that matches a glob pattern - Cron triggers, which triggers tasks on a schedule

type RecurrentTasks 

type RecurrentTasks struct {
	Tasks []*RecurrentTaskPrototype `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// contains filtered or unexported fields
}

RecurrentTasks is a list of recurrent tasks

func (*RecurrentTasks) Descriptor deprecated 

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

Deprecated: Use RecurrentTasks.ProtoReflect.Descriptor instead.

func (*RecurrentTasks) GetTasks 

func (x *RecurrentTasks) GetTasks() []*RecurrentTaskPrototype

func (*RecurrentTasks) ProtoMessage 

func (*RecurrentTasks) ProtoMessage()

func (*RecurrentTasks) ProtoReflect 

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

func (*RecurrentTasks) Reset 

func (x *RecurrentTasks) Reset()

func (*RecurrentTasks) String 

func (x *RecurrentTasks) String() string

type RenderDiagramRequest 

type RenderDiagramRequest struct {
	Diagram       string         `protobuf:"bytes,1,opt,name=diagram,proto3" json:"diagram,omitempty"`                                  // The diagram graph in the D2 syntax
	RenderOptions *RenderOptions `protobuf:"bytes,2,opt,name=render_options,json=renderOptions,proto3" json:"render_options,omitempty"` // The options for rendering the diagram
	// contains filtered or unexported fields
}

Request to render a diagram

func (*RenderDiagramRequest) Descriptor deprecated 

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

Deprecated: Use RenderDiagramRequest.ProtoReflect.Descriptor instead.

func (*RenderDiagramRequest) GetDiagram 

func (x *RenderDiagramRequest) GetDiagram() string

func (*RenderDiagramRequest) GetRenderOptions 

func (x *RenderDiagramRequest) GetRenderOptions() *RenderOptions

func (*RenderDiagramRequest) ProtoMessage 

func (*RenderDiagramRequest) ProtoMessage()

func (*RenderDiagramRequest) ProtoReflect 

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

func (*RenderDiagramRequest) Reset 

func (x *RenderDiagramRequest) Reset()

func (*RenderDiagramRequest) String 

func (x *RenderDiagramRequest) String() string

type RenderOptions 

type RenderOptions struct {

	// The layout to use for rendering the diagram: https://d2lang.com/tour/layouts/.
	// "dagre" or "elk". Defaults to "dagre"
	Layout string `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
	// The theme to use for rendering the diagram: https://d2lang.com/tour/themes/
	ThemeId *int64 `protobuf:"varint,2,opt,name=theme_id,json=themeId,proto3,oneof" json:"theme_id,omitempty"`
	// Whether to render the diagram in a sketchy (hand-drawn) style
	Sketchy bool `protobuf:"varint,3,opt,name=sketchy,proto3" json:"sketchy,omitempty"`
	// The padding around the diagram
	Padding int64 `protobuf:"varint,4,opt,name=padding,proto3" json:"padding,omitempty"`
	// Set explicitly the direction of the diagram: https://d2lang.com/tour/layouts/#direction.
	// "up", "down", "right", "left".
	Direction string `protobuf:"bytes,5,opt,name=direction,proto3" json:"direction,omitempty"`
	// contains filtered or unexported fields
}

Options for rendering the diagram

func (*RenderOptions) Descriptor deprecated 

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

Deprecated: Use RenderOptions.ProtoReflect.Descriptor instead.

func (*RenderOptions) GetDirection 

func (x *RenderOptions) GetDirection() string

func (*RenderOptions) GetLayout 

func (x *RenderOptions) GetLayout() string

func (*RenderOptions) GetPadding 

func (x *RenderOptions) GetPadding() int64

func (*RenderOptions) GetSketchy 

func (x *RenderOptions) GetSketchy() bool

func (*RenderOptions) GetThemeId 

func (x *RenderOptions) GetThemeId() int64

func (*RenderOptions) ProtoMessage 

func (*RenderOptions) ProtoMessage()

func (*RenderOptions) ProtoReflect 

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

func (*RenderOptions) Reset 

func (x *RenderOptions) Reset()

func (*RenderOptions) String 

func (x *RenderOptions) String() string

type RetryJobRequest 

type RetryJobRequest struct {

	// The job to retry.
	JobId *UUID `protobuf:"bytes,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// contains filtered or unexported fields
}

RetryJobRequest requests a retry of a job that has failed.

func (*RetryJobRequest) Descriptor deprecated 

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

Deprecated: Use RetryJobRequest.ProtoReflect.Descriptor instead.

func (*RetryJobRequest) GetJobId 

func (x *RetryJobRequest) GetJobId() *UUID

func (*RetryJobRequest) ProtoMessage 

func (*RetryJobRequest) ProtoMessage()

func (*RetryJobRequest) ProtoReflect 

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

func (*RetryJobRequest) Reset 

func (x *RetryJobRequest) Reset()

func (*RetryJobRequest) String 

func (x *RetryJobRequest) String() string

type RetryJobResponse 

type RetryJobResponse struct {

	// The number of tasks that were rescheduled.
	NumTasksRescheduled int64 `protobuf:"varint,1,opt,name=num_tasks_rescheduled,json=numTasksRescheduled,proto3" json:"num_tasks_rescheduled,omitempty"`
	// contains filtered or unexported fields
}

RetryJobResponse is the response to a RetryJobRequest.

func (*RetryJobResponse) Descriptor deprecated 

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

Deprecated: Use RetryJobResponse.ProtoReflect.Descriptor instead.

func (*RetryJobResponse) GetNumTasksRescheduled 

func (x *RetryJobResponse) GetNumTasksRescheduled() int64

func (*RetryJobResponse) ProtoMessage 

func (*RetryJobResponse) ProtoMessage()

func (*RetryJobResponse) ProtoReflect 

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

func (*RetryJobResponse) Reset 

func (x *RetryJobResponse) Reset()

func (*RetryJobResponse) String 

func (x *RetryJobResponse) String() string

type StorageEventTrigger 

type StorageEventTrigger struct {
	Id              *UUID            `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`                                                  // Unique identifier for the trigger
	StorageLocation *StorageLocation `protobuf:"bytes,2,opt,name=storage_location,json=storageLocation,proto3" json:"storage_location,omitempty"` // The storage location to watch for events
	GlobPattern     string           `protobuf:"bytes,3,opt,name=glob_pattern,json=globPattern,proto3" json:"glob_pattern,omitempty"`             // A glob pattern to match objects/files in the storage location
	// contains filtered or unexported fields
}

StorageEventTrigger is a trigger that will trigger a task submission when an object matching the glob pattern is created in a storage location.

func (*StorageEventTrigger) Descriptor deprecated 

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

Deprecated: Use StorageEventTrigger.ProtoReflect.Descriptor instead.

func (*StorageEventTrigger) GetGlobPattern 

func (x *StorageEventTrigger) GetGlobPattern() string

func (*StorageEventTrigger) GetId 

func (x *StorageEventTrigger) GetId() *UUID

func (*StorageEventTrigger) GetStorageLocation 

func (x *StorageEventTrigger) GetStorageLocation() *StorageLocation

func (*StorageEventTrigger) ProtoMessage 

func (*StorageEventTrigger) ProtoMessage()

func (*StorageEventTrigger) ProtoReflect 

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

func (*StorageEventTrigger) Reset 

func (x *StorageEventTrigger) Reset()

func (*StorageEventTrigger) String 

func (x *StorageEventTrigger) String() string

type StorageEventType 

type StorageEventType int32

StorageEventType specifies the type of event that triggered the task. 

const (
	StorageEventType_STORAGE_EVENT_TYPE_UNSPECIFIED StorageEventType = 0
	StorageEventType_STORAGE_EVENT_TYPE_CREATED     StorageEventType = 1
)

func (StorageEventType) Descriptor 

func (StorageEventType) Descriptor() protoreflect.EnumDescriptor

func (StorageEventType) Enum 

func (x StorageEventType) Enum() *StorageEventType

func (StorageEventType) EnumDescriptor deprecated 

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

Deprecated: Use StorageEventType.Descriptor instead.

func (StorageEventType) Number 

func (x StorageEventType) Number() protoreflect.EnumNumber

func (StorageEventType) String 

func (x StorageEventType) String() string

func (StorageEventType) Type 

func (StorageEventType) Type() protoreflect.EnumType

type StorageLocation 

type StorageLocation struct {
	Id       *UUID       `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`                                    // Unique identifier for the storage location
	Location string      `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`                        // A unique identifier for the storage location in the storage system
	Type     StorageType `protobuf:"varint,3,opt,name=type,proto3,enum=workflows.v1.StorageType" json:"type,omitempty"` // The type of the storage location, e.g. GCS, S3, FS
	// contains filtered or unexported fields
}

Storage location is some kind of storage that can contain data files or objects and be used as a trigger source.

func (*StorageLocation) Descriptor deprecated 

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

Deprecated: Use StorageLocation.ProtoReflect.Descriptor instead.

func (*StorageLocation) GetId 

func (x *StorageLocation) GetId() *UUID

func (*StorageLocation) GetLocation 

func (x *StorageLocation) GetLocation() string

func (*StorageLocation) GetType 

func (x *StorageLocation) GetType() StorageType

func (*StorageLocation) ProtoMessage 

func (*StorageLocation) ProtoMessage()

func (*StorageLocation) ProtoReflect 

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

func (*StorageLocation) Reset 

func (x *StorageLocation) Reset()

func (*StorageLocation) String 

func (x *StorageLocation) String() string

type StorageLocations 

type StorageLocations struct {
	Locations []*StorageLocation `protobuf:"bytes,1,rep,name=locations,proto3" json:"locations,omitempty"`
	// contains filtered or unexported fields
}

Buckets is a list of storage buckets

func (*StorageLocations) Descriptor deprecated 

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

Deprecated: Use StorageLocations.ProtoReflect.Descriptor instead.

func (*StorageLocations) GetLocations 

func (x *StorageLocations) GetLocations() []*StorageLocation

func (*StorageLocations) ProtoMessage 

func (*StorageLocations) ProtoMessage()

func (*StorageLocations) ProtoReflect 

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

func (*StorageLocations) Reset 

func (x *StorageLocations) Reset()

func (*StorageLocations) String 

func (x *StorageLocations) String() string

type StorageType 

type StorageType int32

StorageType specifies a kind of storage bucket that we support. 

const (
	StorageType_STORAGE_TYPE_UNSPECIFIED StorageType = 0
	StorageType_STORAGE_TYPE_GCS         StorageType = 1 // Google Cloud Storage
	StorageType_STORAGE_TYPE_S3          StorageType = 2 // Amazon Web Services S3
	StorageType_STORAGE_TYPE_FS          StorageType = 3 // Local filesystem
)

func (StorageType) Descriptor 

func (StorageType) Descriptor() protoreflect.EnumDescriptor

func (StorageType) Enum 

func (x StorageType) Enum() *StorageType

func (StorageType) EnumDescriptor deprecated 

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

Deprecated: Use StorageType.Descriptor instead.

func (StorageType) Number 

func (x StorageType) Number() protoreflect.EnumNumber

func (StorageType) String 

func (x StorageType) String() string

func (StorageType) Type 

func (StorageType) Type() protoreflect.EnumType

type SubmitJobRequest 

type SubmitJobRequest struct {

	// The root tasks for the job.
	Tasks []*TaskSubmission `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// The name of the job.
	JobName string `protobuf:"bytes,2,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// Tracing information for the job. This is used to propagate tracing information to the workers that execute the job.
	TraceParent string `protobuf:"bytes,3,opt,name=trace_parent,json=traceParent,proto3" json:"trace_parent,omitempty"`
	// contains filtered or unexported fields
}

SubmitJobRequest submits and schedules a job for execution. The job can have multiple root tasks.

func (*SubmitJobRequest) Descriptor deprecated 

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

Deprecated: Use SubmitJobRequest.ProtoReflect.Descriptor instead.

func (*SubmitJobRequest) GetJobName 

func (x *SubmitJobRequest) GetJobName() string

func (*SubmitJobRequest) GetTasks 

func (x *SubmitJobRequest) GetTasks() []*TaskSubmission

func (*SubmitJobRequest) GetTraceParent 

func (x *SubmitJobRequest) GetTraceParent() string

func (*SubmitJobRequest) ProtoMessage 

func (*SubmitJobRequest) ProtoMessage()

func (*SubmitJobRequest) ProtoReflect 

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

func (*SubmitJobRequest) Reset 

func (x *SubmitJobRequest) Reset()

func (*SubmitJobRequest) String 

func (x *SubmitJobRequest) String() string

type Task 

type Task struct {
	Id *UUID `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // The id of the task instance. Contains the submission timestamp as the time part of the ULID.
	// Unique identifier for the task. Used by runners to match tasks to specific functions.
	Identifier *TaskIdentifier `protobuf:"bytes,2,opt,name=identifier,proto3" json:"identifier,omitempty"`
	State      TaskState       `protobuf:"varint,3,opt,name=state,proto3,enum=workflows.v1.TaskState" json:"state,omitempty"` // The current state of the task.
	Input      []byte          `protobuf:"bytes,4,opt,name=input,proto3,oneof" json:"input,omitempty"`                        // The serialized input parameters for the task in the format that this task expects.
	// Display is a human readable representation of the Task used for printing or visualizations
	Display    *string    `protobuf:"bytes,5,opt,name=display,proto3,oneof" json:"display,omitempty"`
	Job        *Job       `protobuf:"bytes,6,opt,name=job,proto3" json:"job,omitempty"`                                   // The job that this task belongs to.
	ParentId   *UUID      `protobuf:"bytes,7,opt,name=parent_id,json=parentId,proto3" json:"parent_id,omitempty"`         // The id of the parent task.
	DependsOn  []*UUID    `protobuf:"bytes,8,rep,name=depends_on,json=dependsOn,proto3" json:"depends_on,omitempty"`      // The ids of the tasks that this task depends on.
	Lease      *TaskLease `protobuf:"bytes,9,opt,name=lease,proto3" json:"lease,omitempty"`                               // The lease of the task.
	RetryCount int64      `protobuf:"varint,10,opt,name=retry_count,json=retryCount,proto3" json:"retry_count,omitempty"` // The number of times this task has been retried.
	// contains filtered or unexported fields
}

A task is a single unit of work.

func (*Task) Descriptor deprecated 

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

Deprecated: Use Task.ProtoReflect.Descriptor instead.

func (*Task) GetDependsOn 

func (x *Task) GetDependsOn() []*UUID

func (*Task) GetDisplay 

func (x *Task) GetDisplay() string

func (*Task) GetId 

func (x *Task) GetId() *UUID

func (*Task) GetIdentifier 

func (x *Task) GetIdentifier() *TaskIdentifier

func (*Task) GetInput 

func (x *Task) GetInput() []byte

func (*Task) GetJob 

func (x *Task) GetJob() *Job

func (*Task) GetLease 

func (x *Task) GetLease() *TaskLease

func (*Task) GetParentId 

func (x *Task) GetParentId() *UUID

func (*Task) GetRetryCount 

func (x *Task) GetRetryCount() int64

func (*Task) GetState 

func (x *Task) GetState() TaskState

func (*Task) ProtoMessage 

func (*Task) ProtoMessage()

func (*Task) ProtoReflect 

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

func (*Task) Reset 

func (x *Task) Reset()

func (*Task) String 

func (x *Task) String() string

type TaskFailedRequest 

type TaskFailedRequest struct {
	TaskId    *UUID  `protobuf:"bytes,1,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
	Display   string `protobuf:"bytes,2,opt,name=display,proto3" json:"display,omitempty"`
	CancelJob bool   `protobuf:"varint,3,opt,name=cancel_job,json=cancelJob,proto3" json:"cancel_job,omitempty"`
	// contains filtered or unexported fields
}

TaskFailedRequest is the request for marking a task as failed.

func (*TaskFailedRequest) Descriptor deprecated 

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

Deprecated: Use TaskFailedRequest.ProtoReflect.Descriptor instead.

func (*TaskFailedRequest) GetCancelJob 

func (x *TaskFailedRequest) GetCancelJob() bool

func (*TaskFailedRequest) GetDisplay 

func (x *TaskFailedRequest) GetDisplay() string

func (*TaskFailedRequest) GetTaskId 

func (x *TaskFailedRequest) GetTaskId() *UUID

func (*TaskFailedRequest) ProtoMessage 

func (*TaskFailedRequest) ProtoMessage()

func (*TaskFailedRequest) ProtoReflect 

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

func (*TaskFailedRequest) Reset 

func (x *TaskFailedRequest) Reset()

func (*TaskFailedRequest) String 

func (x *TaskFailedRequest) String() string

type TaskIdentifier 

type TaskIdentifier struct {
	Name    string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`       // A unique name of a task (unique within a namespace).
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` // Version of the task.
	// contains filtered or unexported fields
}

An identifier for a task.

func (*TaskIdentifier) Descriptor deprecated 

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

Deprecated: Use TaskIdentifier.ProtoReflect.Descriptor instead.

func (*TaskIdentifier) GetName 

func (x *TaskIdentifier) GetName() string

func (*TaskIdentifier) GetVersion 

func (x *TaskIdentifier) GetVersion() string

func (*TaskIdentifier) ProtoMessage 

func (*TaskIdentifier) ProtoMessage()

func (*TaskIdentifier) ProtoReflect 

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

func (*TaskIdentifier) Reset 

func (x *TaskIdentifier) Reset()

func (*TaskIdentifier) String 

func (x *TaskIdentifier) String() string

type TaskLease 

type TaskLease struct {
	Lease                             *durationpb.Duration `protobuf:"bytes,1,opt,name=lease,proto3" json:"lease,omitempty"`
	RecommendedWaitUntilNextExtension *durationpb.Duration `` /* 166-byte string literal not displayed */
	// contains filtered or unexported fields
}

A lease for a task.

func (*TaskLease) Descriptor deprecated 

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

Deprecated: Use TaskLease.ProtoReflect.Descriptor instead.

func (*TaskLease) GetLease 

func (x *TaskLease) GetLease() *durationpb.Duration

func (*TaskLease) GetRecommendedWaitUntilNextExtension 

func (x *TaskLease) GetRecommendedWaitUntilNextExtension() *durationpb.Duration

func (*TaskLease) ProtoMessage 

func (*TaskLease) ProtoMessage()

func (*TaskLease) ProtoReflect 

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

func (*TaskLease) Reset 

func (x *TaskLease) Reset()

func (*TaskLease) String 

func (x *TaskLease) String() string

type TaskLeaseRequest 

type TaskLeaseRequest struct {
	TaskId         *UUID                `protobuf:"bytes,1,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
	RequestedLease *durationpb.Duration `protobuf:"bytes,2,opt,name=requested_lease,json=requestedLease,proto3,oneof" json:"requested_lease,omitempty"`
	// contains filtered or unexported fields
}

TaskLease is a message specifying the new lease expiration time of a task.

func (*TaskLeaseRequest) Descriptor deprecated 

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

Deprecated: Use TaskLeaseRequest.ProtoReflect.Descriptor instead.

func (*TaskLeaseRequest) GetRequestedLease 

func (x *TaskLeaseRequest) GetRequestedLease() *durationpb.Duration

func (*TaskLeaseRequest) GetTaskId 

func (x *TaskLeaseRequest) GetTaskId() *UUID

func (*TaskLeaseRequest) ProtoMessage 

func (*TaskLeaseRequest) ProtoMessage()

func (*TaskLeaseRequest) ProtoReflect 

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

func (*TaskLeaseRequest) Reset 

func (x *TaskLeaseRequest) Reset()

func (*TaskLeaseRequest) String 

func (x *TaskLeaseRequest) String() string

type TaskServiceClient 

type TaskServiceClient interface {
	// NextTask marks a task as computed and asks for the next task to run.
	// If no task marked as computed is sent, it is assumed that the task runner just started up or was idling so
	// the task server will send a task to run using a work-stealing algorithm.
	// If a task marked as computed is sent, the task server will send a next task to run using a depth first execution
	// algorithm, and only fall back to work-stealing if otherwise no tasks are available.
	// If the next_task_to_run field of the request is not set, a next task will never be returned, but a task
	// can still be marked as computed this way.
	NextTask(ctx context.Context, in *NextTaskRequest, opts ...grpc.CallOption) (*NextTaskResponse, error)
	// TaskFailed tells the task server that we have failed to compute a task.
	// The task server will then mark the task as queued or failed, depending on the retry policy,
	// and possibly cancel the job.
	// If a task runner wants to continue executing tasks, it should afterwards fetch a new one using GetTaskToRun.
	TaskFailed(ctx context.Context, in *TaskFailedRequest, opts ...grpc.CallOption) (*TaskStateResponse, error)
	// ExtendTaskLease is called by the task runner to extend the lease on a task.
	// On success, the response will contain the new lease expiration time.
	// If the task does not need to be extended, the response will be empty.
	ExtendTaskLease(ctx context.Context, in *TaskLeaseRequest, opts ...grpc.CallOption) (*TaskLease, error)
}

TaskServiceClient is the client API for TaskService 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.

A service for task runners to communicate with the workflows service.

func NewTaskServiceClient 

func NewTaskServiceClient(cc grpc.ClientConnInterface) TaskServiceClient

type TaskServiceServer 

type TaskServiceServer interface {
	// NextTask marks a task as computed and asks for the next task to run.
	// If no task marked as computed is sent, it is assumed that the task runner just started up or was idling so
	// the task server will send a task to run using a work-stealing algorithm.
	// If a task marked as computed is sent, the task server will send a next task to run using a depth first execution
	// algorithm, and only fall back to work-stealing if otherwise no tasks are available.
	// If the next_task_to_run field of the request is not set, a next task will never be returned, but a task
	// can still be marked as computed this way.
	NextTask(context.Context, *NextTaskRequest) (*NextTaskResponse, error)
	// TaskFailed tells the task server that we have failed to compute a task.
	// The task server will then mark the task as queued or failed, depending on the retry policy,
	// and possibly cancel the job.
	// If a task runner wants to continue executing tasks, it should afterwards fetch a new one using GetTaskToRun.
	TaskFailed(context.Context, *TaskFailedRequest) (*TaskStateResponse, error)
	// ExtendTaskLease is called by the task runner to extend the lease on a task.
	// On success, the response will contain the new lease expiration time.
	// If the task does not need to be extended, the response will be empty.
	ExtendTaskLease(context.Context, *TaskLeaseRequest) (*TaskLease, error)
	// contains filtered or unexported methods
}

TaskServiceServer is the server API for TaskService service. All implementations must embed UnimplementedTaskServiceServer for forward compatibility.

A service for task runners to communicate with the workflows service.

type TaskState 

type TaskState int32

The state of a task. 

const (
	TaskState_TASK_STATE_UNSPECIFIED TaskState = 0
	// The task is queued and waiting to be run.
	TaskState_TASK_STATE_QUEUED TaskState = 1
	// The task is currently running on some task runner.
	TaskState_TASK_STATE_RUNNING TaskState = 2
	// The task has been computed and the output is available.
	// If the task also has no more outstanding children, it is considered COMPLETED.
	TaskState_TASK_STATE_COMPUTED TaskState = 3
	// The task has failed.
	TaskState_TASK_STATE_FAILED TaskState = 4
	// The task has been cancelled due to user request.
	TaskState_TASK_STATE_CANCELLED TaskState = 5
)

func (TaskState) Descriptor 

func (TaskState) Descriptor() protoreflect.EnumDescriptor

func (TaskState) Enum 

func (x TaskState) Enum() *TaskState

func (TaskState) EnumDescriptor deprecated 

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

Deprecated: Use TaskState.Descriptor instead.

func (TaskState) Number 

func (x TaskState) Number() protoreflect.EnumNumber

func (TaskState) String 

func (x TaskState) String() string

func (TaskState) Type 

func (TaskState) Type() protoreflect.EnumType

type TaskStateResponse 

type TaskStateResponse struct {
	State TaskState `protobuf:"varint,1,opt,name=state,proto3,enum=workflows.v1.TaskState" json:"state,omitempty"`
	// contains filtered or unexported fields
}

TaskStateResponse is the response to the TaskFailed request, indicating the current state of the task marked as failed.

func (*TaskStateResponse) Descriptor deprecated 

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

Deprecated: Use TaskStateResponse.ProtoReflect.Descriptor instead.

func (*TaskStateResponse) GetState 

func (x *TaskStateResponse) GetState() TaskState

func (*TaskStateResponse) ProtoMessage 

func (*TaskStateResponse) ProtoMessage()

func (*TaskStateResponse) ProtoReflect 

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

func (*TaskStateResponse) Reset 

func (x *TaskStateResponse) Reset()

func (*TaskStateResponse) String 

func (x *TaskStateResponse) String() string

type TaskSubmission 

type TaskSubmission struct {
	ClusterSlug string          `protobuf:"bytes,1,opt,name=cluster_slug,json=clusterSlug,proto3" json:"cluster_slug,omitempty"` // The cluster that this task should be run on
	Identifier  *TaskIdentifier `protobuf:"bytes,2,opt,name=identifier,proto3" json:"identifier,omitempty"`                      // The task identifier
	Input       []byte          `protobuf:"bytes,3,opt,name=input,proto3" json:"input,omitempty"`                                // The serialized task instance
	Display     string          `protobuf:"bytes,4,opt,name=display,proto3" json:"display,omitempty"`                            // A human-readable description of the task
	// A list of indices, corresponding to tasks in the list of sub_tasks that this SubTask is part of.
	Dependencies []int64 `protobuf:"varint,5,rep,packed,name=dependencies,proto3" json:"dependencies,omitempty"`
	MaxRetries   int64   `protobuf:"varint,6,opt,name=max_retries,json=maxRetries,proto3" json:"max_retries,omitempty"` // The maximum number of retries for this task.
	// contains filtered or unexported fields
}

TaskSubmission is a message of a task that is just about to be submitted, either by submitting a job or as a subtask.

func (*TaskSubmission) Descriptor deprecated 

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

Deprecated: Use TaskSubmission.ProtoReflect.Descriptor instead.

func (*TaskSubmission) GetClusterSlug 

func (x *TaskSubmission) GetClusterSlug() string

func (*TaskSubmission) GetDependencies 

func (x *TaskSubmission) GetDependencies() []int64

func (*TaskSubmission) GetDisplay 

func (x *TaskSubmission) GetDisplay() string

func (*TaskSubmission) GetIdentifier 

func (x *TaskSubmission) GetIdentifier() *TaskIdentifier

func (*TaskSubmission) GetInput 

func (x *TaskSubmission) GetInput() []byte

func (*TaskSubmission) GetMaxRetries 

func (x *TaskSubmission) GetMaxRetries() int64

func (*TaskSubmission) ProtoMessage 

func (*TaskSubmission) ProtoMessage()

func (*TaskSubmission) ProtoReflect 

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

func (*TaskSubmission) Reset 

func (x *TaskSubmission) Reset()

func (*TaskSubmission) String 

func (x *TaskSubmission) String() string

type Tasks 

type Tasks struct {
	Tasks []*Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// contains filtered or unexported fields
}

A list of tasks.

func (*Tasks) Descriptor deprecated 

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

Deprecated: Use Tasks.ProtoReflect.Descriptor instead.

func (*Tasks) GetTasks 

func (x *Tasks) GetTasks() []*Task

func (*Tasks) ProtoMessage 

func (*Tasks) ProtoMessage()

func (*Tasks) ProtoReflect 

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

func (*Tasks) Reset 

func (x *Tasks) Reset()

func (*Tasks) String 

func (x *Tasks) String() string

type TriggeredCronEvent 

type TriggeredCronEvent struct {
	TriggerTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=trigger_time,json=triggerTime,proto3" json:"trigger_time,omitempty"` // The time the cron trigger fired
	// contains filtered or unexported fields
}

TriggeredCronEvent contains the details of a concrete event that triggered a cron trigger.

func (*TriggeredCronEvent) Descriptor deprecated 

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

Deprecated: Use TriggeredCronEvent.ProtoReflect.Descriptor instead.

func (*TriggeredCronEvent) GetTriggerTime 

func (x *TriggeredCronEvent) GetTriggerTime() *timestamppb.Timestamp

func (*TriggeredCronEvent) ProtoMessage 

func (*TriggeredCronEvent) ProtoMessage()

func (*TriggeredCronEvent) ProtoReflect 

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

func (*TriggeredCronEvent) Reset 

func (x *TriggeredCronEvent) Reset()

func (*TriggeredCronEvent) String 

func (x *TriggeredCronEvent) String() string

type TriggeredStorageEvent 

type TriggeredStorageEvent struct {
	StorageLocationId *UUID            `protobuf:"bytes,1,opt,name=storage_location_id,json=storageLocationId,proto3" json:"storage_location_id,omitempty"` // The storage location that triggered the task
	Type              StorageEventType `protobuf:"varint,2,opt,name=type,proto3,enum=workflows.v1.StorageEventType" json:"type,omitempty"`                  // The type of the storage event, e.g. created
	// The object that triggered the task, e.g. a file name in a directory or object name in a bucket
	Location string `protobuf:"bytes,3,opt,name=location,proto3" json:"location,omitempty"`
	// contains filtered or unexported fields
}

TriggeredStorageEvent contains the details of the concrete event that triggered a storage event trigger.

func (*TriggeredStorageEvent) Descriptor deprecated 

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

Deprecated: Use TriggeredStorageEvent.ProtoReflect.Descriptor instead.

func (*TriggeredStorageEvent) GetLocation 

func (x *TriggeredStorageEvent) GetLocation() string

func (*TriggeredStorageEvent) GetStorageLocationId 

func (x *TriggeredStorageEvent) GetStorageLocationId() *UUID

func (*TriggeredStorageEvent) GetType 

func (x *TriggeredStorageEvent) GetType() StorageEventType

func (*TriggeredStorageEvent) ProtoMessage 

func (*TriggeredStorageEvent) ProtoMessage()

func (*TriggeredStorageEvent) ProtoReflect 

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

func (*TriggeredStorageEvent) Reset 

func (x *TriggeredStorageEvent) Reset()

func (*TriggeredStorageEvent) String 

func (x *TriggeredStorageEvent) String() string

type UUID 

type UUID struct {
	Uuid []byte `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// contains filtered or unexported fields
}

Bytes field (in message)

func (*UUID) Descriptor deprecated 

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

Deprecated: Use UUID.ProtoReflect.Descriptor instead.

func (*UUID) GetUuid 

func (x *UUID) GetUuid() []byte

func (*UUID) ProtoMessage 

func (*UUID) ProtoMessage()

func (*UUID) ProtoReflect 

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

func (*UUID) Reset 

func (x *UUID) Reset()

func (*UUID) String 

func (x *UUID) String() string

type UnimplementedDiagramServiceServer 

type UnimplementedDiagramServiceServer struct{}

UnimplementedDiagramServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedDiagramServiceServer) Render 

func (UnimplementedDiagramServiceServer) Render(context.Context, *RenderDiagramRequest) (*Diagram, error)

type UnimplementedJobServiceServer 

type UnimplementedJobServiceServer struct{}

UnimplementedJobServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedJobServiceServer) CancelJob 

func (UnimplementedJobServiceServer) CancelJob(context.Context, *CancelJobRequest) (*CancelJobResponse, error)

func (UnimplementedJobServiceServer) GetJob 

func (UnimplementedJobServiceServer) GetJob(context.Context, *GetJobRequest) (*Job, error)

func (UnimplementedJobServiceServer) ListJobs 

func (UnimplementedJobServiceServer) ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)

func (UnimplementedJobServiceServer) RetryJob 

func (UnimplementedJobServiceServer) RetryJob(context.Context, *RetryJobRequest) (*RetryJobResponse, error)

func (UnimplementedJobServiceServer) SubmitJob 

func (UnimplementedJobServiceServer) SubmitJob(context.Context, *SubmitJobRequest) (*Job, error)

func (UnimplementedJobServiceServer) VisualizeJob 

func (UnimplementedJobServiceServer) VisualizeJob(context.Context, *VisualizeJobRequest) (*Diagram, error)

type UnimplementedRecurrentTaskServiceServer 

type UnimplementedRecurrentTaskServiceServer struct{}

UnimplementedRecurrentTaskServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedRecurrentTaskServiceServer) CreateRecurrentTask 

func (UnimplementedRecurrentTaskServiceServer) CreateRecurrentTask(context.Context, *RecurrentTaskPrototype) (*RecurrentTaskPrototype, error)

func (UnimplementedRecurrentTaskServiceServer) CreateStorageLocation 

func (UnimplementedRecurrentTaskServiceServer) CreateStorageLocation(context.Context, *StorageLocation) (*StorageLocation, error)

func (UnimplementedRecurrentTaskServiceServer) DeleteRecurrentTask 

func (UnimplementedRecurrentTaskServiceServer) DeleteRecurrentTask(context.Context, *UUID) (*emptypb.Empty, error)

func (UnimplementedRecurrentTaskServiceServer) DeleteStorageLocation 

func (UnimplementedRecurrentTaskServiceServer) DeleteStorageLocation(context.Context, *UUID) (*emptypb.Empty, error)

func (UnimplementedRecurrentTaskServiceServer) GetRecurrentTask 

func (UnimplementedRecurrentTaskServiceServer) GetRecurrentTask(context.Context, *UUID) (*RecurrentTaskPrototype, error)

func (UnimplementedRecurrentTaskServiceServer) GetStorageLocation 

func (UnimplementedRecurrentTaskServiceServer) GetStorageLocation(context.Context, *UUID) (*StorageLocation, error)

func (UnimplementedRecurrentTaskServiceServer) ListRecurrentTasks 

func (UnimplementedRecurrentTaskServiceServer) ListRecurrentTasks(context.Context, *emptypb.Empty) (*RecurrentTasks, error)

func (UnimplementedRecurrentTaskServiceServer) ListStorageLocations 

func (UnimplementedRecurrentTaskServiceServer) ListStorageLocations(context.Context, *emptypb.Empty) (*StorageLocations, error)

func (UnimplementedRecurrentTaskServiceServer) UpdateRecurrentTask 

func (UnimplementedRecurrentTaskServiceServer) UpdateRecurrentTask(context.Context, *RecurrentTaskPrototype) (*RecurrentTaskPrototype, error)

type UnimplementedTaskServiceServer 

type UnimplementedTaskServiceServer struct{}

UnimplementedTaskServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedTaskServiceServer) ExtendTaskLease 

func (UnimplementedTaskServiceServer) ExtendTaskLease(context.Context, *TaskLeaseRequest) (*TaskLease, error)

func (UnimplementedTaskServiceServer) NextTask 

func (UnimplementedTaskServiceServer) NextTask(context.Context, *NextTaskRequest) (*NextTaskResponse, error)

func (UnimplementedTaskServiceServer) TaskFailed 

func (UnimplementedTaskServiceServer) TaskFailed(context.Context, *TaskFailedRequest) (*TaskStateResponse, error)

type UnimplementedWorkflowsServiceServer 

type UnimplementedWorkflowsServiceServer struct{}

UnimplementedWorkflowsServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedWorkflowsServiceServer) CreateCluster 

func (UnimplementedWorkflowsServiceServer) CreateCluster(context.Context, *CreateClusterRequest) (*Cluster, error)

func (UnimplementedWorkflowsServiceServer) DeleteCluster 

func (UnimplementedWorkflowsServiceServer) DeleteCluster(context.Context, *DeleteClusterRequest) (*DeleteClusterResponse, error)

func (UnimplementedWorkflowsServiceServer) GetCluster 

func (UnimplementedWorkflowsServiceServer) GetCluster(context.Context, *GetClusterRequest) (*Cluster, error)

func (UnimplementedWorkflowsServiceServer) ListClusters 

func (UnimplementedWorkflowsServiceServer) ListClusters(context.Context, *ListClustersRequest) (*ListClustersResponse, error)

type UnsafeDiagramServiceServer 

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

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

type UnsafeJobServiceServer 

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

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

type UnsafeRecurrentTaskServiceServer 

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

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

type UnsafeTaskServiceServer 

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

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

type UnsafeWorkflowsServiceServer 

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

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

type VisualizeJobRequest 

type VisualizeJobRequest struct {

	// The job to visualize.
	JobId *UUID `protobuf:"bytes,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// The options for rendering the diagram
	RenderOptions *RenderOptions `protobuf:"bytes,2,opt,name=render_options,json=renderOptions,proto3" json:"render_options,omitempty"`
	// contains filtered or unexported fields
}

VisualizeJobRequest requests a visualization of a job.

func (*VisualizeJobRequest) Descriptor deprecated 

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

Deprecated: Use VisualizeJobRequest.ProtoReflect.Descriptor instead.

func (*VisualizeJobRequest) GetJobId 

func (x *VisualizeJobRequest) GetJobId() *UUID

func (*VisualizeJobRequest) GetRenderOptions 

func (x *VisualizeJobRequest) GetRenderOptions() *RenderOptions

func (*VisualizeJobRequest) ProtoMessage 

func (*VisualizeJobRequest) ProtoMessage()

func (*VisualizeJobRequest) ProtoReflect 

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

func (*VisualizeJobRequest) Reset 

func (x *VisualizeJobRequest) Reset()

func (*VisualizeJobRequest) String 

func (x *VisualizeJobRequest) String() string

type WorkflowsServiceClient 

type WorkflowsServiceClient interface {
	CreateCluster(ctx context.Context, in *CreateClusterRequest, opts ...grpc.CallOption) (*Cluster, error)
	GetCluster(ctx context.Context, in *GetClusterRequest, opts ...grpc.CallOption) (*Cluster, error)
	DeleteCluster(ctx context.Context, in *DeleteClusterRequest, opts ...grpc.CallOption) (*DeleteClusterResponse, error)
	ListClusters(ctx context.Context, in *ListClustersRequest, opts ...grpc.CallOption) (*ListClustersResponse, error)
}

WorkflowsServiceClient is the client API for WorkflowsService 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.

A service for managing workflows.

func NewWorkflowsServiceClient 

func NewWorkflowsServiceClient(cc grpc.ClientConnInterface) WorkflowsServiceClient

type WorkflowsServiceServer 

type WorkflowsServiceServer interface {
	CreateCluster(context.Context, *CreateClusterRequest) (*Cluster, error)
	GetCluster(context.Context, *GetClusterRequest) (*Cluster, error)
	DeleteCluster(context.Context, *DeleteClusterRequest) (*DeleteClusterResponse, error)
	ListClusters(context.Context, *ListClustersRequest) (*ListClustersResponse, error)
	// contains filtered or unexported methods
}

WorkflowsServiceServer is the server API for WorkflowsService service. All implementations must embed UnimplementedWorkflowsServiceServer for forward compatibility.

A service for managing workflows.

Source Files

View all Source files

Directories

Path Synopsis

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.