IBM Cloud Event Notifications Go Admin SDK
Go client library to interact with the various IBM Cloud Event Notifications APIs.
Disclaimer: this SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.
Table of Contents
- Overview
- Prerequisites
- Installation
- Initialize SDK
- Using the SDK
- Set Environment
- Questions
- Issues
- Open source @ IBM
- Contributing
- License
Overview
The IBM Cloud Event Notifications Go SDK allows developers to programmatically interact with Event Notifications service in IBM cloud.
| Service Name | Package name |
|---|
Event Notifications Service | eventnotificationsv1
Prerequisites
- An IBM Cloud account.
- An Event Notifications Instance
- Go version 1.16 or above.
Installation
Install using the command.
go get -u github.com/IBM/event-notifications-go-admin-sdk
Go modules
If your application uses Go modules for dependency management (recommended), just add an import for each service that you will use in your application.
Here is an example:
import (
"github.com/IBM/event-notifications-go-admin-sdk/eventnotificationsv1"
)
Next, run go build or go mod tidy to download and install the new dependencies and update your application's go.mod file.
In the example above, the eventnotificationsv1 part of the import path is the package name associated with the Example Service service. See the service table above to find the approprate package name for the services used by your application.
Initialize SDK
Initialize the sdk to connect with your Event Notifications service instance.
func initInstance() *eventnotificationsv1.EventNotificationsV1 {
// IAM API key based authentication
authenticator := &core.IamAuthenticator{
ApiKey: <apikey>,
URL: <IBM Cloud URL to generate Token>,
}
// Set the options for the Event notification instance.
options := &eventnotificationsv1.EventNotificationsV1Options{
Authenticator: authenticator,
URL: "https://" + region + ".event-notifications.cloud.ibm.com/event-notifications",
}
eventNotificationsAPIService, err := eventnotificationsv1.NewEventNotificationsV1(options)
if err != nil {
panic(err)
}
return eventNotificationsAPIService
}
- region : Region of the Event Notifications Instance
Using the SDK
SDK Methods to consume
Source
List Sources
listSourcesOptions := eventNotificationsAPIService.NewListSourcesOptions(
<instance-id>, // Event notifications service instance GUID
)
sourceList, response, err := eventNotificationsAPIService.ListSource(listSourcesOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(sourceList, "", " ")
fmt.Println(string(b))
Get Sources
getSourceOptions := eventNotificationsAPIService.NewGetSourceOptions(
<instance-id>, // Event notifications service instance GUID
<source-id>, // Event notifications service instance Source ID
)
source, response, err := eventNotificationsAPIService.GetSource(getSourceOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(source, "", " ")
fmt.Println(string(b))
Topics
Create Topic
rulesModel := &eventnotificationsv1.Rules{
Enabled: core.BoolPtr(false),
EventTypeFilter: core.StringPtr("$.notification_event_info.event_type == 'cert_manager'"), // Add your event type filter here.
NotificationFilter: core.StringPtr("$.notification.findings[0].severity == 'MODERATE'"), // Add your notification filter here.
}
topicUpdateSourcesItemModel := &eventnotificationsv1.TopicUpdateSourcesItem{
ID: core.StringPtr(<source-id>),
Rules: []eventnotificationsv1.Rules{*rulesModel},
}
createTopicOptions := &eventnotificationsv1.CreateTopicOptions{
InstanceID: core.StringPtr(<instance-id>),
Name: core.StringPtr(<topic-name>]),
Description: core.StringPtr(<topic-description>),
Sources: []eventnotificationsv1.TopicUpdateSourcesItem{*topicUpdateSourcesItemModel},
}
topic, response, err := eventNotificationsAPIService.CreateTopic(createTopicOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(topic, "", " ")
fmt.Println(string(b))
List Topics
listTopicsOptions := eventNotificationsAPIService.NewListTopicsOptions(
<instance-id>,
)
topicList, response, err := eventNotificationsAPIService.ListTopic(listTopicsOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(topicList, "", " ")
fmt.Println(string(b))
Get Topic
getTopicOptions := eventNotificationsAPIService.NewGetTopicOptions(
<instance-id>, // Event notifications service instance GUID
<topic-id>, // Event notifications service instance Topic ID
)
topic, response, err := eventNotificationsAPIService.GetTopic(getTopicOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(topic, "", " ")
fmt.Println(string(b))
Update Topic
rulesModel := &eventnotificationsv1.Rules{
Enabled: core.BoolPtr(true),
EventTypeFilter: core.StringPtr("$.notification_event_info.event_type == 'core_cert_manager'"), // Add your event type filter here.
NotificationFilter: core.StringPtr("$.notification.findings[0].severity == 'SEVERE'"), // Add your notification filter here.
}
topicUpdateSourcesItemModel := &eventnotificationsv1.TopicUpdateSourcesItem{
ID: core.StringPtr(<source-id>), // Event notifications service instance Source ID
Rules: []eventnotificationsv1.Rules{*rulesModel},
}
replaceTopicOptions := &eventnotificationsv1.ReplaceTopicOptions{
InstanceID: core.StringPtr(<instance-id>), // Event notifications service instance GUID
ID: core.StringPtr(<topic-id>), // Event notifications service instance Topic ID
Name: core.StringPtr(<topic-update-name>), // Event notifications service instance Topic Name
Description: core.StringPtr(<topic-update-description>), // Event notifications service instance Topic description
Sources: []eventnotificationsv1.TopicUpdateSourcesItem{*topicUpdateSourcesItemModel},
}
topic, response, err := eventNotificationsInstance.ReplaceTopic(replaceTopicOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(topic, "", " ")
fmt.Println(string(b))
Delete Topic
deleteTopicOptions := eventNotificationsAPIService.NewDeleteTopicOptions(
<instance-id>,
<topic-id>,
)
response, err := eventNotificationsAPIService.DeleteTopic(deleteTopicOptions)
if err != nil {
panic(err)
}
Destinations
Create Destination
createDestinationOptions := eventNotificationsAPIService.NewCreateDestinationOptions(
<instance-id>,
<destination-name>,
<destination-type>,
)
destinationConfigParamsModel := &eventnotificationsv1.DestinationConfigParamsWebhookDestinationConfig{
URL: core.StringPtr(<destination-config-url>),
Verb: core.StringPtr(<destination-config-verb>),
CustomHeaders: make(map[string]string),
SensitiveHeaders: []string{<header-key>},
}
destinationConfigModel := &eventnotificationsv1.DestinationConfig{
Params: destinationConfigParamsModel,
}
createDestinationOptions.SetConfig(destinationConfigModel)
destination, response, err := eventNotificationsAPIService.CreateDestination(createDestinationOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(destination, "", " ")
fmt.Println(string(b))
List Destinations
listDestinationsOptions := eventNotificationsAPIService.NewListDestinationsOptions(
<instance-id>,
)
destinationList, response, err := eventNotificationsAPIService.ListDestinations(listDestinationsOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(destinationList, "", " ")
fmt.Println(string(b))
Get Destination
getDestinationOptions := eventNotificationsAPIService.NewGetDestinationOptions(
<instance-id>, // Event notifications service instance GUID
<destination-id>, // Event notifications service instance Destination ID
)
destination, response, err := eventNotificationsAPIService.GetDestination(getDestinationOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(destination, "", " ")
fmt.Println(string(b))
Update Destination
destinationConfigParamsModel := &eventnotificationsv1.DestinationConfigParamsWebhookDestinationConfig{
URL: core.StringPtr(<destination-config-update-url>),
Verb: core.StringPtr(<destination-config-update-verb>),
CustomHeaders: make(map[string]string),
SensitiveHeaders: []string{<header-key>},
}
destinationConfigModel := &eventnotificationsv1.DestinationConfig{
Params: destinationConfigParamsModel,
}
updateDestinationOptions := eventNotificationsAPIService.NewUpdateDestinationOptions(
<instance-id>, // Event notifications service instance GUID
<destination-id>, // Event notifications service instance Destination ID
)
updateDestinationOptions.SetName(<destination-update-name>)
updateDestinationOptions.SetDescription(<destination-update-description>)
updateDestinationOptions.SetConfig(destinationConfigModel)
destination, response, err := eventNotificationsAPIService.UpdateDestination(updateDestinationOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(destination, "", " ")
fmt.Println(string(b))
Delete Destination
deleteDestinationOptions := eventNotificationsAPIService.NewDeleteDestinationOptions(
<instance-id>, // Event notifications service instance GUID
<destination-id>, // Event notifications service instance Destination ID
)
response, err := eventNotificationsAPIService.DeleteDestination(deleteDestinationOptions)
if err != nil {
panic(err)
}
Subscriptions
Create Subscription
`While Creating Subscription use any of one option from webhook, email or Sms`
createSubscriptionOptions := eventNotificationsAPIService.NewCreateSubscriptionOptions(
<instance-id>, // Event notifications service instance GUID
)
subscriptionCreateAttributesModel := &eventnotificationsv1.SubscriptionCreateAttributes{
SigningEnabled: core.BoolPtr(false),
}
createSubscriptionOptions.SetAttributes(subscriptionCreateAttributesModel)
createSubscriptionOptions.SetDescription(<subscription-description>)
createSubscriptionOptions.SetDestinationID(<destination-id>) // Event notifications service instance Destination ID
createSubscriptionOptions.SetName(<subscription-name>)
createSubscriptionOptions.SetTopicID(<topic-id>) // Event notifications service instance Topic ID
subscription, response, err := eventNotificationsAPIService.CreateSubscription(createSubscriptionOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(subscription, "", " ")
fmt.Println(string(b))
List Subscriptions
listSubscriptionsOptions := eventNotificationsAPIService.NewListSubscriptionsOptions(
<instance-id>, // Event notifications service instance GUID
)
subscriptionList, response, err := eventNotificationsAPIService.ListSubscriptions(listSubscriptionsOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(subscriptionList, "", " ")
fmt.Println(string(b))
Get Subscription
getSubscriptionOptions := eventNotificationsAPIService.NewGetSubscriptionOptions(
<instance-id>, // Event notifications service instance GUID
<subscription-id>, // Event notifications service instance Subscription ID
)
subscription, response, err := eventNotificationsAPIService.GetSubscription(getSubscriptionOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(subscription, "", " ")
fmt.Println(string(b))
Update Subscription
updateSubscriptionOptions := eventNotificationsAPIService.NewUpdateSubscriptionOptions(
<instance-id>, // Event notifications service instance GUID
<subscription-id>, // Event notifications service instance Subscription ID
)
subscriptionUpdateAttributesModel := &eventnotificationsv1.SubscriptionUpdateAttributesWebhookAttributes{
SigningEnabled: core.BoolPtr(true),
}
updateSubscriptionOptions.SetAttributes(subscriptionUpdateAttributesModel)
updateSubscriptionOptions.SetDescription(<subscription-update-description>)
updateSubscriptionOptions.SetName(<subscription-update-name>)
subscription, response, err := eventNotificationsAPIService.UpdateSubscription(updateSubscriptionOptions)
if err != nil {
panic(err)
}
b, _ := json.MarshalIndent(subscription, "", " ")
fmt.Println(string(b))
Delete Subscription
deleteSubscriptionOptions := eventNotificationsAPIService.NewDeleteSubscriptionOptions(
<instance-id>, // Event notifications service instance GUID
<subscription-id>, // Event notifications service instance Subscriptions ID
)
response, err := eventNotificationsAPIService.DeleteSubscription(deleteSubscriptionOptions)
if err != nil {
panic(err)
}
Set Environment
Find event_notifications.env.hide in the repo and rename it to event_notifications.env. After that add the values for,
EVENT_NOTIFICATIONS_URL- Add the Event Notifications service instance Url.EVENT_NOTIFICATIONS_APIKEY- Add the Event Notifications service instance apikey.EVENT_NOTIFICATIONS_GUID- Add the Event Notifications service instance GUID.
Optional
EVENT_NOTIFICATIONS_AUTH_URL- Add the IAM url if you are using IBM test cloud.
Questions
If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.
Open source @ IBM
Find more open source projects on the IBM Github Page
Contributing
See CONTRIBUTING.
License
This SDK project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.
