Protocol #

A Protocol is a plugin instance defining how a User receives data from Cloudforet.

Package : spaceone.api.notification.plugin

Protocol #

Protocol Methods:

init #

Initializes a specific Protocol. During initialization, the Protocol information to be passed to the Protocol user is delivered as metadata. Protocol information includes its name and version.

{
   "options": {}
}

{   
   "metadata": {}
}

verify #

Verifies if a specific Protocol is a valid plugin instance.

{
   "options": {}
}

Message #

InitRequest #

• options (Struct) Required

  Option value used when initializing the plugin.

  
  

PluginInfo #

• metadata (Struct) Required

  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 #

• options (Struct) Required

  Option values required for the plugin to work.

• secret_data (Struct) Required

  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.