scheduler

package
v1.14.0-rc.3 Latest Latest
Warning

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

Go to latest
Published: Jul 17, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Scheduler_ScheduleJob_FullMethodName = "/dapr.proto.scheduler.v1.Scheduler/ScheduleJob"
	Scheduler_GetJob_FullMethodName      = "/dapr.proto.scheduler.v1.Scheduler/GetJob"
	Scheduler_DeleteJob_FullMethodName   = "/dapr.proto.scheduler.v1.Scheduler/DeleteJob"
	Scheduler_WatchJobs_FullMethodName   = "/dapr.proto.scheduler.v1.Scheduler/WatchJobs"
)

Variables

View Source
var File_dapr_proto_scheduler_v1_scheduler_proto protoreflect.FileDescriptor
View Source
var Scheduler_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "dapr.proto.scheduler.v1.Scheduler",
	HandlerType: (*SchedulerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ScheduleJob",
			Handler:    _Scheduler_ScheduleJob_Handler,
		},
		{
			MethodName: "GetJob",
			Handler:    _Scheduler_GetJob_Handler,
		},
		{
			MethodName: "DeleteJob",
			Handler:    _Scheduler_DeleteJob_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "WatchJobs",
			Handler:       _Scheduler_WatchJobs_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "dapr/proto/scheduler/v1/scheduler.proto",
}

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

Functions

func RegisterSchedulerServer

func RegisterSchedulerServer(s grpc.ServiceRegistrar, srv SchedulerServer)

Types

type DeleteJobRequest

type DeleteJobRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The metadata associated with the job.
	Metadata *JobMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

DeleteJobRequest is the message used by the daprd sidecar to delete or get a job.

func (*DeleteJobRequest) Descriptor deprecated

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

Deprecated: Use DeleteJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteJobRequest) GetMetadata

func (x *DeleteJobRequest) GetMetadata() *JobMetadata

func (*DeleteJobRequest) GetName

func (x *DeleteJobRequest) GetName() string

func (*DeleteJobRequest) ProtoMessage

func (*DeleteJobRequest) ProtoMessage()

func (*DeleteJobRequest) ProtoReflect

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

func (*DeleteJobRequest) Reset

func (x *DeleteJobRequest) Reset()

func (*DeleteJobRequest) String

func (x *DeleteJobRequest) String() string

type DeleteJobResponse

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

DeleteJobRequest is the response message used by the daprd sidecar to delete or get a job.

func (*DeleteJobResponse) Descriptor deprecated

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

Deprecated: Use DeleteJobResponse.ProtoReflect.Descriptor instead.

func (*DeleteJobResponse) ProtoMessage

func (*DeleteJobResponse) ProtoMessage()

func (*DeleteJobResponse) ProtoReflect

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

func (*DeleteJobResponse) Reset

func (x *DeleteJobResponse) Reset()

func (*DeleteJobResponse) String

func (x *DeleteJobResponse) String() string

type GetJobRequest

