plugin

type Info ¶

type Info interface {
	GetInfo(ctx context.Context) (*PluginInfo, error)
}

Info interface needs to be implemented by all plugins to provide basic plugin information.

type InfoPlugin ¶

type InfoPlugin struct {
	plugin.Plugin

	Impl InfoServiceServer
}

InfoPlugin is used on the server (CLI) and client (plugin) side to integrate with the plugin system. A plugin should not be using this directly, but instead depend on the cli-plugin-base library to register the plugins.

func (InfoPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

func (p *InfoPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

type InfoServiceClient ¶ added in v0.32.0

type InfoServiceClient interface {
	GetInfo(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*PluginInfo, error)
}

InfoServiceClient is the client API for InfoService 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 NewInfoServiceClient(cc grpc.ClientConnInterface) InfoServiceClient

type InfoServiceServer ¶ added in v0.32.0

type InfoServiceServer interface {
	GetInfo(context.Context, *emptypb.Empty) (*PluginInfo, error)
	// contains filtered or unexported methods
}

InfoServiceServer is the server API for InfoService service. All implementations must embed UnimplementedInfoServiceServer 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() ([]byte, []int)

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 ¶

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.SemVer  `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	Parameters  []*ParameterInfo `protobuf:"bytes,4,rep,name=parameters,proto3" json:"parameters,omitempty"`
	TagSource   string           `protobuf:"bytes,5,opt,name=tag_source,json=tagSource,proto3" json:"tag_source,omitempty"`
	Type        []PluginType     `protobuf:"varint,6,rep,packed,name=type,proto3,enum=util.plugin.PluginType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

PluginInfo represents the information about a plugin.

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

func (x *PluginInfo) GetDescription() string

func (x *PluginInfo) GetName() string

func (x *PluginInfo) GetParameters() []*ParameterInfo

func (x *PluginInfo) GetTagSource() string

func (x *PluginInfo) GetType() []PluginType

func (x *PluginInfo) GetVersion() *version.SemVer

func (i *PluginInfo) InfoString() string

func (*PluginInfo) ProtoMessage()

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

func (x *PluginInfo) Reset()

func (x *PluginInfo) String() string

type PluginType ¶ added in v0.61.0

type PluginType int32

const (
	// UNKNOWN plugin type. Avoid this type.
	// If type is unknown CLI will fallback on FULL_DS_SYNC
	PluginType_PLUGIN_TYPE_UNKNOWN PluginType = 0
	// FULL_DS_SYNC execute data source sync, identity store sync, access provider sync and data usage sync.
	// This type should be used for most data sources such as snowflake, bigquery, databricks, and so on.
	// A websocket may be initialized for this type.
	PluginType_PLUGIN_TYPE_FULL_DS_SYNC PluginType = 1
	// IS_SYNC execute only an identity store sync.
	// This type should be used for syncing identity providers (such as okta).
	PluginType_PLUGIN_TYPE_IS_SYNC PluginType = 2
	// TAG_SYNC execute only a tag sync.
	// This type should be used for syncing tags on external sources (such as catalogs).
	PluginType_PLUGIN_TYPE_TAG_SYNC PluginType = 3
	// AC_PROVIDER execute only an access provider sync.
	// This type should be used for plugins that provide Raito Cloud Resources.
	PluginType_PLUGIN_TYPE_RESOURCE_PROVIDER PluginType = 4
)

func (PluginType) Descriptor() protoreflect.EnumDescriptor

func (x PluginType) Enum() *PluginType

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

func (x PluginType) Number() protoreflect.EnumNumber

func (x PluginType) String() string

func (PluginType) Type() protoreflect.EnumType

type UnimplementedInfoServiceServer ¶ added in v0.32.0

type UnimplementedInfoServiceServer struct {
}

UnimplementedInfoServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedInfoServiceServer) GetInfo(context.Context, *emptypb.Empty) (*PluginInfo, error)

type UnsafeInfoServiceServer ¶ added in v0.32.0

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

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