Documentation ¶
Index ¶
- Variables
- func RegisterSchedulesServer(s grpc.ServiceRegistrar, srv SchedulesServer)
- type ClientMessage
- func (*ClientMessage) Descriptor() ([]byte, []int)deprecated
- func (m *ClientMessage) GetContent() isClientMessage_Content
- func (x *ClientMessage) GetId() string
- func (x *ClientMessage) GetIntervalResponse() *IntervalResponse
- func (x *ClientMessage) GetRegistrationRequest() *RegistrationRequest
- func (*ClientMessage) ProtoMessage()
- func (x *ClientMessage) ProtoReflect() protoreflect.Message
- func (x *ClientMessage) Reset()
- func (x *ClientMessage) String() string
- type ClientMessage_IntervalResponse
- type ClientMessage_RegistrationRequest
- type IntervalRequest
- type IntervalResponse
- type RegistrationRequest
- func (*RegistrationRequest) Descriptor() ([]byte, []int)deprecated
- func (m *RegistrationRequest) GetCadence() isRegistrationRequest_Cadence
- func (x *RegistrationRequest) GetCron() *ScheduleCron
- func (x *RegistrationRequest) GetEvery() *ScheduleEvery
- func (x *RegistrationRequest) GetScheduleName() string
- func (*RegistrationRequest) ProtoMessage()
- func (x *RegistrationRequest) ProtoReflect() protoreflect.Message
- func (x *RegistrationRequest) Reset()
- func (x *RegistrationRequest) String() string
- type RegistrationRequest_Cron
- type RegistrationRequest_Every
- type RegistrationResponse
- type ScheduleCron
- type ScheduleEvery
- type SchedulesClient
- type SchedulesServer
- type Schedules_ScheduleClient
- type Schedules_ScheduleServer
- type ServerMessage
- func (*ServerMessage) Descriptor() ([]byte, []int)deprecated
- func (m *ServerMessage) GetContent() isServerMessage_Content
- func (x *ServerMessage) GetId() string
- func (x *ServerMessage) GetIntervalRequest() *IntervalRequest
- func (x *ServerMessage) GetRegistrationResponse() *RegistrationResponse
- func (*ServerMessage) ProtoMessage()
- func (x *ServerMessage) ProtoReflect() protoreflect.Message
- func (x *ServerMessage) Reset()
- func (x *ServerMessage) String() string
- type ServerMessage_IntervalRequest
- type ServerMessage_RegistrationResponse
- type UnimplementedSchedulesServer
- type UnsafeSchedulesServer
Constants ¶
This section is empty.
Variables ¶
var File_nitric_proto_schedules_v1_schedules_proto protoreflect.FileDescriptor
var Schedules_ServiceDesc = grpc.ServiceDesc{ ServiceName: "nitric.proto.schedules.v1.Schedules", HandlerType: (*SchedulesServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "Schedule", Handler: _Schedules_Schedule_Handler, ServerStreams: true, ClientStreams: true, }, }, Metadata: "nitric/proto/schedules/v1/schedules.proto", }
Schedules_ServiceDesc is the grpc.ServiceDesc for Schedules service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSchedulesServer ¶
func RegisterSchedulesServer(s grpc.ServiceRegistrar, srv SchedulesServer)
Types ¶
type ClientMessage ¶
type ClientMessage struct { // globally unique ID of the request/response pair Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // Types that are assignable to Content: // // *ClientMessage_RegistrationRequest // *ClientMessage_IntervalResponse Content isClientMessage_Content `protobuf_oneof:"content"` // contains filtered or unexported fields }
ClientMessages are sent from the service to the nitric server
func (*ClientMessage) Descriptor
deprecated
func (*ClientMessage) Descriptor() ([]byte, []int)
Deprecated: Use ClientMessage.ProtoReflect.Descriptor instead.
func (*ClientMessage) GetContent ¶
func (m *ClientMessage) GetContent() isClientMessage_Content
func (*ClientMessage) GetId ¶
func (x *ClientMessage) GetId() string
func (*ClientMessage) GetIntervalResponse ¶
func (x *ClientMessage) GetIntervalResponse() *IntervalResponse
func (*ClientMessage) GetRegistrationRequest ¶
func (x *ClientMessage) GetRegistrationRequest() *RegistrationRequest
func (*ClientMessage) ProtoMessage ¶
func (*ClientMessage) ProtoMessage()
func (*ClientMessage) ProtoReflect ¶
func (x *ClientMessage) ProtoReflect() protoreflect.Message
func (*ClientMessage) Reset ¶
func (x *ClientMessage) Reset()
func (*ClientMessage) String ¶
func (x *ClientMessage) String() string
type ClientMessage_IntervalResponse ¶
type ClientMessage_IntervalResponse struct { // Response to a schedule interval (i.e. response from callback function) IntervalResponse *IntervalResponse `protobuf:"bytes,3,opt,name=interval_response,json=intervalResponse,proto3,oneof"` }
type ClientMessage_RegistrationRequest ¶
type ClientMessage_RegistrationRequest struct { // Register new a schedule RegistrationRequest *RegistrationRequest `protobuf:"bytes,2,opt,name=registration_request,json=registrationRequest,proto3,oneof"` }
type IntervalRequest ¶
type IntervalRequest struct { ScheduleName string `protobuf:"bytes,1,opt,name=schedule_name,json=scheduleName,proto3" json:"schedule_name,omitempty"` // contains filtered or unexported fields }
func (*IntervalRequest) Descriptor
deprecated
func (*IntervalRequest) Descriptor() ([]byte, []int)
Deprecated: Use IntervalRequest.ProtoReflect.Descriptor instead.
func (*IntervalRequest) GetScheduleName ¶
func (x *IntervalRequest) GetScheduleName() string
func (*IntervalRequest) ProtoMessage ¶
func (*IntervalRequest) ProtoMessage()
func (*IntervalRequest) ProtoReflect ¶
func (x *IntervalRequest) ProtoReflect() protoreflect.Message
func (*IntervalRequest) Reset ¶
func (x *IntervalRequest) Reset()
func (*IntervalRequest) String ¶
func (x *IntervalRequest) String() string
type IntervalResponse ¶
type IntervalResponse struct {
// contains filtered or unexported fields
}
func (*IntervalResponse) Descriptor
deprecated
func (*IntervalResponse) Descriptor() ([]byte, []int)
Deprecated: Use IntervalResponse.ProtoReflect.Descriptor instead.
func (*IntervalResponse) ProtoMessage ¶
func (*IntervalResponse) ProtoMessage()
func (*IntervalResponse) ProtoReflect ¶
func (x *IntervalResponse) ProtoReflect() protoreflect.Message
func (*IntervalResponse) Reset ¶
func (x *IntervalResponse) Reset()
func (*IntervalResponse) String ¶
func (x *IntervalResponse) String() string
type RegistrationRequest ¶
type RegistrationRequest struct { ScheduleName string `protobuf:"bytes,1,opt,name=schedule_name,json=scheduleName,proto3" json:"schedule_name,omitempty"` // Types that are assignable to Cadence: // // *RegistrationRequest_Every // *RegistrationRequest_Cron Cadence isRegistrationRequest_Cadence `protobuf_oneof:"cadence"` // contains filtered or unexported fields }
func (*RegistrationRequest) Descriptor
deprecated
func (*RegistrationRequest) Descriptor() ([]byte, []int)
Deprecated: Use RegistrationRequest.ProtoReflect.Descriptor instead.
func (*RegistrationRequest) GetCadence ¶
func (m *RegistrationRequest) GetCadence() isRegistrationRequest_Cadence
func (*RegistrationRequest) GetCron ¶
func (x *RegistrationRequest) GetCron() *ScheduleCron
func (*RegistrationRequest) GetEvery ¶
func (x *RegistrationRequest) GetEvery() *ScheduleEvery
func (*RegistrationRequest) GetScheduleName ¶
func (x *RegistrationRequest) GetScheduleName() string
func (*RegistrationRequest) ProtoMessage ¶
func (*RegistrationRequest) ProtoMessage()
func (*RegistrationRequest) ProtoReflect ¶
func (x *RegistrationRequest) ProtoReflect() protoreflect.Message
func (*RegistrationRequest) Reset ¶
func (x *RegistrationRequest) Reset()
func (*RegistrationRequest) String ¶
func (x *RegistrationRequest) String() string
type RegistrationRequest_Cron ¶
type RegistrationRequest_Cron struct {
Cron *ScheduleCron `protobuf:"bytes,11,opt,name=cron,proto3,oneof"`
}
type RegistrationRequest_Every ¶
type RegistrationRequest_Every struct {
Every *ScheduleEvery `protobuf:"bytes,10,opt,name=every,proto3,oneof"`
}
type RegistrationResponse ¶
type RegistrationResponse struct {
// contains filtered or unexported fields
}
func (*RegistrationResponse) Descriptor
deprecated
func (*RegistrationResponse) Descriptor() ([]byte, []int)
Deprecated: Use RegistrationResponse.ProtoReflect.Descriptor instead.
func (*RegistrationResponse) ProtoMessage ¶
func (*RegistrationResponse) ProtoMessage()
func (*RegistrationResponse) ProtoReflect ¶
func (x *RegistrationResponse) ProtoReflect() protoreflect.Message
func (*RegistrationResponse) Reset ¶
func (x *RegistrationResponse) Reset()
func (*RegistrationResponse) String ¶
func (x *RegistrationResponse) String() string
type ScheduleCron ¶
type ScheduleCron struct { Expression string `protobuf:"bytes,1,opt,name=expression,proto3" json:"expression,omitempty"` // contains filtered or unexported fields }
func (*ScheduleCron) Descriptor
deprecated
func (*ScheduleCron) Descriptor() ([]byte, []int)
Deprecated: Use ScheduleCron.ProtoReflect.Descriptor instead.
func (*ScheduleCron) GetExpression ¶
func (x *ScheduleCron) GetExpression() string
func (*ScheduleCron) ProtoMessage ¶
func (*ScheduleCron) ProtoMessage()
func (*ScheduleCron) ProtoReflect ¶
func (x *ScheduleCron) ProtoReflect() protoreflect.Message
func (*ScheduleCron) Reset ¶
func (x *ScheduleCron) Reset()
func (*ScheduleCron) String ¶
func (x *ScheduleCron) String() string
type ScheduleEvery ¶
type ScheduleEvery struct { Rate string `protobuf:"bytes,1,opt,name=rate,proto3" json:"rate,omitempty"` // contains filtered or unexported fields }
func (*ScheduleEvery) Descriptor
deprecated
func (*ScheduleEvery) Descriptor() ([]byte, []int)
Deprecated: Use ScheduleEvery.ProtoReflect.Descriptor instead.
func (*ScheduleEvery) GetRate ¶
func (x *ScheduleEvery) GetRate() string
func (*ScheduleEvery) ProtoMessage ¶
func (*ScheduleEvery) ProtoMessage()
func (*ScheduleEvery) ProtoReflect ¶
func (x *ScheduleEvery) ProtoReflect() protoreflect.Message
func (*ScheduleEvery) Reset ¶
func (x *ScheduleEvery) Reset()
func (*ScheduleEvery) String ¶
func (x *ScheduleEvery) String() string
type SchedulesClient ¶
type SchedulesClient interface {
Schedule(ctx context.Context, opts ...grpc.CallOption) (Schedules_ScheduleClient, error)
}
SchedulesClient is the client API for Schedules 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 NewSchedulesClient ¶
func NewSchedulesClient(cc grpc.ClientConnInterface) SchedulesClient
type SchedulesServer ¶
type SchedulesServer interface {
Schedule(Schedules_ScheduleServer) error
}
SchedulesServer is the server API for Schedules service. All implementations should embed UnimplementedSchedulesServer for forward compatibility
type Schedules_ScheduleClient ¶
type Schedules_ScheduleClient interface { Send(*ClientMessage) error Recv() (*ServerMessage, error) grpc.ClientStream }
type Schedules_ScheduleServer ¶
type Schedules_ScheduleServer interface { Send(*ServerMessage) error Recv() (*ClientMessage, error) grpc.ServerStream }
type ServerMessage ¶
type ServerMessage struct { // globally unique ID of the request/response pair Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // Types that are assignable to Content: // // *ServerMessage_RegistrationResponse // *ServerMessage_IntervalRequest Content isServerMessage_Content `protobuf_oneof:"content"` // contains filtered or unexported fields }
ServerMessages are sent from the nitric server to the service
func (*ServerMessage) Descriptor
deprecated
func (*ServerMessage) Descriptor() ([]byte, []int)
Deprecated: Use ServerMessage.ProtoReflect.Descriptor instead.
func (*ServerMessage) GetContent ¶
func (m *ServerMessage) GetContent() isServerMessage_Content
func (*ServerMessage) GetId ¶
func (x *ServerMessage) GetId() string
func (*ServerMessage) GetIntervalRequest ¶
func (x *ServerMessage) GetIntervalRequest() *IntervalRequest
func (*ServerMessage) GetRegistrationResponse ¶
func (x *ServerMessage) GetRegistrationResponse() *RegistrationResponse
func (*ServerMessage) ProtoMessage ¶
func (*ServerMessage) ProtoMessage()
func (*ServerMessage) ProtoReflect ¶
func (x *ServerMessage) ProtoReflect() protoreflect.Message
func (*ServerMessage) Reset ¶
func (x *ServerMessage) Reset()
func (*ServerMessage) String ¶
func (x *ServerMessage) String() string
type ServerMessage_IntervalRequest ¶
type ServerMessage_IntervalRequest struct { // A schedule interval trigger request (i.e. call the callback) IntervalRequest *IntervalRequest `protobuf:"bytes,3,opt,name=interval_request,json=intervalRequest,proto3,oneof"` }
type ServerMessage_RegistrationResponse ¶
type ServerMessage_RegistrationResponse struct { // Response to a schedule subscription request RegistrationResponse *RegistrationResponse `protobuf:"bytes,2,opt,name=registration_response,json=registrationResponse,proto3,oneof"` }
type UnimplementedSchedulesServer ¶
type UnimplementedSchedulesServer struct { }
UnimplementedSchedulesServer should be embedded to have forward compatible implementations.
func (UnimplementedSchedulesServer) Schedule ¶
func (UnimplementedSchedulesServer) Schedule(Schedules_ScheduleServer) error
type UnsafeSchedulesServer ¶
type UnsafeSchedulesServer interface {
// contains filtered or unexported methods
}
UnsafeSchedulesServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SchedulesServer will result in compilation errors.