Documentation ¶
Index ¶
- Variables
- func NotifierPluginServer(server NotifierServer) pluginsdk.PluginServer
- func RegisterNotifierServer(s grpc.ServiceRegistrar, srv NotifierServer)
- type BundleLoaded
- type BundleUpdated
- type NotifierClient
- type NotifierPluginClient
- type NotifierServer
- type NotifyAndAdviseRequest
- func (*NotifyAndAdviseRequest) Descriptor() ([]byte, []int)deprecated
- func (x *NotifyAndAdviseRequest) GetBundleLoaded() *BundleLoaded
- func (m *NotifyAndAdviseRequest) GetEvent() isNotifyAndAdviseRequest_Event
- func (*NotifyAndAdviseRequest) ProtoMessage()
- func (x *NotifyAndAdviseRequest) ProtoReflect() protoreflect.Message
- func (x *NotifyAndAdviseRequest) Reset()
- func (x *NotifyAndAdviseRequest) String() string
- type NotifyAndAdviseRequest_BundleLoaded
- type NotifyAndAdviseResponse
- type NotifyRequest
- func (*NotifyRequest) Descriptor() ([]byte, []int)deprecated
- func (x *NotifyRequest) GetBundleUpdated() *BundleUpdated
- func (m *NotifyRequest) GetEvent() isNotifyRequest_Event
- func (*NotifyRequest) ProtoMessage()
- func (x *NotifyRequest) ProtoReflect() protoreflect.Message
- func (x *NotifyRequest) Reset()
- func (x *NotifyRequest) String() string
- type NotifyRequest_BundleUpdated
- type NotifyResponse
- type UnimplementedNotifierServer
- func (UnimplementedNotifierServer) Configure(context.Context, *plugin.ConfigureRequest) (*plugin.ConfigureResponse, error)
- func (UnimplementedNotifierServer) GetPluginInfo(context.Context, *plugin.GetPluginInfoRequest) (*plugin.GetPluginInfoResponse, error)
- func (UnimplementedNotifierServer) Notify(context.Context, *NotifyRequest) (*NotifyResponse, error)
- func (UnimplementedNotifierServer) NotifyAndAdvise(context.Context, *NotifyAndAdviseRequest) (*NotifyAndAdviseResponse, error)
- type UnsafeNotifierServer
Constants ¶
This section is empty.
Variables ¶
var File_spire_plugin_server_notifier_v0_notifier_proto protoreflect.FileDescriptor
var Notifier_ServiceDesc = grpc.ServiceDesc{ ServiceName: "spire.server.notifier.Notifier", HandlerType: (*NotifierServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Notify", Handler: _Notifier_Notify_Handler, }, { MethodName: "NotifyAndAdvise", Handler: _Notifier_NotifyAndAdvise_Handler, }, { MethodName: "Configure", Handler: _Notifier_Configure_Handler, }, { MethodName: "GetPluginInfo", Handler: _Notifier_GetPluginInfo_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "spire/plugin/server/notifier/v0/notifier.proto", }
Notifier_ServiceDesc is the grpc.ServiceDesc for Notifier service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func NotifierPluginServer ¶
func NotifierPluginServer(server NotifierServer) pluginsdk.PluginServer
func RegisterNotifierServer ¶
func RegisterNotifierServer(s grpc.ServiceRegistrar, srv NotifierServer)
Types ¶
type BundleLoaded ¶
type BundleLoaded struct { Bundle *common.Bundle `protobuf:"bytes,1,opt,name=bundle,proto3" json:"bundle,omitempty"` // contains filtered or unexported fields }
func (*BundleLoaded) Descriptor
deprecated
func (*BundleLoaded) Descriptor() ([]byte, []int)
Deprecated: Use BundleLoaded.ProtoReflect.Descriptor instead.
func (*BundleLoaded) GetBundle ¶
func (x *BundleLoaded) GetBundle() *common.Bundle
func (*BundleLoaded) ProtoMessage ¶
func (*BundleLoaded) ProtoMessage()
func (*BundleLoaded) ProtoReflect ¶
func (x *BundleLoaded) ProtoReflect() protoreflect.Message
func (*BundleLoaded) Reset ¶
func (x *BundleLoaded) Reset()
func (*BundleLoaded) String ¶
func (x *BundleLoaded) String() string
type BundleUpdated ¶
type BundleUpdated struct { Bundle *common.Bundle `protobuf:"bytes,1,opt,name=bundle,proto3" json:"bundle,omitempty"` // contains filtered or unexported fields }
func (*BundleUpdated) Descriptor
deprecated
func (*BundleUpdated) Descriptor() ([]byte, []int)
Deprecated: Use BundleUpdated.ProtoReflect.Descriptor instead.
func (*BundleUpdated) GetBundle ¶
func (x *BundleUpdated) GetBundle() *common.Bundle
func (*BundleUpdated) ProtoMessage ¶
func (*BundleUpdated) ProtoMessage()
func (*BundleUpdated) ProtoReflect ¶
func (x *BundleUpdated) ProtoReflect() protoreflect.Message
func (*BundleUpdated) Reset ¶
func (x *BundleUpdated) Reset()
func (*BundleUpdated) String ¶
func (x *BundleUpdated) String() string
type NotifierClient ¶
type NotifierClient interface { // Notify notifies the plugin that an event occurred. Errors returned by // the plugin are logged but otherwise ignored. Notify(ctx context.Context, in *NotifyRequest, opts ...grpc.CallOption) (*NotifyResponse, error) // NotifyAndAdvise notifies the plugin that an event occurred and waits // for a response. Errors returned by the plugin control SPIRE server // behavior. See NotifyAndAdviseRequest for per-event details. NotifyAndAdvise(ctx context.Context, in *NotifyAndAdviseRequest, opts ...grpc.CallOption) (*NotifyAndAdviseResponse, error) Configure(ctx context.Context, in *plugin.ConfigureRequest, opts ...grpc.CallOption) (*plugin.ConfigureResponse, error) GetPluginInfo(ctx context.Context, in *plugin.GetPluginInfoRequest, opts ...grpc.CallOption) (*plugin.GetPluginInfoResponse, error) }
NotifierClient is the client API for Notifier 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 NewNotifierClient ¶
func NewNotifierClient(cc grpc.ClientConnInterface) NotifierClient
type NotifierPluginClient ¶
type NotifierPluginClient struct {
NotifierClient
}
func (*NotifierPluginClient) GRPCServiceName ¶
func (c *NotifierPluginClient) GRPCServiceName() string
func (*NotifierPluginClient) InitClient ¶
func (c *NotifierPluginClient) InitClient(conn grpc.ClientConnInterface) interface{}
func (*NotifierPluginClient) IsInitialized ¶
func (c *NotifierPluginClient) IsInitialized() bool
func (NotifierPluginClient) Type ¶
func (s NotifierPluginClient) Type() string
type NotifierServer ¶
type NotifierServer interface { // Notify notifies the plugin that an event occurred. Errors returned by // the plugin are logged but otherwise ignored. Notify(context.Context, *NotifyRequest) (*NotifyResponse, error) // NotifyAndAdvise notifies the plugin that an event occurred and waits // for a response. Errors returned by the plugin control SPIRE server // behavior. See NotifyAndAdviseRequest for per-event details. NotifyAndAdvise(context.Context, *NotifyAndAdviseRequest) (*NotifyAndAdviseResponse, error) Configure(context.Context, *plugin.ConfigureRequest) (*plugin.ConfigureResponse, error) GetPluginInfo(context.Context, *plugin.GetPluginInfoRequest) (*plugin.GetPluginInfoResponse, error) // contains filtered or unexported methods }
NotifierServer is the server API for Notifier service. All implementations must embed UnimplementedNotifierServer for forward compatibility
type NotifyAndAdviseRequest ¶
type NotifyAndAdviseRequest struct { // Types that are assignable to Event: // *NotifyAndAdviseRequest_BundleLoaded Event isNotifyAndAdviseRequest_Event `protobuf_oneof:"event"` // contains filtered or unexported fields }
func (*NotifyAndAdviseRequest) Descriptor
deprecated
func (*NotifyAndAdviseRequest) Descriptor() ([]byte, []int)
Deprecated: Use NotifyAndAdviseRequest.ProtoReflect.Descriptor instead.
func (*NotifyAndAdviseRequest) GetBundleLoaded ¶
func (x *NotifyAndAdviseRequest) GetBundleLoaded() *BundleLoaded
func (*NotifyAndAdviseRequest) GetEvent ¶
func (m *NotifyAndAdviseRequest) GetEvent() isNotifyAndAdviseRequest_Event
func (*NotifyAndAdviseRequest) ProtoMessage ¶
func (*NotifyAndAdviseRequest) ProtoMessage()
func (*NotifyAndAdviseRequest) ProtoReflect ¶
func (x *NotifyAndAdviseRequest) ProtoReflect() protoreflect.Message
func (*NotifyAndAdviseRequest) Reset ¶
func (x *NotifyAndAdviseRequest) Reset()
func (*NotifyAndAdviseRequest) String ¶
func (x *NotifyAndAdviseRequest) String() string
type NotifyAndAdviseRequest_BundleLoaded ¶
type NotifyAndAdviseRequest_BundleLoaded struct { // BundleLoaded is emitted on startup after SPIRE server creates/loads // the trust bundle. If an error is returned SPIRE server is shut down. BundleLoaded *BundleLoaded `protobuf:"bytes,1,opt,name=bundle_loaded,json=bundleLoaded,proto3,oneof"` }
type NotifyAndAdviseResponse ¶
type NotifyAndAdviseResponse struct {
// contains filtered or unexported fields
}
func (*NotifyAndAdviseResponse) Descriptor
deprecated
func (*NotifyAndAdviseResponse) Descriptor() ([]byte, []int)
Deprecated: Use NotifyAndAdviseResponse.ProtoReflect.Descriptor instead.
func (*NotifyAndAdviseResponse) ProtoMessage ¶
func (*NotifyAndAdviseResponse) ProtoMessage()
func (*NotifyAndAdviseResponse) ProtoReflect ¶
func (x *NotifyAndAdviseResponse) ProtoReflect() protoreflect.Message
func (*NotifyAndAdviseResponse) Reset ¶
func (x *NotifyAndAdviseResponse) Reset()
func (*NotifyAndAdviseResponse) String ¶
func (x *NotifyAndAdviseResponse) String() string
type NotifyRequest ¶
type NotifyRequest struct { // Types that are assignable to Event: // *NotifyRequest_BundleUpdated Event isNotifyRequest_Event `protobuf_oneof:"event"` // contains filtered or unexported fields }
func (*NotifyRequest) Descriptor
deprecated
func (*NotifyRequest) Descriptor() ([]byte, []int)
Deprecated: Use NotifyRequest.ProtoReflect.Descriptor instead.
func (*NotifyRequest) GetBundleUpdated ¶
func (x *NotifyRequest) GetBundleUpdated() *BundleUpdated
func (*NotifyRequest) GetEvent ¶
func (m *NotifyRequest) GetEvent() isNotifyRequest_Event
func (*NotifyRequest) ProtoMessage ¶
func (*NotifyRequest) ProtoMessage()
func (*NotifyRequest) ProtoReflect ¶
func (x *NotifyRequest) ProtoReflect() protoreflect.Message
func (*NotifyRequest) Reset ¶
func (x *NotifyRequest) Reset()
func (*NotifyRequest) String ¶
func (x *NotifyRequest) String() string
type NotifyRequest_BundleUpdated ¶
type NotifyRequest_BundleUpdated struct { // BundleUpdated is emitted whenever SPIRE server changes the trust // bundle. BundleUpdated *BundleUpdated `protobuf:"bytes,1,opt,name=bundle_updated,json=bundleUpdated,proto3,oneof"` }
type NotifyResponse ¶
type NotifyResponse struct {
// contains filtered or unexported fields
}
func (*NotifyResponse) Descriptor
deprecated
func (*NotifyResponse) Descriptor() ([]byte, []int)
Deprecated: Use NotifyResponse.ProtoReflect.Descriptor instead.
func (*NotifyResponse) ProtoMessage ¶
func (*NotifyResponse) ProtoMessage()
func (*NotifyResponse) ProtoReflect ¶
func (x *NotifyResponse) ProtoReflect() protoreflect.Message
func (*NotifyResponse) Reset ¶
func (x *NotifyResponse) Reset()
func (*NotifyResponse) String ¶
func (x *NotifyResponse) String() string
type UnimplementedNotifierServer ¶
type UnimplementedNotifierServer struct { }
UnimplementedNotifierServer must be embedded to have forward compatible implementations.
func (UnimplementedNotifierServer) Configure ¶
func (UnimplementedNotifierServer) Configure(context.Context, *plugin.ConfigureRequest) (*plugin.ConfigureResponse, error)
func (UnimplementedNotifierServer) GetPluginInfo ¶
func (UnimplementedNotifierServer) GetPluginInfo(context.Context, *plugin.GetPluginInfoRequest) (*plugin.GetPluginInfoResponse, error)
func (UnimplementedNotifierServer) Notify ¶
func (UnimplementedNotifierServer) Notify(context.Context, *NotifyRequest) (*NotifyResponse, error)
func (UnimplementedNotifierServer) NotifyAndAdvise ¶
func (UnimplementedNotifierServer) NotifyAndAdvise(context.Context, *NotifyAndAdviseRequest) (*NotifyAndAdviseResponse, error)
type UnsafeNotifierServer ¶
type UnsafeNotifierServer interface {
// contains filtered or unexported methods
}
UnsafeNotifierServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to NotifierServer will result in compilation errors.