Documentation
¶
Index ¶
- Variables
- func RegisterInfoServer(s grpc.ServiceRegistrar, srv InfoServer)
- type Empty
- type InfoClient
- type InfoServer
- type ParameterInfo
- func (*ParameterInfo) Descriptor() ([]byte, []int)deprecated
- func (x *ParameterInfo) GetDescription() string
- func (x *ParameterInfo) GetMandatory() bool
- func (x *ParameterInfo) GetName() string
- func (*ParameterInfo) ProtoMessage()
- func (x *ParameterInfo) ProtoReflect() protoreflect.Message
- func (x *ParameterInfo) Reset()
- func (x *ParameterInfo) String() string
- type PluginInfo
- func (*PluginInfo) Descriptor() ([]byte, []int)deprecated
- func (x *PluginInfo) GetDescription() string
- func (x *PluginInfo) GetName() string
- func (x *PluginInfo) GetParameters() []*ParameterInfo
- func (x *PluginInfo) GetVersion() *Version
- func (*PluginInfo) ProtoMessage()
- func (x *PluginInfo) ProtoReflect() protoreflect.Message
- func (x *PluginInfo) Reset()
- func (x *PluginInfo) String() string
- type UnimplementedInfoServer
- type UnsafeInfoServer
- type Version
- func (*Version) Descriptor() ([]byte, []int)deprecated
- func (x *Version) GetMaintenance() int32
- func (x *Version) GetMajor() int32
- func (x *Version) GetMinor() int32
- func (*Version) ProtoMessage()
- func (x *Version) ProtoReflect() protoreflect.Message
- func (x *Version) Reset()
- func (x *Version) String() string
Constants ¶
This section is empty.
Variables ¶
var File_util_info_info_proto protoreflect.FileDescriptor
var Info_ServiceDesc = grpc.ServiceDesc{ ServiceName: "plugin.Info", HandlerType: (*InfoServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "getInfo", Handler: _Info_GetInfo_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "util/info/info.proto", }
Info_ServiceDesc is the grpc.ServiceDesc for Info service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterInfoServer ¶
func RegisterInfoServer(s grpc.ServiceRegistrar, srv InfoServer)
Types ¶
type Empty ¶
type Empty struct {
// contains filtered or unexported fields
}
func (*Empty) Descriptor
deprecated
func (*Empty) ProtoMessage ¶
func (*Empty) ProtoMessage()
func (*Empty) ProtoReflect ¶
func (x *Empty) ProtoReflect() protoreflect.Message
type InfoClient ¶
type InfoClient interface {
GetInfo(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*PluginInfo, error)
}
InfoClient is the client API for Info 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 NewInfoClient ¶
func NewInfoClient(cc grpc.ClientConnInterface) InfoClient
type InfoServer ¶
type InfoServer interface {
GetInfo(context.Context, *emptypb.Empty) (*PluginInfo, error)
// contains filtered or unexported methods
}
InfoServer is the server API for Info service. All implementations must embed UnimplementedInfoServer for forward compatibility
type ParameterInfo ¶
type ParameterInfo struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
Mandatory bool `protobuf:"varint,3,opt,name=mandatory,proto3" json:"mandatory,omitempty"`
// contains filtered or unexported fields
}
ParameterInfo contains the information about a parameter. This is used to inform the CLI user what command-line parameters are expected explicitly for this target (plugin).
func (*ParameterInfo) Descriptor
deprecated
func (*ParameterInfo) Descriptor() ([]byte, []int)
Deprecated: Use ParameterInfo.ProtoReflect.Descriptor instead.
func (*ParameterInfo) GetDescription ¶
func (x *ParameterInfo) GetDescription() string
func (*ParameterInfo) GetMandatory ¶
func (x *ParameterInfo) GetMandatory() bool
func (*ParameterInfo) GetName ¶
func (x *ParameterInfo) GetName() string
func (*ParameterInfo) ProtoMessage ¶
func (*ParameterInfo) ProtoMessage()
func (*ParameterInfo) ProtoReflect ¶
func (x *ParameterInfo) ProtoReflect() protoreflect.Message
func (*ParameterInfo) Reset ¶
func (x *ParameterInfo) Reset()
func (*ParameterInfo) String ¶
func (x *ParameterInfo) String() string
type PluginInfo ¶
type PluginInfo struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
Version *Version `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
Parameters []*ParameterInfo `protobuf:"bytes,4,rep,name=parameters,proto3" json:"parameters,omitempty"`
// contains filtered or unexported fields
}
PluginInfo represents the information about a plugin.
func (*PluginInfo) Descriptor
deprecated
func (*PluginInfo) Descriptor() ([]byte, []int)
Deprecated: Use PluginInfo.ProtoReflect.Descriptor instead.
func (*PluginInfo) GetDescription ¶
func (x *PluginInfo) GetDescription() string
func (*PluginInfo) GetName ¶
func (x *PluginInfo) GetName() string
func (*PluginInfo) GetParameters ¶
func (x *PluginInfo) GetParameters() []*ParameterInfo
func (*PluginInfo) GetVersion ¶
func (x *PluginInfo) GetVersion() *Version
func (*PluginInfo) ProtoMessage ¶
func (*PluginInfo) ProtoMessage()
func (*PluginInfo) ProtoReflect ¶
func (x *PluginInfo) ProtoReflect() protoreflect.Message
func (*PluginInfo) Reset ¶
func (x *PluginInfo) Reset()
func (*PluginInfo) String ¶
func (x *PluginInfo) String() string
type UnimplementedInfoServer ¶
type UnimplementedInfoServer struct {
}
UnimplementedInfoServer must be embedded to have forward compatible implementations.
func (UnimplementedInfoServer) GetInfo ¶
func (UnimplementedInfoServer) GetInfo(context.Context, *emptypb.Empty) (*PluginInfo, error)
type UnsafeInfoServer ¶
type UnsafeInfoServer interface {
// contains filtered or unexported methods
}
UnsafeInfoServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to InfoServer will result in compilation errors.
type Version ¶
type Version struct {
Major int32 `protobuf:"varint,1,opt,name=Major,proto3" json:"Major,omitempty"`
Minor int32 `protobuf:"varint,2,opt,name=Minor,proto3" json:"Minor,omitempty"`
Maintenance int32 `protobuf:"varint,3,opt,name=Maintenance,proto3" json:"Maintenance,omitempty"`
// contains filtered or unexported fields
}
Version contains semantic versioning information of the plugin
func (*Version) Descriptor
deprecated
func (*Version) GetMaintenance ¶
func (*Version) ProtoMessage ¶
func (*Version) ProtoMessage()
func (*Version) ProtoReflect ¶
func (x *Version) ProtoReflect() protoreflect.Message