type GetJobRequest struct {

	// name is the name of the job.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The metadata associated with the job.
	Metadata *JobMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

GetJobRequest is the message used by the daprd sidecar to delete or get a job.

func (*GetJobRequest) Descriptor deprecated

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

Deprecated: Use GetJobRequest.ProtoReflect.Descriptor instead.

func (*GetJobRequest) GetMetadata

func (x *GetJobRequest) GetMetadata() *JobMetadata

func (*GetJobRequest) GetName

func (x *GetJobRequest) GetName() string

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 GetJobResponse

type GetJobResponse struct {

	// The job to be scheduled.
	Job *Job `protobuf:"bytes,1,opt,name=job,proto3" json:"job,omitempty"`
	// contains filtered or unexported fields
}

GetJobResponse is the response message to convey the details of a job.

func (*GetJobResponse) Descriptor deprecated

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

Deprecated: Use GetJobResponse.ProtoReflect.Descriptor instead.

func (*GetJobResponse) GetJob

func (x *GetJobResponse) GetJob() *Job

func (*GetJobResponse) ProtoMessage

func (*GetJobResponse) ProtoMessage()

func (*GetJobResponse) ProtoReflect

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

func (*GetJobResponse) Reset

func (x *GetJobResponse) Reset()

func (*GetJobResponse) String

func (x *GetJobResponse) String() string

type Job

type Job struct {

	// The schedule for the job.
	Schedule *string `protobuf:"bytes,1,opt,name=schedule,proto3,oneof" json:"schedule,omitempty"`
	// Optional: jobs with fixed repeat counts (accounting for Actor Reminders).
	Repeats *uint32 `protobuf:"varint,2,opt,name=repeats,proto3,oneof" json:"repeats,omitempty"`
	// Optional: sets time at which or time interval before the callback is invoked for the first time.
	DueTime *string `protobuf:"bytes,3,opt,name=due_time,json=dueTime,proto3,oneof" json:"due_time,omitempty"`
	// Optional: Time To Live to allow for auto deletes (accounting for Actor Reminders).
	Ttl *string `protobuf:"bytes,4,opt,name=ttl,proto3,oneof" json:"ttl,omitempty"`
	// Job data.
	Data *anypb.Any `protobuf:"bytes,5,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*Job) Descriptor deprecated

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

Deprecated: Use Job.ProtoReflect.Descriptor instead.

func (*Job) GetData

func (x *Job) GetData() *anypb.Any

func (*Job) GetDueTime

func (x *Job) GetDueTime() string

func (*Job) GetRepeats

func (x *Job) GetRepeats() uint32

func (*Job) GetSchedule

func (x *Job) GetSchedule() string

func (*Job) GetTtl

func (x *Job) GetTtl() 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 JobMetadata

type JobMetadata struct {

	// app_id is the App ID of the requester.
	AppId string `protobuf:"bytes,1,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	// namespace is the namespace of the requester.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// target is the type of the job.
	Target *JobTargetMetadata `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// contains filtered or unexported fields
}

JobMetadata is the message used by the daprd sidecar to schedule/get/delete a job.

func (*JobMetadata) Descriptor deprecated

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

Deprecated: Use JobMetadata.ProtoReflect.Descriptor instead.

func (*JobMetadata) GetAppId

func (x *JobMetadata) GetAppId() string

func (*JobMetadata) GetNamespace

func (x *JobMetadata) GetNamespace() string

func (*JobMetadata) GetTarget

func (x *JobMetadata) GetTarget() *JobTargetMetadata

func (*JobMetadata) ProtoMessage

func (*JobMetadata) ProtoMessage()

func (*JobMetadata) ProtoReflect

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

func (*JobMetadata) Reset

func (x *JobMetadata) Reset()

func (*JobMetadata) String

func (x *JobMetadata) String() string

type JobTargetMetadata

type JobTargetMetadata struct {

	// Types that are assignable to Type:
	//
	//	*JobTargetMetadata_Job
	//	*JobTargetMetadata_Actor
	Type isJobTargetMetadata_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

JobTargetMetadata holds the typed metadata associated with the job for different origins.

func (*JobTargetMetadata) Descriptor deprecated

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

Deprecated: Use JobTargetMetadata.ProtoReflect.Descriptor instead.

func (*JobTargetMetadata) GetActor

func (x *JobTargetMetadata) GetActor() *TargetActorReminder

func (*JobTargetMetadata) GetJob

func (x *JobTargetMetadata) GetJob() *TargetJob

func (*JobTargetMetadata) GetType

func (m *JobTargetMetadata) GetType() isJobTargetMetadata_Type

func (*JobTargetMetadata) ProtoMessage

func (*JobTargetMetadata) ProtoMessage()

func (*JobTargetMetadata) ProtoReflect

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

func (*JobTargetMetadata) Reset

func (x *JobTargetMetadata) Reset()

func (*JobTargetMetadata) String

func (x *JobTargetMetadata) String() string

type JobTargetMetadata_Actor

type JobTargetMetadata_Actor struct {
	Actor *TargetActorReminder `protobuf:"bytes,2,opt,name=actor,proto3,oneof"`
}

type JobTargetMetadata_Job

type JobTargetMetadata_Job struct {
	Job *TargetJob `protobuf:"bytes,1,opt,name=job,proto3,oneof"`
}

type ScheduleJobRequest

type ScheduleJobRequest struct {

	// name is the name of the job to create.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The job to be scheduled.
	Job *Job `protobuf:"bytes,2,opt,name=job,proto3" json:"job,omitempty"`
	// The metadata associated with the job.
	Metadata *JobMetadata `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*ScheduleJobRequest) Descriptor deprecated

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

Deprecated: Use ScheduleJobRequest.ProtoReflect.Descriptor instead.

func (*ScheduleJobRequest) GetJob

func (x *ScheduleJobRequest) GetJob() *Job

func (*ScheduleJobRequest) GetMetadata

func (x *ScheduleJobRequest) GetMetadata() *JobMetadata

func (*ScheduleJobRequest) GetName

func (x *ScheduleJobRequest) GetName() string

func (*ScheduleJobRequest) ProtoMessage

func (*ScheduleJobRequest) ProtoMessage()

func (*ScheduleJobRequest) ProtoReflect

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

func (*ScheduleJobRequest) Reset

func (x *ScheduleJobRequest) Reset()

func (*ScheduleJobRequest) String

func (x *ScheduleJobRequest) String() string

type ScheduleJobResponse

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

func (*ScheduleJobResponse) Descriptor deprecated

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

Deprecated: Use ScheduleJobResponse.ProtoReflect.Descriptor instead.

func (*ScheduleJobResponse) ProtoMessage

func (*ScheduleJobResponse) ProtoMessage()

func (*ScheduleJobResponse) ProtoReflect

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

func (*ScheduleJobResponse) Reset

func (x *ScheduleJobResponse) Reset()

func (*ScheduleJobResponse) String

func (x *ScheduleJobResponse) String() string

type SchedulerClient

type SchedulerClient interface {
	// ScheduleJob is used by the daprd sidecar to schedule a job.
	ScheduleJob(ctx context.Context, in *ScheduleJobRequest, opts ...grpc.CallOption) (*ScheduleJobResponse, error)
	// Get a job
	GetJob(ctx context.Context, in *GetJobRequest, opts ...grpc.CallOption) (*GetJobResponse, error)
	// DeleteJob is used by the daprd sidecar to delete a job.
	DeleteJob(ctx context.Context, in *DeleteJobRequest, opts ...grpc.CallOption) (*DeleteJobResponse, error)
	// WatchJobs is used by the daprd sidecar to connect to the Scheduler
	// service to watch for jobs triggering back.
	WatchJobs(ctx context.Context, opts ...grpc.CallOption) (Scheduler_WatchJobsClient, error)
}

SchedulerClient is the client API for Scheduler 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.

func NewSchedulerClient

func NewSchedulerClient(cc grpc.ClientConnInterface) SchedulerClient

type SchedulerServer

type SchedulerServer interface {
	// ScheduleJob is used by the daprd sidecar to schedule a job.
	ScheduleJob(context.Context, *ScheduleJobRequest) (*ScheduleJobResponse, error)
	// Get a job
	GetJob(context.Context, *GetJobRequest) (*GetJobResponse, error)
	// DeleteJob is used by the daprd sidecar to delete a job.
	DeleteJob(context.Context, *DeleteJobRequest) (*DeleteJobResponse, error)
	// WatchJobs is used by the daprd sidecar to connect to the Scheduler
	// service to watch for jobs triggering back.
	WatchJobs(Scheduler_WatchJobsServer) error
}

SchedulerServer is the server API for Scheduler service. All implementations should embed UnimplementedSchedulerServer for forward compatibility

type Scheduler_WatchJobsClient

type Scheduler_WatchJobsClient interface {
	Send(*WatchJobsRequest) error
	Recv() (*WatchJobsResponse, error)
	grpc.ClientStream
}

type Scheduler_WatchJobsServer

type Scheduler_WatchJobsServer interface {
	Send(*WatchJobsResponse) error
	Recv() (*WatchJobsRequest, error)
	grpc.ServerStream
}

type TargetActorReminder

type TargetActorReminder struct {

	// id is the actor ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// type is the actor type.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

TargetActorReminder is the message used by the daprd sidecar to schedule a job from an Actor Reminder.

func (*TargetActorReminder) Descriptor deprecated

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

Deprecated: Use TargetActorReminder.ProtoReflect.Descriptor instead.

func (*TargetActorReminder) GetId

func (x *TargetActorReminder) GetId() string

func (*TargetActorReminder) GetType

func (x *TargetActorReminder) GetType() string

func (*TargetActorReminder) ProtoMessage

func (*TargetActorReminder) ProtoMessage()

func (*TargetActorReminder) ProtoReflect

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

func (*TargetActorReminder) Reset

func (x *TargetActorReminder) Reset()

func (*TargetActorReminder) String

func (x *TargetActorReminder) String() string

type TargetJob

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

TargetJob is the message used by the daprd sidecar to schedule a job from an App.

func (*TargetJob) Descriptor deprecated

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

Deprecated: Use TargetJob.ProtoReflect.Descriptor instead.

func (*TargetJob) ProtoMessage

func (*TargetJob) ProtoMessage()

func (*TargetJob) ProtoReflect

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

func (*TargetJob) Reset

func (x *TargetJob) Reset()

func (*TargetJob) String

func (x *TargetJob) String() string

type UnimplementedSchedulerServer

type UnimplementedSchedulerServer struct {
}

UnimplementedSchedulerServer should be embedded to have forward compatible implementations.

func (UnimplementedSchedulerServer) DeleteJob

func (UnimplementedSchedulerServer) GetJob

func (UnimplementedSchedulerServer) ScheduleJob

func (UnimplementedSchedulerServer) WatchJobs

type UnsafeSchedulerServer

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

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

type WatchJobsRequest

type WatchJobsRequest struct {

	// Types that are assignable to WatchJobRequestType:
	//
	//	*WatchJobsRequest_Initial
	//	*WatchJobsRequest_Result
	WatchJobRequestType isWatchJobsRequest_WatchJobRequestType `protobuf_oneof:"watch_job_request_type"`
	// contains filtered or unexported fields
}

WatchJobsRequest is the message used by the daprd sidecar to connect to the Scheduler and send Job process results.

func (*WatchJobsRequest) Descriptor deprecated

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

Deprecated: Use WatchJobsRequest.ProtoReflect.Descriptor instead.

func (*WatchJobsRequest) GetInitial

func (x *WatchJobsRequest) GetInitial() *WatchJobsRequestInitial

func (*WatchJobsRequest) GetResult

func (x *WatchJobsRequest) GetResult() *WatchJobsRequestResult

func (*WatchJobsRequest) GetWatchJobRequestType

func (m *WatchJobsRequest) GetWatchJobRequestType() isWatchJobsRequest_WatchJobRequestType

func (*WatchJobsRequest) ProtoMessage

func (*WatchJobsRequest) ProtoMessage()

func (*WatchJobsRequest) ProtoReflect

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

func (*WatchJobsRequest) Reset

func (x *WatchJobsRequest) Reset()

func (*WatchJobsRequest) String

func (x *WatchJobsRequest) String() string

type WatchJobsRequestInitial

type WatchJobsRequestInitial struct {

	// app_id is the App ID of the requester.
	AppId string `protobuf:"bytes,1,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	// namespace is the namespace of the requester.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// actor_types is the optional list of actor types to watch for.
	ActorTypes []string `protobuf:"bytes,3,rep,name=actor_types,json=actorTypes,proto3" json:"actor_types,omitempty"`
	// contains filtered or unexported fields
}

WatchJobsRequestInitial is the initial request to start watching for jobs.

func (*WatchJobsRequestInitial) Descriptor deprecated

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

Deprecated: Use WatchJobsRequestInitial.ProtoReflect.Descriptor instead.

func (*WatchJobsRequestInitial) GetActorTypes

func (x *WatchJobsRequestInitial) GetActorTypes() []string

func (*WatchJobsRequestInitial) GetAppId

func (x *WatchJobsRequestInitial) GetAppId() string

func (*WatchJobsRequestInitial) GetNamespace

func (x *WatchJobsRequestInitial) GetNamespace() string

func (*WatchJobsRequestInitial) ProtoMessage

func (*WatchJobsRequestInitial) ProtoMessage()

func (*WatchJobsRequestInitial) ProtoReflect

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

func (*WatchJobsRequestInitial) Reset

func (x *WatchJobsRequestInitial) Reset()

func (*WatchJobsRequestInitial) String

func (x *WatchJobsRequestInitial) String() string

type WatchJobsRequestResult

type WatchJobsRequestResult struct {

	// id is the id of the job that has finished processing, used as an incremental counter.
	Id uint64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

WatchJobsRequestResult is the result of a job execution to allow the job to be marked as processed.

func (*WatchJobsRequestResult) Descriptor deprecated

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

Deprecated: Use WatchJobsRequestResult.ProtoReflect.Descriptor instead.

func (*WatchJobsRequestResult) GetId

func (x *WatchJobsRequestResult) GetId() uint64

func (*WatchJobsRequestResult) ProtoMessage

func (*WatchJobsRequestResult) ProtoMessage()

func (*WatchJobsRequestResult) ProtoReflect

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

func (*WatchJobsRequestResult) Reset

func (x *WatchJobsRequestResult) Reset()

func (*WatchJobsRequestResult) String

func (x *WatchJobsRequestResult) String() string

type WatchJobsRequest_Initial

type WatchJobsRequest_Initial struct {
	Initial *WatchJobsRequestInitial `protobuf:"bytes,1,opt,name=initial,proto3,oneof"`
}

type WatchJobsRequest_Result

type WatchJobsRequest_Result struct {
	Result *WatchJobsRequestResult `protobuf:"bytes,2,opt,name=result,proto3,oneof"`
}

type WatchJobsResponse

type WatchJobsResponse struct {

	// name is the name of the job which was triggered.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// id is the id of the job trigger event which should be sent back from
	// the client to be marked as processed, used as an incremental counter.
	Id uint64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// Job data.
	Data *anypb.Any `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// The metadata associated with the job.
	Metadata *JobMetadata `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

WatchJobsResponse is the response message to convey the details of a job.

func (*WatchJobsResponse) Descriptor deprecated

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

Deprecated: Use WatchJobsResponse.ProtoReflect.Descriptor instead.

func (*WatchJobsResponse) GetData

func (x *WatchJobsResponse) GetData() *anypb.Any

func (*WatchJobsResponse) GetId

func (x *WatchJobsResponse) GetId() uint64

func (*WatchJobsResponse) GetMetadata

func (x *WatchJobsResponse) GetMetadata() *JobMetadata

func (*WatchJobsResponse) GetName

func (x *WatchJobsResponse) GetName() string

func (*WatchJobsResponse) ProtoMessage

func (*WatchJobsResponse) ProtoMessage()

func (*WatchJobsResponse) ProtoReflect

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

func (*WatchJobsResponse) Reset

func (x *WatchJobsResponse) Reset()

func (*WatchJobsResponse) String

func (x *WatchJobsResponse) String() string

Jump to

Keyboard shortcuts

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