executor

type Config struct {

	// rawYAML contains the Executor configuration in YAML definitions.
	// Configuration data is unique per executor.
	// Botkube related configuration details are stored in ExecuteContext instead.
	RawYAML []byte `protobuf:"bytes,1,opt,name=rawYAML,proto3" json:"rawYAML,omitempty"`
	// contains filtered or unexported fields
}

type Dependency struct {

	// urls is the map of URL of the dependency. The key is in format of "os/arch", such as "linux/amd64".
	Urls map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

type ExecuteContext struct {

	// isInteractivitySupported is set to true only if communication platform supports interactive Messages
	// with buttons, select menus, etc. If set to false, you should send only text based messages.
	IsInteractivitySupported bool `protobuf:"varint,1,opt,name=isInteractivitySupported,proto3" json:"isInteractivitySupported,omitempty"`
	// slackState represents modal state. It's available only if:
	//   - IsInteractivitySupported is set to true,
	//   - and interactive actions were used in the response Message.
	//
	// This is an alpha feature and may change in the future.
	// Most likely, it will be generalized to support all communication platforms.
	SlackState []byte `protobuf:"bytes,2,opt,name=slackState,proto3" json:"slackState,omitempty"`
	// kubeConfig is the slice of byte representation of kubeconfig file content.
	// it is available only if context.rbac is configured for a given plugins. Otherwise, it is empty.
	KubeConfig []byte `protobuf:"bytes,3,opt,name=kubeConfig,proto3" json:"kubeConfig,omitempty"`
	// message holds message details that triggered a given Executor.
	Message *MessageContext `protobuf:"bytes,4,opt,name=message,proto3" json:"message,omitempty"`
	// incomingWebhook holds details about Botkube built-in incoming webhook configuration.
	IncomingWebhook *IncomingWebhookContext `protobuf:"bytes,5,opt,name=incomingWebhook,proto3" json:"incomingWebhook,omitempty"`
	// contains filtered or unexported fields
}

type ExecuteInput struct {
	// Context holds execution context.
	Context ExecuteInputContext
	// Command holds the command to be executed.
	Command string
	// Configs is a list of Executor configurations specified by users.
	Configs []*Config
}

type ExecuteInputContext struct {
	// IsInteractivitySupported is set to true only if communication platform supports interactive Messages.
	IsInteractivitySupported bool

	// KubeConfig is the slice of byte representation of kubeconfig file content
	KubeConfig []byte

	// SlackState represents modal state. It's available only if:
	//  - IsInteractivitySupported is set to true,
	//  - and interactive actions were used in the response Message.
	// This is an alpha feature and may change in the future.
	// Most likely, it will be generalized to support all communication platforms.
	SlackState *slack.BlockActionStates

	// Message details that triggered a given Executor.
	// Limitations:
	//   - It's available only for SocketSlack. In the future, it may be adopted across other platforms.
	Message Message

	IncomingWebhook IncomingWebhookDetailsContext
}

type ExecuteOutput struct {
	// Message represents the output of processing a given input command.
	// You can construct a complex message or just use one of our helper functions:
	//   - api.NewCodeBlockMessage("body", true)
	//   - api.NewPlaintextMessage("body", true)
	Message api.Message
	// Messages holds a collection of messages that should be dispatched to the user in the context of a given command execution.
	// To avoid spamming, you can specify max 15 messages.
	// Limitations:
	//   - It's available only for SocketSlack. In the future, it may be adopted across other platforms.
	//   - Message filtering is not available.
	Messages []api.Message
}

type ExecuteRequest struct {

	// command represents the exact command that was specified by the user.
	Command string `protobuf:"bytes,1,opt,name=command,proto3" json:"command,omitempty"`
	// configs is a list of Executor configurations specified by users.
	Configs []*Config `protobuf:"bytes,2,rep,name=configs,proto3" json:"configs,omitempty"`
	// context holds context execution.
	Context *ExecuteContext `protobuf:"bytes,3,opt,name=context,proto3" json:"context,omitempty"`
	// contains filtered or unexported fields
}

type ExecuteResponse struct {

	// message represents the output of processing a given input command.
	// You can construct a complex message or just use one of our helper functions:
	//   - api.NewCodeBlockMessage("body", true)
	//   - api.NewPlaintextMessage("body", true)
	Message []byte `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// messages holds a collection of messages that should be dispatched to the user in the context of a given command execution.
	// To avoid spamming, you can specify max 15 messages.
	// Limitations:
	//   - It's available only for SocketSlack. In the future, it may be adopted across other platforms.
	//   - Interactive message filtering is not available. (https://docs.botkube.io/usage/interactive-output-filtering)
	Messages [][]byte `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

type Executor interface {
	Execute(context.Context, ExecuteInput) (ExecuteOutput, error)
	Metadata(ctx context.Context) (api.MetadataOutput, error)
	Help(context.Context) (api.Message, error)
}

type ExecutorClient interface {
	Execute(ctx context.Context, in *ExecuteRequest, opts ...grpc.CallOption) (*ExecuteResponse, error)
	Metadata(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*MetadataResponse, error)
	Help(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*HelpResponse, error)
}

type ExecutorServer interface {
	Execute(context.Context, *ExecuteRequest) (*ExecuteResponse, error)
	Metadata(context.Context, *emptypb.Empty) (*MetadataResponse, error)
	Help(context.Context, *emptypb.Empty) (*HelpResponse, error)
	// contains filtered or unexported methods
}

type HelpResponse struct {

	// help is the help of a given plugin.
	// You can construct a complex message with buttons etc, or just use one of our helper functions:
	//   - api.NewCodeBlockMessage("body", true)
	//   - api.NewPlaintextMessage("body", true)
	Help []byte `protobuf:"bytes,1,opt,name=help,proto3" json:"help,omitempty"`
	// contains filtered or unexported fields
}

type IncomingWebhookContext struct {
	BaseSourceURL string `protobuf:"bytes,1,opt,name=baseSourceURL,proto3" json:"baseSourceURL,omitempty"`
	// contains filtered or unexported fields
}

type IncomingWebhookDetailsContext struct {
	BaseSourceURL string
}

type JSONSchema struct {

	// value is the string value of the JSON schema.
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// ref_url is the remote reference of the JSON schema.
	RefUrl string `protobuf:"bytes,2,opt,name=ref_url,json=refUrl,proto3" json:"ref_url,omitempty"`
	// contains filtered or unexported fields
}

type Message struct {
	Text string
	URL  string
	User User

	// ParentActivityID is the ID of the parent activity. If user follows with messages in a thread, this ID represents the originating message that started that thread.
	// Otherwise, it's the ID of the initial message.
	ParentActivityID string
}

type MessageContext struct {

	// text is the text of the message in the raw format.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// url is the URL of the message. Can be used to open the message in a browser.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// parentActivityId is the ID of the parent activity. If user follows with messages in a thread, this ID represents the originating message that started that thread.
	// Otherwise, it's the ID of the initial message.
	ParentActivityId string `protobuf:"bytes,3,opt,name=parentActivityId,proto3" json:"parentActivityId,omitempty"`
	// user holds user details that wrote a given message.
	User *UserContext `protobuf:"bytes,4,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

type MetadataResponse struct {

	// version is a version of a given plugin. It should follow the SemVer syntax.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// description is a description of a given plugin.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// json_schema is a JSON schema of a given plugin.
	JsonSchema *JSONSchema `protobuf:"bytes,3,opt,name=json_schema,json=jsonSchema,proto3" json:"json_schema,omitempty"`
	// dependencies is a list of dependencies of a given plugin.
	Dependencies map[string]*Dependency `` /* 165-byte string literal not displayed */
	// URL to plugin documentation.
	DocumentationUrl string `protobuf:"bytes,5,opt,name=documentation_url,json=documentationUrl,proto3" json:"documentation_url,omitempty"`
	// Recommended plugin recommended
	Recommended bool `protobuf:"varint,6,opt,name=recommended,proto3" json:"recommended,omitempty"`
	// contains filtered or unexported fields
}

type Plugin struct {
	// The GRPC plugin must still implement the Plugin interface.
	plugin.NetRPCUnsupportedPlugin

	// Executor represents a concrete implementation that handles the business logic.
	Executor Executor
}

type UnimplementedExecutorServer struct {
}

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

type User struct {
	// ID represents users identifier.
	Mention string
	// DisplayName represents user display name. It can be empty.
	DisplayName string
}

type UserContext struct {

	// mention represents a user platforms specific mention of the user.
	Mention string `protobuf:"bytes,1,opt,name=mention,proto3" json:"mention,omitempty"`
	// displayName represents user display name. It can be empty.
	DisplayName string `protobuf:"bytes,2,opt,name=displayName,proto3" json:"displayName,omitempty"`
	// contains filtered or unexported fields
}