Protocol

Package : spaceone.api.notification.plugin

Protocol

Protocol Methods:

Method	Request	Response
init	InitRequest	PluginInfo
verify	PluginVerifyRequest	google.protobuf.Empty

init

Initialized when protocol plugin is created first.When this method is executed, plugin return the metadata required when the plug-in is executed.

Type	Message
Request	InitRequest
Response	PluginInfo

verify

A method that proves whether the plugin can be running.If there is no return value, it means that normal execution is possible.

Type	Message
Request	PluginVerifyRequest
Response	google.protobuf.Empty

Message

InitRequest

Field	Type	Required	Description
options	google.protobuf.Struct	✔	Option value used when initializing the plugin.

PluginInfo

Field	Type	Description
metadata	google.protobuf.Struct	Metadata value required to input various values required for plugin to work.Metadata value required to input various values required for plugin to work.In the case of protocol plugins, when creating a channel, the plugin contains the definition of additional data (channel data) required for channel transmission.

PluginVerifyRequest

Field	Type	Required	Description
options	google.protobuf.Struct	✔	Option values required for the plugin to work.
secret_data	google.protobuf.Struct	✔	The secret value required for the plugin to work.The secret data usually includes the credential information required for the plugin to access the external system.