Documentation
¶
Overview ¶
Package eventnotificationsv1 : Operations and models for the EventNotificationsV1 service
Index ¶
- Constants
- func GetServiceURLForRegion(region string) (string, error)
- func UnmarshalDestination(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDestinationConfig(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDestinationConfigParams(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDestinationConfigParamsWebhookDestinationConfig(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDestinationLisItem(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDestinationList(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDestinationResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalRules(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalRulesGet(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSource(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSourceList(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSourcesListItem(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscription(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionAttributes(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionAttributesEmailAttributesResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionAttributesSmsAttributesResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionAttributesWebhookAttributesResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionCreateAttributes(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionCreateAttributesEmailAttributes(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionCreateAttributesSmsAttributes(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionCreateAttributesWebhookAttributes(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionList(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionListItem(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionUpdateAttributes(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionUpdateAttributesEmailAttributes(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionUpdateAttributesSmsAttributes(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalSubscriptionUpdateAttributesWebhookAttributes(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTopic(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTopicList(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTopicResponse(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTopicSourcesItem(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTopicUpdateSourcesItem(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalTopicsListItem(m map[string]json.RawMessage, result interface{}) (err error)
- type CreateDestinationOptions
- func (_options *CreateDestinationOptions) SetConfig(config *DestinationConfig) *CreateDestinationOptions
- func (_options *CreateDestinationOptions) SetDescription(description string) *CreateDestinationOptions
- func (options *CreateDestinationOptions) SetHeaders(param map[string]string) *CreateDestinationOptions
- func (_options *CreateDestinationOptions) SetInstanceID(instanceID string) *CreateDestinationOptions
- func (_options *CreateDestinationOptions) SetName(name string) *CreateDestinationOptions
- func (_options *CreateDestinationOptions) SetType(typeVar string) *CreateDestinationOptions
- type CreateSubscriptionOptions
- func (_options *CreateSubscriptionOptions) SetAttributes(attributes SubscriptionCreateAttributesIntf) *CreateSubscriptionOptions
- func (_options *CreateSubscriptionOptions) SetDescription(description string) *CreateSubscriptionOptions
- func (_options *CreateSubscriptionOptions) SetDestinationID(destinationID string) *CreateSubscriptionOptions
- func (options *CreateSubscriptionOptions) SetHeaders(param map[string]string) *CreateSubscriptionOptions
- func (_options *CreateSubscriptionOptions) SetInstanceID(instanceID string) *CreateSubscriptionOptions
- func (_options *CreateSubscriptionOptions) SetName(name string) *CreateSubscriptionOptions
- func (_options *CreateSubscriptionOptions) SetTopicID(topicID string) *CreateSubscriptionOptions
- type CreateTopicOptions
- func (_options *CreateTopicOptions) SetDescription(description string) *CreateTopicOptions
- func (options *CreateTopicOptions) SetHeaders(param map[string]string) *CreateTopicOptions
- func (_options *CreateTopicOptions) SetInstanceID(instanceID string) *CreateTopicOptions
- func (_options *CreateTopicOptions) SetName(name string) *CreateTopicOptions
- func (_options *CreateTopicOptions) SetSources(sources []TopicUpdateSourcesItem) *CreateTopicOptions
- type DeleteDestinationOptions
- type DeleteSubscriptionOptions
- type DeleteTopicOptions
- type Destination
- type DestinationConfig
- type DestinationConfigParams
- type DestinationConfigParamsIntf
- type DestinationConfigParamsWebhookDestinationConfig
- type DestinationLisItem
- type DestinationList
- type DestinationResponse
- type EventNotificationsV1
- func (eventNotifications *EventNotificationsV1) Clone() *EventNotificationsV1
- func (eventNotifications *EventNotificationsV1) CreateDestination(createDestinationOptions *CreateDestinationOptions) (result *DestinationResponse, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) CreateDestinationWithContext(ctx context.Context, createDestinationOptions *CreateDestinationOptions) (result *DestinationResponse, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) CreateSubscription(createSubscriptionOptions *CreateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) CreateSubscriptionWithContext(ctx context.Context, createSubscriptionOptions *CreateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) CreateTopic(createTopicOptions *CreateTopicOptions) (result *TopicResponse, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) CreateTopicWithContext(ctx context.Context, createTopicOptions *CreateTopicOptions) (result *TopicResponse, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) DeleteDestination(deleteDestinationOptions *DeleteDestinationOptions) (response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) DeleteDestinationWithContext(ctx context.Context, deleteDestinationOptions *DeleteDestinationOptions) (response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) DeleteSubscription(deleteSubscriptionOptions *DeleteSubscriptionOptions) (response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) DeleteSubscriptionWithContext(ctx context.Context, deleteSubscriptionOptions *DeleteSubscriptionOptions) (response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) DeleteTopic(deleteTopicOptions *DeleteTopicOptions) (response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) DeleteTopicWithContext(ctx context.Context, deleteTopicOptions *DeleteTopicOptions) (response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) DisableRetries()
- func (eventNotifications *EventNotificationsV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
- func (eventNotifications *EventNotificationsV1) GetDestination(getDestinationOptions *GetDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) GetDestinationWithContext(ctx context.Context, getDestinationOptions *GetDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) GetEnableGzipCompression() bool
- func (eventNotifications *EventNotificationsV1) GetServiceURL() string
- func (eventNotifications *EventNotificationsV1) GetSource(getSourceOptions *GetSourceOptions) (result *Source, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) GetSourceWithContext(ctx context.Context, getSourceOptions *GetSourceOptions) (result *Source, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) GetSubscription(getSubscriptionOptions *GetSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) GetSubscriptionWithContext(ctx context.Context, getSubscriptionOptions *GetSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) GetTopic(getTopicOptions *GetTopicOptions) (result *Topic, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) GetTopicWithContext(ctx context.Context, getTopicOptions *GetTopicOptions) (result *Topic, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) ListDestinations(listDestinationsOptions *ListDestinationsOptions) (result *DestinationList, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) ListDestinationsWithContext(ctx context.Context, listDestinationsOptions *ListDestinationsOptions) (result *DestinationList, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) ListSources(listSourcesOptions *ListSourcesOptions) (result *SourceList, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) ListSourcesWithContext(ctx context.Context, listSourcesOptions *ListSourcesOptions) (result *SourceList, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) ListSubscriptions(listSubscriptionsOptions *ListSubscriptionsOptions) (result *SubscriptionList, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) ListSubscriptionsWithContext(ctx context.Context, listSubscriptionsOptions *ListSubscriptionsOptions) (result *SubscriptionList, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) ListTopics(listTopicsOptions *ListTopicsOptions) (result *TopicList, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) ListTopicsWithContext(ctx context.Context, listTopicsOptions *ListTopicsOptions) (result *TopicList, response *core.DetailedResponse, err error)
- func (*EventNotificationsV1) NewCreateDestinationOptions(instanceID string, name string, typeVar string) *CreateDestinationOptions
- func (*EventNotificationsV1) NewCreateSubscriptionOptions(instanceID string, name string, destinationID string, topicID string, ...) *CreateSubscriptionOptions
- func (*EventNotificationsV1) NewCreateTopicOptions(instanceID string, name string) *CreateTopicOptions
- func (*EventNotificationsV1) NewDeleteDestinationOptions(instanceID string, id string) *DeleteDestinationOptions
- func (*EventNotificationsV1) NewDeleteSubscriptionOptions(instanceID string, id string) *DeleteSubscriptionOptions
- func (*EventNotificationsV1) NewDeleteTopicOptions(instanceID string, id string) *DeleteTopicOptions
- func (*EventNotificationsV1) NewDestinationConfig(params DestinationConfigParamsIntf) (_model *DestinationConfig, err error)
- func (*EventNotificationsV1) NewDestinationConfigParamsWebhookDestinationConfig(url string, verb string) (_model *DestinationConfigParamsWebhookDestinationConfig, err error)
- func (*EventNotificationsV1) NewGetDestinationOptions(instanceID string, id string) *GetDestinationOptions
- func (*EventNotificationsV1) NewGetSourceOptions(instanceID string, id string) *GetSourceOptions
- func (*EventNotificationsV1) NewGetSubscriptionOptions(instanceID string, id string) *GetSubscriptionOptions
- func (*EventNotificationsV1) NewGetTopicOptions(instanceID string, id string) *GetTopicOptions
- func (*EventNotificationsV1) NewListDestinationsOptions(instanceID string) *ListDestinationsOptions
- func (*EventNotificationsV1) NewListSourcesOptions(instanceID string) *ListSourcesOptions
- func (*EventNotificationsV1) NewListSubscriptionsOptions(instanceID string) *ListSubscriptionsOptions
- func (*EventNotificationsV1) NewListTopicsOptions(instanceID string) *ListTopicsOptions
- func (*EventNotificationsV1) NewReplaceTopicOptions(instanceID string, id string) *ReplaceTopicOptions
- func (*EventNotificationsV1) NewRules(eventTypeFilter string) (_model *Rules, err error)
- func (*EventNotificationsV1) NewSubscriptionCreateAttributesEmailAttributes(to []string, addNotificationPayload bool) (_model *SubscriptionCreateAttributesEmailAttributes, err error)
- func (*EventNotificationsV1) NewSubscriptionCreateAttributesSmsAttributes(to []string) (_model *SubscriptionCreateAttributesSmsAttributes, err error)
- func (*EventNotificationsV1) NewSubscriptionCreateAttributesWebhookAttributes(signingEnabled bool) (_model *SubscriptionCreateAttributesWebhookAttributes, err error)
- func (*EventNotificationsV1) NewSubscriptionUpdateAttributesEmailAttributes(to []string, addNotificationPayload bool) (_model *SubscriptionUpdateAttributesEmailAttributes, err error)
- func (*EventNotificationsV1) NewSubscriptionUpdateAttributesSmsAttributes(to []string) (_model *SubscriptionUpdateAttributesSmsAttributes, err error)
- func (*EventNotificationsV1) NewSubscriptionUpdateAttributesWebhookAttributes(signingEnabled bool) (_model *SubscriptionUpdateAttributesWebhookAttributes, err error)
- func (*EventNotificationsV1) NewTopicUpdateSourcesItem(id string, rules []Rules) (_model *TopicUpdateSourcesItem, err error)
- func (*EventNotificationsV1) NewUpdateDestinationOptions(instanceID string, id string) *UpdateDestinationOptions
- func (*EventNotificationsV1) NewUpdateSubscriptionOptions(instanceID string, id string) *UpdateSubscriptionOptions
- func (eventNotifications *EventNotificationsV1) ReplaceTopic(replaceTopicOptions *ReplaceTopicOptions) (result *Topic, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) ReplaceTopicWithContext(ctx context.Context, replaceTopicOptions *ReplaceTopicOptions) (result *Topic, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) SetDefaultHeaders(headers http.Header)
- func (eventNotifications *EventNotificationsV1) SetEnableGzipCompression(enableGzip bool)
- func (eventNotifications *EventNotificationsV1) SetServiceURL(url string) error
- func (eventNotifications *EventNotificationsV1) UpdateDestination(updateDestinationOptions *UpdateDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) UpdateDestinationWithContext(ctx context.Context, updateDestinationOptions *UpdateDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) UpdateSubscription(updateSubscriptionOptions *UpdateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
- func (eventNotifications *EventNotificationsV1) UpdateSubscriptionWithContext(ctx context.Context, updateSubscriptionOptions *UpdateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
- type EventNotificationsV1Options
- type GetDestinationOptions
- type GetSourceOptions
- type GetSubscriptionOptions
- type GetTopicOptions
- func (options *GetTopicOptions) SetHeaders(param map[string]string) *GetTopicOptions
- func (_options *GetTopicOptions) SetID(id string) *GetTopicOptions
- func (_options *GetTopicOptions) SetInclude(include string) *GetTopicOptions
- func (_options *GetTopicOptions) SetInstanceID(instanceID string) *GetTopicOptions
- type ListDestinationsOptions
- func (options *ListDestinationsOptions) SetHeaders(param map[string]string) *ListDestinationsOptions
- func (_options *ListDestinationsOptions) SetInstanceID(instanceID string) *ListDestinationsOptions
- func (_options *ListDestinationsOptions) SetLimit(limit int64) *ListDestinationsOptions
- func (_options *ListDestinationsOptions) SetOffset(offset int64) *ListDestinationsOptions
- func (_options *ListDestinationsOptions) SetSearch(search string) *ListDestinationsOptions
- type ListSourcesOptions
- func (options *ListSourcesOptions) SetHeaders(param map[string]string) *ListSourcesOptions
- func (_options *ListSourcesOptions) SetInstanceID(instanceID string) *ListSourcesOptions
- func (_options *ListSourcesOptions) SetLimit(limit int64) *ListSourcesOptions
- func (_options *ListSourcesOptions) SetOffset(offset int64) *ListSourcesOptions
- func (_options *ListSourcesOptions) SetSearch(search string) *ListSourcesOptions
- type ListSubscriptionsOptions
- func (options *ListSubscriptionsOptions) SetHeaders(param map[string]string) *ListSubscriptionsOptions
- func (_options *ListSubscriptionsOptions) SetInstanceID(instanceID string) *ListSubscriptionsOptions
- func (_options *ListSubscriptionsOptions) SetLimit(limit int64) *ListSubscriptionsOptions
- func (_options *ListSubscriptionsOptions) SetOffset(offset int64) *ListSubscriptionsOptions
- func (_options *ListSubscriptionsOptions) SetSearch(search string) *ListSubscriptionsOptions
- type ListTopicsOptions
- func (options *ListTopicsOptions) SetHeaders(param map[string]string) *ListTopicsOptions
- func (_options *ListTopicsOptions) SetInstanceID(instanceID string) *ListTopicsOptions
- func (_options *ListTopicsOptions) SetLimit(limit int64) *ListTopicsOptions
- func (_options *ListTopicsOptions) SetOffset(offset int64) *ListTopicsOptions
- func (_options *ListTopicsOptions) SetSearch(search string) *ListTopicsOptions
- type ReplaceTopicOptions
- func (_options *ReplaceTopicOptions) SetDescription(description string) *ReplaceTopicOptions
- func (options *ReplaceTopicOptions) SetHeaders(param map[string]string) *ReplaceTopicOptions
- func (_options *ReplaceTopicOptions) SetID(id string) *ReplaceTopicOptions
- func (_options *ReplaceTopicOptions) SetInstanceID(instanceID string) *ReplaceTopicOptions
- func (_options *ReplaceTopicOptions) SetName(name string) *ReplaceTopicOptions
- func (_options *ReplaceTopicOptions) SetSources(sources []TopicUpdateSourcesItem) *ReplaceTopicOptions
- type Rules
- type RulesGet
- type Source
- type SourceList
- type SourcesListItem
- type Subscription
- func (o *Subscription) GetProperties() map[string]interface{}
- func (o *Subscription) GetProperty(key string) interface{}
- func (o *Subscription) MarshalJSON() (buffer []byte, err error)
- func (o *Subscription) SetProperties(m map[string]interface{})
- func (o *Subscription) SetProperty(key string, value interface{})
- type SubscriptionAttributes
- type SubscriptionAttributesEmailAttributesResponse
- type SubscriptionAttributesIntf
- type SubscriptionAttributesSmsAttributesResponse
- type SubscriptionAttributesWebhookAttributesResponse
- type SubscriptionCreateAttributes
- type SubscriptionCreateAttributesEmailAttributes
- type SubscriptionCreateAttributesIntf
- type SubscriptionCreateAttributesSmsAttributes
- type SubscriptionCreateAttributesWebhookAttributes
- type SubscriptionList
- type SubscriptionListItem
- type SubscriptionUpdateAttributes
- type SubscriptionUpdateAttributesEmailAttributes
- type SubscriptionUpdateAttributesIntf
- type SubscriptionUpdateAttributesSmsAttributes
- type SubscriptionUpdateAttributesWebhookAttributes
- type Topic
- type TopicList
- type TopicResponse
- type TopicSourcesItem
- type TopicUpdateSourcesItem
- type TopicsListItem
- type UpdateDestinationOptions
- func (_options *UpdateDestinationOptions) SetConfig(config *DestinationConfig) *UpdateDestinationOptions
- func (_options *UpdateDestinationOptions) SetDescription(description string) *UpdateDestinationOptions
- func (options *UpdateDestinationOptions) SetHeaders(param map[string]string) *UpdateDestinationOptions
- func (_options *UpdateDestinationOptions) SetID(id string) *UpdateDestinationOptions
- func (_options *UpdateDestinationOptions) SetInstanceID(instanceID string) *UpdateDestinationOptions
- func (_options *UpdateDestinationOptions) SetName(name string) *UpdateDestinationOptions
- type UpdateSubscriptionOptions
- func (_options *UpdateSubscriptionOptions) SetAttributes(attributes SubscriptionUpdateAttributesIntf) *UpdateSubscriptionOptions
- func (_options *UpdateSubscriptionOptions) SetDescription(description string) *UpdateSubscriptionOptions
- func (options *UpdateSubscriptionOptions) SetHeaders(param map[string]string) *UpdateSubscriptionOptions
- func (_options *UpdateSubscriptionOptions) SetID(id string) *UpdateSubscriptionOptions
- func (_options *UpdateSubscriptionOptions) SetInstanceID(instanceID string) *UpdateSubscriptionOptions
- func (_options *UpdateSubscriptionOptions) SetName(name string) *UpdateSubscriptionOptions
Constants ¶
const ( DestinationTypeSMTPIBMConst = "smtp_ibm" DestinationTypeSmsIBMConst = "sms_ibm" DestinationTypeWebhookConst = "webhook" )
Constants associated with the Destination.Type property. Destination type Email/SMS/Webhook.
const ( DestinationConfigParamsVerbGetConst = "get" DestinationConfigParamsVerbPostConst = "post" )
Constants associated with the DestinationConfigParams.Verb property. HTTP method of webhook.
const ( DestinationLisItemTypeSMTPIBMConst = "smtp_ibm" DestinationLisItemTypeSmsIBMConst = "sms_ibm" DestinationLisItemTypeWebhookConst = "webhook" )
Constants associated with the DestinationLisItem.Type property. Destination type Email/SMS/Webhook.
const ( SubscriptionDestinationTypeSMTPIBMConst = "smtp_ibm" SubscriptionDestinationTypeSmsIBMConst = "sms_ibm" SubscriptionDestinationTypeWebhookConst = "webhook" )
Constants associated with the Subscription.DestinationType property. The type of destination.
const ( SubscriptionListItemDestinationTypeSMTPIBMConst = "smtp_ibm" SubscriptionListItemDestinationTypeSmsIBMConst = "sms_ibm" SubscriptionListItemDestinationTypeWebhookConst = "webhook" )
Constants associated with the SubscriptionListItem.DestinationType property. The type of destination.
const ( DestinationConfigParamsWebhookDestinationConfigVerbGetConst = "get" DestinationConfigParamsWebhookDestinationConfigVerbPostConst = "post" )
Constants associated with the DestinationConfigParamsWebhookDestinationConfig.Verb property. HTTP method of webhook.
const (
CreateDestinationOptionsTypeWebhookConst = "webhook"
)
Constants associated with the CreateDestinationOptions.Type property. The type of Destination Webhook.
const DefaultServiceName = "event_notifications"
DefaultServiceName is the default key used to find external configuration information.
const DefaultServiceURL = "https://notifications-dev-02072d4876b4d118c3c99d947398ca94-0001.us-south.containers.appdomain.cloud/event-notifications"
DefaultServiceURL is the default URL to make service requests to.
const (
DestinationResponseTypeWebhookConst = "webhook"
)
Constants associated with the DestinationResponse.Type property. Destination type Email/SMS/Webhook.
Variables ¶
This section is empty.
Functions ¶
func GetServiceURLForRegion ¶
GetServiceURLForRegion returns the service URL to be used for the specified region
func UnmarshalDestination ¶
func UnmarshalDestination(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDestination unmarshals an instance of Destination from the specified map of raw messages.
func UnmarshalDestinationConfig ¶
func UnmarshalDestinationConfig(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDestinationConfig unmarshals an instance of DestinationConfig from the specified map of raw messages.
func UnmarshalDestinationConfigParams ¶
func UnmarshalDestinationConfigParams(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDestinationConfigParams unmarshals an instance of DestinationConfigParams from the specified map of raw messages.
func UnmarshalDestinationConfigParamsWebhookDestinationConfig ¶
func UnmarshalDestinationConfigParamsWebhookDestinationConfig(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDestinationConfigParamsWebhookDestinationConfig unmarshals an instance of DestinationConfigParamsWebhookDestinationConfig from the specified map of raw messages.
func UnmarshalDestinationLisItem ¶
func UnmarshalDestinationLisItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDestinationLisItem unmarshals an instance of DestinationLisItem from the specified map of raw messages.
func UnmarshalDestinationList ¶
func UnmarshalDestinationList(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDestinationList unmarshals an instance of DestinationList from the specified map of raw messages.
func UnmarshalDestinationResponse ¶
func UnmarshalDestinationResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDestinationResponse unmarshals an instance of DestinationResponse from the specified map of raw messages.
func UnmarshalRules ¶
func UnmarshalRules(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalRules unmarshals an instance of Rules from the specified map of raw messages.
func UnmarshalRulesGet ¶
func UnmarshalRulesGet(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalRulesGet unmarshals an instance of RulesGet from the specified map of raw messages.
func UnmarshalSource ¶
func UnmarshalSource(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSource unmarshals an instance of Source from the specified map of raw messages.
func UnmarshalSourceList ¶
func UnmarshalSourceList(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSourceList unmarshals an instance of SourceList from the specified map of raw messages.
func UnmarshalSourcesListItem ¶
func UnmarshalSourcesListItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSourcesListItem unmarshals an instance of SourcesListItem from the specified map of raw messages.
func UnmarshalSubscription ¶
func UnmarshalSubscription(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscription unmarshals an instance of Subscription from the specified map of raw messages.
func UnmarshalSubscriptionAttributes ¶
func UnmarshalSubscriptionAttributes(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionAttributes unmarshals an instance of SubscriptionAttributes from the specified map of raw messages.
func UnmarshalSubscriptionAttributesEmailAttributesResponse ¶
func UnmarshalSubscriptionAttributesEmailAttributesResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionAttributesEmailAttributesResponse unmarshals an instance of SubscriptionAttributesEmailAttributesResponse from the specified map of raw messages.
func UnmarshalSubscriptionAttributesSmsAttributesResponse ¶
func UnmarshalSubscriptionAttributesSmsAttributesResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionAttributesSmsAttributesResponse unmarshals an instance of SubscriptionAttributesSmsAttributesResponse from the specified map of raw messages.
func UnmarshalSubscriptionAttributesWebhookAttributesResponse ¶
func UnmarshalSubscriptionAttributesWebhookAttributesResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionAttributesWebhookAttributesResponse unmarshals an instance of SubscriptionAttributesWebhookAttributesResponse from the specified map of raw messages.
func UnmarshalSubscriptionCreateAttributes ¶
func UnmarshalSubscriptionCreateAttributes(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionCreateAttributes unmarshals an instance of SubscriptionCreateAttributes from the specified map of raw messages.
func UnmarshalSubscriptionCreateAttributesEmailAttributes ¶
func UnmarshalSubscriptionCreateAttributesEmailAttributes(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionCreateAttributesEmailAttributes unmarshals an instance of SubscriptionCreateAttributesEmailAttributes from the specified map of raw messages.
func UnmarshalSubscriptionCreateAttributesSmsAttributes ¶
func UnmarshalSubscriptionCreateAttributesSmsAttributes(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionCreateAttributesSmsAttributes unmarshals an instance of SubscriptionCreateAttributesSmsAttributes from the specified map of raw messages.
func UnmarshalSubscriptionCreateAttributesWebhookAttributes ¶
func UnmarshalSubscriptionCreateAttributesWebhookAttributes(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionCreateAttributesWebhookAttributes unmarshals an instance of SubscriptionCreateAttributesWebhookAttributes from the specified map of raw messages.
func UnmarshalSubscriptionList ¶
func UnmarshalSubscriptionList(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionList unmarshals an instance of SubscriptionList from the specified map of raw messages.
func UnmarshalSubscriptionListItem ¶
func UnmarshalSubscriptionListItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionListItem unmarshals an instance of SubscriptionListItem from the specified map of raw messages.
func UnmarshalSubscriptionUpdateAttributes ¶
func UnmarshalSubscriptionUpdateAttributes(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionUpdateAttributes unmarshals an instance of SubscriptionUpdateAttributes from the specified map of raw messages.
func UnmarshalSubscriptionUpdateAttributesEmailAttributes ¶
func UnmarshalSubscriptionUpdateAttributesEmailAttributes(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionUpdateAttributesEmailAttributes unmarshals an instance of SubscriptionUpdateAttributesEmailAttributes from the specified map of raw messages.
func UnmarshalSubscriptionUpdateAttributesSmsAttributes ¶
func UnmarshalSubscriptionUpdateAttributesSmsAttributes(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionUpdateAttributesSmsAttributes unmarshals an instance of SubscriptionUpdateAttributesSmsAttributes from the specified map of raw messages.
func UnmarshalSubscriptionUpdateAttributesWebhookAttributes ¶
func UnmarshalSubscriptionUpdateAttributesWebhookAttributes(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalSubscriptionUpdateAttributesWebhookAttributes unmarshals an instance of SubscriptionUpdateAttributesWebhookAttributes from the specified map of raw messages.
func UnmarshalTopic ¶
func UnmarshalTopic(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTopic unmarshals an instance of Topic from the specified map of raw messages.
func UnmarshalTopicList ¶
func UnmarshalTopicList(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTopicList unmarshals an instance of TopicList from the specified map of raw messages.
func UnmarshalTopicResponse ¶
func UnmarshalTopicResponse(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTopicResponse unmarshals an instance of TopicResponse from the specified map of raw messages.
func UnmarshalTopicSourcesItem ¶
func UnmarshalTopicSourcesItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTopicSourcesItem unmarshals an instance of TopicSourcesItem from the specified map of raw messages.
func UnmarshalTopicUpdateSourcesItem ¶
func UnmarshalTopicUpdateSourcesItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTopicUpdateSourcesItem unmarshals an instance of TopicUpdateSourcesItem from the specified map of raw messages.
func UnmarshalTopicsListItem ¶
func UnmarshalTopicsListItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalTopicsListItem unmarshals an instance of TopicsListItem from the specified map of raw messages.
Types ¶
type CreateDestinationOptions ¶
type CreateDestinationOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // The Destintion name. Name *string `json:"name" validate:"required"` // The type of Destination Webhook. Type *string `json:"type" validate:"required"` // The Destination description. Description *string `json:"description,omitempty"` // Payload describing a destination configuration. Config *DestinationConfig `json:"config,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateDestinationOptions : The CreateDestination options.
func (*CreateDestinationOptions) SetConfig ¶
func (_options *CreateDestinationOptions) SetConfig(config *DestinationConfig) *CreateDestinationOptions
SetConfig : Allow user to set Config
func (*CreateDestinationOptions) SetDescription ¶
func (_options *CreateDestinationOptions) SetDescription(description string) *CreateDestinationOptions
SetDescription : Allow user to set Description
func (*CreateDestinationOptions) SetHeaders ¶
func (options *CreateDestinationOptions) SetHeaders(param map[string]string) *CreateDestinationOptions
SetHeaders : Allow user to set Headers
func (*CreateDestinationOptions) SetInstanceID ¶
func (_options *CreateDestinationOptions) SetInstanceID(instanceID string) *CreateDestinationOptions
SetInstanceID : Allow user to set InstanceID
func (*CreateDestinationOptions) SetName ¶
func (_options *CreateDestinationOptions) SetName(name string) *CreateDestinationOptions
SetName : Allow user to set Name
func (*CreateDestinationOptions) SetType ¶
func (_options *CreateDestinationOptions) SetType(typeVar string) *CreateDestinationOptions
SetType : Allow user to set Type
type CreateSubscriptionOptions ¶
type CreateSubscriptionOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Subscription name. Name *string `json:"name" validate:"required"` // Destination ID. DestinationID *string `json:"destination_id" validate:"required"` // Topic ID. TopicID *string `json:"topic_id" validate:"required"` Attributes SubscriptionCreateAttributesIntf `json:"attributes" validate:"required"` // Subscription description. Description *string `json:"description,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateSubscriptionOptions : The CreateSubscription options.
func (*CreateSubscriptionOptions) SetAttributes ¶
func (_options *CreateSubscriptionOptions) SetAttributes(attributes SubscriptionCreateAttributesIntf) *CreateSubscriptionOptions
SetAttributes : Allow user to set Attributes
func (*CreateSubscriptionOptions) SetDescription ¶
func (_options *CreateSubscriptionOptions) SetDescription(description string) *CreateSubscriptionOptions
SetDescription : Allow user to set Description
func (*CreateSubscriptionOptions) SetDestinationID ¶
func (_options *CreateSubscriptionOptions) SetDestinationID(destinationID string) *CreateSubscriptionOptions
SetDestinationID : Allow user to set DestinationID
func (*CreateSubscriptionOptions) SetHeaders ¶
func (options *CreateSubscriptionOptions) SetHeaders(param map[string]string) *CreateSubscriptionOptions
SetHeaders : Allow user to set Headers
func (*CreateSubscriptionOptions) SetInstanceID ¶
func (_options *CreateSubscriptionOptions) SetInstanceID(instanceID string) *CreateSubscriptionOptions
SetInstanceID : Allow user to set InstanceID
func (*CreateSubscriptionOptions) SetName ¶
func (_options *CreateSubscriptionOptions) SetName(name string) *CreateSubscriptionOptions
SetName : Allow user to set Name
func (*CreateSubscriptionOptions) SetTopicID ¶
func (_options *CreateSubscriptionOptions) SetTopicID(topicID string) *CreateSubscriptionOptions
SetTopicID : Allow user to set TopicID
type CreateTopicOptions ¶
type CreateTopicOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Name of the topic. Name *string `json:"name" validate:"required"` // Description of the topic. Description *string `json:"description,omitempty"` // List of sources. Sources []TopicUpdateSourcesItem `json:"sources,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateTopicOptions : The CreateTopic options.
func (*CreateTopicOptions) SetDescription ¶
func (_options *CreateTopicOptions) SetDescription(description string) *CreateTopicOptions
SetDescription : Allow user to set Description
func (*CreateTopicOptions) SetHeaders ¶
func (options *CreateTopicOptions) SetHeaders(param map[string]string) *CreateTopicOptions
SetHeaders : Allow user to set Headers
func (*CreateTopicOptions) SetInstanceID ¶
func (_options *CreateTopicOptions) SetInstanceID(instanceID string) *CreateTopicOptions
SetInstanceID : Allow user to set InstanceID
func (*CreateTopicOptions) SetName ¶
func (_options *CreateTopicOptions) SetName(name string) *CreateTopicOptions
SetName : Allow user to set Name
func (*CreateTopicOptions) SetSources ¶
func (_options *CreateTopicOptions) SetSources(sources []TopicUpdateSourcesItem) *CreateTopicOptions
SetSources : Allow user to set Sources
type DeleteDestinationOptions ¶
type DeleteDestinationOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Unique identifier for Destination. ID *string `json:"id" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteDestinationOptions : The DeleteDestination options.
func (*DeleteDestinationOptions) SetHeaders ¶
func (options *DeleteDestinationOptions) SetHeaders(param map[string]string) *DeleteDestinationOptions
SetHeaders : Allow user to set Headers
func (*DeleteDestinationOptions) SetID ¶
func (_options *DeleteDestinationOptions) SetID(id string) *DeleteDestinationOptions
SetID : Allow user to set ID
func (*DeleteDestinationOptions) SetInstanceID ¶
func (_options *DeleteDestinationOptions) SetInstanceID(instanceID string) *DeleteDestinationOptions
SetInstanceID : Allow user to set InstanceID
type DeleteSubscriptionOptions ¶
type DeleteSubscriptionOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Unique identifier for Subscription. ID *string `json:"id" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteSubscriptionOptions : The DeleteSubscription options.
func (*DeleteSubscriptionOptions) SetHeaders ¶
func (options *DeleteSubscriptionOptions) SetHeaders(param map[string]string) *DeleteSubscriptionOptions
SetHeaders : Allow user to set Headers
func (*DeleteSubscriptionOptions) SetID ¶
func (_options *DeleteSubscriptionOptions) SetID(id string) *DeleteSubscriptionOptions
SetID : Allow user to set ID
func (*DeleteSubscriptionOptions) SetInstanceID ¶
func (_options *DeleteSubscriptionOptions) SetInstanceID(instanceID string) *DeleteSubscriptionOptions
SetInstanceID : Allow user to set InstanceID
type DeleteTopicOptions ¶
type DeleteTopicOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Unique identifier for Topic. ID *string `json:"id" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteTopicOptions : The DeleteTopic options.
func (*DeleteTopicOptions) SetHeaders ¶
func (options *DeleteTopicOptions) SetHeaders(param map[string]string) *DeleteTopicOptions
SetHeaders : Allow user to set Headers
func (*DeleteTopicOptions) SetID ¶
func (_options *DeleteTopicOptions) SetID(id string) *DeleteTopicOptions
SetID : Allow user to set ID
func (*DeleteTopicOptions) SetInstanceID ¶
func (_options *DeleteTopicOptions) SetInstanceID(instanceID string) *DeleteTopicOptions
SetInstanceID : Allow user to set InstanceID
type Destination ¶
type Destination struct { // Destination ID. ID *string `json:"id" validate:"required"` // Destination name. Name *string `json:"name" validate:"required"` // Destination description. Description *string `json:"description" validate:"required"` // Destination type Email/SMS/Webhook. Type *string `json:"type" validate:"required"` // Payload describing a destination configuration. Config *DestinationConfig `json:"config,omitempty"` // Last updated time. UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` // Number of subscriptions. SubscriptionCount *int64 `json:"subscription_count" validate:"required"` // List of subscriptions. SubscriptionNames []string `json:"subscription_names" validate:"required"` }
Destination : Payload describing a destination get request.
type DestinationConfig ¶
type DestinationConfig struct {
Params DestinationConfigParamsIntf `json:"params" validate:"required"`
}
DestinationConfig : Payload describing a destination configuration.
type DestinationConfigParams ¶
type DestinationConfigParams struct { // URL of webhook. URL *string `json:"url,omitempty"` // HTTP method of webhook. Verb *string `json:"verb,omitempty"` // Custom headers (Key-Value pair) for webhook call. CustomHeaders map[string]string `json:"custom_headers,omitempty"` // List of sensitive headers from custom headers. SensitiveHeaders []string `json:"sensitive_headers,omitempty"` }
DestinationConfigParams : DestinationConfigParams struct Models which "extend" this model: - DestinationConfigParamsWebhookDestinationConfig
type DestinationConfigParamsIntf ¶
type DestinationConfigParamsIntf interface {
// contains filtered or unexported methods
}
type DestinationConfigParamsWebhookDestinationConfig ¶
type DestinationConfigParamsWebhookDestinationConfig struct { // URL of webhook. URL *string `json:"url" validate:"required"` // HTTP method of webhook. Verb *string `json:"verb" validate:"required"` // Custom headers (Key-Value pair) for webhook call. CustomHeaders map[string]string `json:"custom_headers,omitempty"` // List of sensitive headers from custom headers. SensitiveHeaders []string `json:"sensitive_headers,omitempty"` }
DestinationConfigParamsWebhookDestinationConfig : Payload describing a webhook destination configuration. This model "extends" DestinationConfigParams
type DestinationLisItem ¶
type DestinationLisItem struct { // Destination ID. ID *string `json:"id" validate:"required"` // Destination name. Name *string `json:"name" validate:"required"` // Destination description. Description *string `json:"description" validate:"required"` // Destination type Email/SMS/Webhook. Type *string `json:"type" validate:"required"` // Subscription count. SubscriptionCount *int64 `json:"subscription_count" validate:"required"` // Names of subscriptions. SubscriptionNames []string `json:"subscription_names" validate:"required"` // Updated at. UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` }
DestinationLisItem : Destination object.
type DestinationList ¶
type DestinationList struct { // Total number of destinations. TotalCount *int64 `json:"total_count" validate:"required"` // Current offset. Offset *int64 `json:"offset" validate:"required"` // limit to show destinations. Limit *int64 `json:"limit" validate:"required"` // List of destinations. Destinations []DestinationLisItem `json:"destinations" validate:"required"` }
DestinationList : Payload describing a destination list request.
type DestinationResponse ¶
type DestinationResponse struct { // Destination ID. ID *string `json:"id" validate:"required"` // Destination name. Name *string `json:"name" validate:"required"` // Destination description. Description *string `json:"description" validate:"required"` // Destination type Email/SMS/Webhook. Type *string `json:"type" validate:"required"` // Payload describing a destination configuration. Config *DestinationConfig `json:"config" validate:"required"` // Last updated time. CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"` }
DestinationResponse : Payload describing a destination get request.
type EventNotificationsV1 ¶
type EventNotificationsV1 struct {
Service *core.BaseService
}
EventNotificationsV1 : No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
API Version: 1.0
func NewEventNotificationsV1 ¶
func NewEventNotificationsV1(options *EventNotificationsV1Options) (service *EventNotificationsV1, err error)
NewEventNotificationsV1 : constructs an instance of EventNotificationsV1 with passed in options.
func NewEventNotificationsV1UsingExternalConfig ¶
func NewEventNotificationsV1UsingExternalConfig(options *EventNotificationsV1Options) (eventNotifications *EventNotificationsV1, err error)
NewEventNotificationsV1UsingExternalConfig : constructs an instance of EventNotificationsV1 with passed in options and external configuration.
func (*EventNotificationsV1) Clone ¶
func (eventNotifications *EventNotificationsV1) Clone() *EventNotificationsV1
Clone makes a copy of "eventNotifications" suitable for processing requests.
func (*EventNotificationsV1) CreateDestination ¶
func (eventNotifications *EventNotificationsV1) CreateDestination(createDestinationOptions *CreateDestinationOptions) (result *DestinationResponse, response *core.DetailedResponse, err error)
CreateDestination : Create a new Destination Create a new Destination.
func (*EventNotificationsV1) CreateDestinationWithContext ¶
func (eventNotifications *EventNotificationsV1) CreateDestinationWithContext(ctx context.Context, createDestinationOptions *CreateDestinationOptions) (result *DestinationResponse, response *core.DetailedResponse, err error)
CreateDestinationWithContext is an alternate form of the CreateDestination method which supports a Context parameter
func (*EventNotificationsV1) CreateSubscription ¶
func (eventNotifications *EventNotificationsV1) CreateSubscription(createSubscriptionOptions *CreateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
CreateSubscription : Create a new Subscription Create a new Subscription.
func (*EventNotificationsV1) CreateSubscriptionWithContext ¶
func (eventNotifications *EventNotificationsV1) CreateSubscriptionWithContext(ctx context.Context, createSubscriptionOptions *CreateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
CreateSubscriptionWithContext is an alternate form of the CreateSubscription method which supports a Context parameter
func (*EventNotificationsV1) CreateTopic ¶
func (eventNotifications *EventNotificationsV1) CreateTopic(createTopicOptions *CreateTopicOptions) (result *TopicResponse, response *core.DetailedResponse, err error)
CreateTopic : Create a new Topic Create a new Topic.
func (*EventNotificationsV1) CreateTopicWithContext ¶
func (eventNotifications *EventNotificationsV1) CreateTopicWithContext(ctx context.Context, createTopicOptions *CreateTopicOptions) (result *TopicResponse, response *core.DetailedResponse, err error)
CreateTopicWithContext is an alternate form of the CreateTopic method which supports a Context parameter
func (*EventNotificationsV1) DeleteDestination ¶
func (eventNotifications *EventNotificationsV1) DeleteDestination(deleteDestinationOptions *DeleteDestinationOptions) (response *core.DetailedResponse, err error)
DeleteDestination : Delete a Destination Delete a Destination.
func (*EventNotificationsV1) DeleteDestinationWithContext ¶
func (eventNotifications *EventNotificationsV1) DeleteDestinationWithContext(ctx context.Context, deleteDestinationOptions *DeleteDestinationOptions) (response *core.DetailedResponse, err error)
DeleteDestinationWithContext is an alternate form of the DeleteDestination method which supports a Context parameter
func (*EventNotificationsV1) DeleteSubscription ¶
func (eventNotifications *EventNotificationsV1) DeleteSubscription(deleteSubscriptionOptions *DeleteSubscriptionOptions) (response *core.DetailedResponse, err error)
DeleteSubscription : Delete a Subscription Delete a Subscription.
func (*EventNotificationsV1) DeleteSubscriptionWithContext ¶
func (eventNotifications *EventNotificationsV1) DeleteSubscriptionWithContext(ctx context.Context, deleteSubscriptionOptions *DeleteSubscriptionOptions) (response *core.DetailedResponse, err error)
DeleteSubscriptionWithContext is an alternate form of the DeleteSubscription method which supports a Context parameter
func (*EventNotificationsV1) DeleteTopic ¶
func (eventNotifications *EventNotificationsV1) DeleteTopic(deleteTopicOptions *DeleteTopicOptions) (response *core.DetailedResponse, err error)
DeleteTopic : Delete a Topic Delete a Topic.
func (*EventNotificationsV1) DeleteTopicWithContext ¶
func (eventNotifications *EventNotificationsV1) DeleteTopicWithContext(ctx context.Context, deleteTopicOptions *DeleteTopicOptions) (response *core.DetailedResponse, err error)
DeleteTopicWithContext is an alternate form of the DeleteTopic method which supports a Context parameter
func (*EventNotificationsV1) DisableRetries ¶
func (eventNotifications *EventNotificationsV1) DisableRetries()
DisableRetries disables automatic retries for requests invoked for this service instance.
func (*EventNotificationsV1) EnableRetries ¶
func (eventNotifications *EventNotificationsV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.
func (*EventNotificationsV1) GetDestination ¶
func (eventNotifications *EventNotificationsV1) GetDestination(getDestinationOptions *GetDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)
GetDestination : Get details of a Destination Get details of a Destination.
func (*EventNotificationsV1) GetDestinationWithContext ¶
func (eventNotifications *EventNotificationsV1) GetDestinationWithContext(ctx context.Context, getDestinationOptions *GetDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)
GetDestinationWithContext is an alternate form of the GetDestination method which supports a Context parameter
func (*EventNotificationsV1) GetEnableGzipCompression ¶
func (eventNotifications *EventNotificationsV1) GetEnableGzipCompression() bool
GetEnableGzipCompression returns the service's EnableGzipCompression field
func (*EventNotificationsV1) GetServiceURL ¶
func (eventNotifications *EventNotificationsV1) GetServiceURL() string
GetServiceURL returns the service URL
func (*EventNotificationsV1) GetSource ¶
func (eventNotifications *EventNotificationsV1) GetSource(getSourceOptions *GetSourceOptions) (result *Source, response *core.DetailedResponse, err error)
GetSource : Get a Source Get a Sources.
func (*EventNotificationsV1) GetSourceWithContext ¶
func (eventNotifications *EventNotificationsV1) GetSourceWithContext(ctx context.Context, getSourceOptions *GetSourceOptions) (result *Source, response *core.DetailedResponse, err error)
GetSourceWithContext is an alternate form of the GetSource method which supports a Context parameter
func (*EventNotificationsV1) GetSubscription ¶
func (eventNotifications *EventNotificationsV1) GetSubscription(getSubscriptionOptions *GetSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
GetSubscription : Get details of a Subscription Get details of a Subscription.
func (*EventNotificationsV1) GetSubscriptionWithContext ¶
func (eventNotifications *EventNotificationsV1) GetSubscriptionWithContext(ctx context.Context, getSubscriptionOptions *GetSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
GetSubscriptionWithContext is an alternate form of the GetSubscription method which supports a Context parameter
func (*EventNotificationsV1) GetTopic ¶
func (eventNotifications *EventNotificationsV1) GetTopic(getTopicOptions *GetTopicOptions) (result *Topic, response *core.DetailedResponse, err error)
GetTopic : Get details of a Topic Get details of a Topic.
func (*EventNotificationsV1) GetTopicWithContext ¶
func (eventNotifications *EventNotificationsV1) GetTopicWithContext(ctx context.Context, getTopicOptions *GetTopicOptions) (result *Topic, response *core.DetailedResponse, err error)
GetTopicWithContext is an alternate form of the GetTopic method which supports a Context parameter
func (*EventNotificationsV1) ListDestinations ¶
func (eventNotifications *EventNotificationsV1) ListDestinations(listDestinationsOptions *ListDestinationsOptions) (result *DestinationList, response *core.DetailedResponse, err error)
ListDestinations : List all Destinations List all Destinations.
func (*EventNotificationsV1) ListDestinationsWithContext ¶
func (eventNotifications *EventNotificationsV1) ListDestinationsWithContext(ctx context.Context, listDestinationsOptions *ListDestinationsOptions) (result *DestinationList, response *core.DetailedResponse, err error)
ListDestinationsWithContext is an alternate form of the ListDestinations method which supports a Context parameter
func (*EventNotificationsV1) ListSources ¶
func (eventNotifications *EventNotificationsV1) ListSources(listSourcesOptions *ListSourcesOptions) (result *SourceList, response *core.DetailedResponse, err error)
ListSources : List all Sources List all Sources.
func (*EventNotificationsV1) ListSourcesWithContext ¶
func (eventNotifications *EventNotificationsV1) ListSourcesWithContext(ctx context.Context, listSourcesOptions *ListSourcesOptions) (result *SourceList, response *core.DetailedResponse, err error)
ListSourcesWithContext is an alternate form of the ListSources method which supports a Context parameter
func (*EventNotificationsV1) ListSubscriptions ¶
func (eventNotifications *EventNotificationsV1) ListSubscriptions(listSubscriptionsOptions *ListSubscriptionsOptions) (result *SubscriptionList, response *core.DetailedResponse, err error)
ListSubscriptions : List all Subscriptions List all Subscriptions.
func (*EventNotificationsV1) ListSubscriptionsWithContext ¶
func (eventNotifications *EventNotificationsV1) ListSubscriptionsWithContext(ctx context.Context, listSubscriptionsOptions *ListSubscriptionsOptions) (result *SubscriptionList, response *core.DetailedResponse, err error)
ListSubscriptionsWithContext is an alternate form of the ListSubscriptions method which supports a Context parameter
func (*EventNotificationsV1) ListTopics ¶
func (eventNotifications *EventNotificationsV1) ListTopics(listTopicsOptions *ListTopicsOptions) (result *TopicList, response *core.DetailedResponse, err error)
ListTopics : List all Topics List all Topics.
func (*EventNotificationsV1) ListTopicsWithContext ¶
func (eventNotifications *EventNotificationsV1) ListTopicsWithContext(ctx context.Context, listTopicsOptions *ListTopicsOptions) (result *TopicList, response *core.DetailedResponse, err error)
ListTopicsWithContext is an alternate form of the ListTopics method which supports a Context parameter
func (*EventNotificationsV1) NewCreateDestinationOptions ¶
func (*EventNotificationsV1) NewCreateDestinationOptions(instanceID string, name string, typeVar string) *CreateDestinationOptions
NewCreateDestinationOptions : Instantiate CreateDestinationOptions
func (*EventNotificationsV1) NewCreateSubscriptionOptions ¶
func (*EventNotificationsV1) NewCreateSubscriptionOptions(instanceID string, name string, destinationID string, topicID string, attributes SubscriptionCreateAttributesIntf) *CreateSubscriptionOptions
NewCreateSubscriptionOptions : Instantiate CreateSubscriptionOptions
func (*EventNotificationsV1) NewCreateTopicOptions ¶
func (*EventNotificationsV1) NewCreateTopicOptions(instanceID string, name string) *CreateTopicOptions
NewCreateTopicOptions : Instantiate CreateTopicOptions
func (*EventNotificationsV1) NewDeleteDestinationOptions ¶
func (*EventNotificationsV1) NewDeleteDestinationOptions(instanceID string, id string) *DeleteDestinationOptions
NewDeleteDestinationOptions : Instantiate DeleteDestinationOptions
func (*EventNotificationsV1) NewDeleteSubscriptionOptions ¶
func (*EventNotificationsV1) NewDeleteSubscriptionOptions(instanceID string, id string) *DeleteSubscriptionOptions
NewDeleteSubscriptionOptions : Instantiate DeleteSubscriptionOptions
func (*EventNotificationsV1) NewDeleteTopicOptions ¶
func (*EventNotificationsV1) NewDeleteTopicOptions(instanceID string, id string) *DeleteTopicOptions
NewDeleteTopicOptions : Instantiate DeleteTopicOptions
func (*EventNotificationsV1) NewDestinationConfig ¶
func (*EventNotificationsV1) NewDestinationConfig(params DestinationConfigParamsIntf) (_model *DestinationConfig, err error)
NewDestinationConfig : Instantiate DestinationConfig (Generic Model Constructor)
func (*EventNotificationsV1) NewDestinationConfigParamsWebhookDestinationConfig ¶
func (*EventNotificationsV1) NewDestinationConfigParamsWebhookDestinationConfig(url string, verb string) (_model *DestinationConfigParamsWebhookDestinationConfig, err error)
NewDestinationConfigParamsWebhookDestinationConfig : Instantiate DestinationConfigParamsWebhookDestinationConfig (Generic Model Constructor)
func (*EventNotificationsV1) NewGetDestinationOptions ¶
func (*EventNotificationsV1) NewGetDestinationOptions(instanceID string, id string) *GetDestinationOptions
NewGetDestinationOptions : Instantiate GetDestinationOptions
func (*EventNotificationsV1) NewGetSourceOptions ¶
func (*EventNotificationsV1) NewGetSourceOptions(instanceID string, id string) *GetSourceOptions
NewGetSourceOptions : Instantiate GetSourceOptions
func (*EventNotificationsV1) NewGetSubscriptionOptions ¶
func (*EventNotificationsV1) NewGetSubscriptionOptions(instanceID string, id string) *GetSubscriptionOptions
NewGetSubscriptionOptions : Instantiate GetSubscriptionOptions
func (*EventNotificationsV1) NewGetTopicOptions ¶
func (*EventNotificationsV1) NewGetTopicOptions(instanceID string, id string) *GetTopicOptions
NewGetTopicOptions : Instantiate GetTopicOptions
func (*EventNotificationsV1) NewListDestinationsOptions ¶
func (*EventNotificationsV1) NewListDestinationsOptions(instanceID string) *ListDestinationsOptions
NewListDestinationsOptions : Instantiate ListDestinationsOptions
func (*EventNotificationsV1) NewListSourcesOptions ¶
func (*EventNotificationsV1) NewListSourcesOptions(instanceID string) *ListSourcesOptions
NewListSourcesOptions : Instantiate ListSourcesOptions
func (*EventNotificationsV1) NewListSubscriptionsOptions ¶
func (*EventNotificationsV1) NewListSubscriptionsOptions(instanceID string) *ListSubscriptionsOptions
NewListSubscriptionsOptions : Instantiate ListSubscriptionsOptions
func (*EventNotificationsV1) NewListTopicsOptions ¶
func (*EventNotificationsV1) NewListTopicsOptions(instanceID string) *ListTopicsOptions
NewListTopicsOptions : Instantiate ListTopicsOptions
func (*EventNotificationsV1) NewReplaceTopicOptions ¶
func (*EventNotificationsV1) NewReplaceTopicOptions(instanceID string, id string) *ReplaceTopicOptions
NewReplaceTopicOptions : Instantiate ReplaceTopicOptions
func (*EventNotificationsV1) NewRules ¶
func (*EventNotificationsV1) NewRules(eventTypeFilter string) (_model *Rules, err error)
NewRules : Instantiate Rules (Generic Model Constructor)
func (*EventNotificationsV1) NewSubscriptionCreateAttributesEmailAttributes ¶
func (*EventNotificationsV1) NewSubscriptionCreateAttributesEmailAttributes(to []string, addNotificationPayload bool) (_model *SubscriptionCreateAttributesEmailAttributes, err error)
NewSubscriptionCreateAttributesEmailAttributes : Instantiate SubscriptionCreateAttributesEmailAttributes (Generic Model Constructor)
func (*EventNotificationsV1) NewSubscriptionCreateAttributesSmsAttributes ¶
func (*EventNotificationsV1) NewSubscriptionCreateAttributesSmsAttributes(to []string) (_model *SubscriptionCreateAttributesSmsAttributes, err error)
NewSubscriptionCreateAttributesSmsAttributes : Instantiate SubscriptionCreateAttributesSmsAttributes (Generic Model Constructor)
func (*EventNotificationsV1) NewSubscriptionCreateAttributesWebhookAttributes ¶
func (*EventNotificationsV1) NewSubscriptionCreateAttributesWebhookAttributes(signingEnabled bool) (_model *SubscriptionCreateAttributesWebhookAttributes, err error)
NewSubscriptionCreateAttributesWebhookAttributes : Instantiate SubscriptionCreateAttributesWebhookAttributes (Generic Model Constructor)
func (*EventNotificationsV1) NewSubscriptionUpdateAttributesEmailAttributes ¶
func (*EventNotificationsV1) NewSubscriptionUpdateAttributesEmailAttributes(to []string, addNotificationPayload bool) (_model *SubscriptionUpdateAttributesEmailAttributes, err error)
NewSubscriptionUpdateAttributesEmailAttributes : Instantiate SubscriptionUpdateAttributesEmailAttributes (Generic Model Constructor)
func (*EventNotificationsV1) NewSubscriptionUpdateAttributesSmsAttributes ¶
func (*EventNotificationsV1) NewSubscriptionUpdateAttributesSmsAttributes(to []string) (_model *SubscriptionUpdateAttributesSmsAttributes, err error)
NewSubscriptionUpdateAttributesSmsAttributes : Instantiate SubscriptionUpdateAttributesSmsAttributes (Generic Model Constructor)
func (*EventNotificationsV1) NewSubscriptionUpdateAttributesWebhookAttributes ¶
func (*EventNotificationsV1) NewSubscriptionUpdateAttributesWebhookAttributes(signingEnabled bool) (_model *SubscriptionUpdateAttributesWebhookAttributes, err error)
NewSubscriptionUpdateAttributesWebhookAttributes : Instantiate SubscriptionUpdateAttributesWebhookAttributes (Generic Model Constructor)
func (*EventNotificationsV1) NewTopicUpdateSourcesItem ¶
func (*EventNotificationsV1) NewTopicUpdateSourcesItem(id string, rules []Rules) (_model *TopicUpdateSourcesItem, err error)
NewTopicUpdateSourcesItem : Instantiate TopicUpdateSourcesItem (Generic Model Constructor)
func (*EventNotificationsV1) NewUpdateDestinationOptions ¶
func (*EventNotificationsV1) NewUpdateDestinationOptions(instanceID string, id string) *UpdateDestinationOptions
NewUpdateDestinationOptions : Instantiate UpdateDestinationOptions
func (*EventNotificationsV1) NewUpdateSubscriptionOptions ¶
func (*EventNotificationsV1) NewUpdateSubscriptionOptions(instanceID string, id string) *UpdateSubscriptionOptions
NewUpdateSubscriptionOptions : Instantiate UpdateSubscriptionOptions
func (*EventNotificationsV1) ReplaceTopic ¶
func (eventNotifications *EventNotificationsV1) ReplaceTopic(replaceTopicOptions *ReplaceTopicOptions) (result *Topic, response *core.DetailedResponse, err error)
ReplaceTopic : Update details of a Topic Update details of a Topic.
func (*EventNotificationsV1) ReplaceTopicWithContext ¶
func (eventNotifications *EventNotificationsV1) ReplaceTopicWithContext(ctx context.Context, replaceTopicOptions *ReplaceTopicOptions) (result *Topic, response *core.DetailedResponse, err error)
ReplaceTopicWithContext is an alternate form of the ReplaceTopic method which supports a Context parameter
func (*EventNotificationsV1) SetDefaultHeaders ¶
func (eventNotifications *EventNotificationsV1) SetDefaultHeaders(headers http.Header)
SetDefaultHeaders sets HTTP headers to be sent in every request
func (*EventNotificationsV1) SetEnableGzipCompression ¶
func (eventNotifications *EventNotificationsV1) SetEnableGzipCompression(enableGzip bool)
SetEnableGzipCompression sets the service's EnableGzipCompression field
func (*EventNotificationsV1) SetServiceURL ¶
func (eventNotifications *EventNotificationsV1) SetServiceURL(url string) error
SetServiceURL sets the service URL
func (*EventNotificationsV1) UpdateDestination ¶
func (eventNotifications *EventNotificationsV1) UpdateDestination(updateDestinationOptions *UpdateDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)
UpdateDestination : Update details of a Destination Update details of a Destination.
func (*EventNotificationsV1) UpdateDestinationWithContext ¶
func (eventNotifications *EventNotificationsV1) UpdateDestinationWithContext(ctx context.Context, updateDestinationOptions *UpdateDestinationOptions) (result *Destination, response *core.DetailedResponse, err error)
UpdateDestinationWithContext is an alternate form of the UpdateDestination method which supports a Context parameter
func (*EventNotificationsV1) UpdateSubscription ¶
func (eventNotifications *EventNotificationsV1) UpdateSubscription(updateSubscriptionOptions *UpdateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
UpdateSubscription : Update details of a Subscription Update details of a Subscription.
func (*EventNotificationsV1) UpdateSubscriptionWithContext ¶
func (eventNotifications *EventNotificationsV1) UpdateSubscriptionWithContext(ctx context.Context, updateSubscriptionOptions *UpdateSubscriptionOptions) (result *Subscription, response *core.DetailedResponse, err error)
UpdateSubscriptionWithContext is an alternate form of the UpdateSubscription method which supports a Context parameter
type EventNotificationsV1Options ¶
type EventNotificationsV1Options struct { ServiceName string URL string Authenticator core.Authenticator }
EventNotificationsV1Options : Service options
type GetDestinationOptions ¶
type GetDestinationOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Unique identifier for Destination. ID *string `json:"id" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetDestinationOptions : The GetDestination options.
func (*GetDestinationOptions) SetHeaders ¶
func (options *GetDestinationOptions) SetHeaders(param map[string]string) *GetDestinationOptions
SetHeaders : Allow user to set Headers
func (*GetDestinationOptions) SetID ¶
func (_options *GetDestinationOptions) SetID(id string) *GetDestinationOptions
SetID : Allow user to set ID
func (*GetDestinationOptions) SetInstanceID ¶
func (_options *GetDestinationOptions) SetInstanceID(instanceID string) *GetDestinationOptions
SetInstanceID : Allow user to set InstanceID
type GetSourceOptions ¶
type GetSourceOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Unique identifier for Source. ID *string `json:"id" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetSourceOptions : The GetSource options.
func (*GetSourceOptions) SetHeaders ¶
func (options *GetSourceOptions) SetHeaders(param map[string]string) *GetSourceOptions
SetHeaders : Allow user to set Headers
func (*GetSourceOptions) SetID ¶
func (_options *GetSourceOptions) SetID(id string) *GetSourceOptions
SetID : Allow user to set ID
func (*GetSourceOptions) SetInstanceID ¶
func (_options *GetSourceOptions) SetInstanceID(instanceID string) *GetSourceOptions
SetInstanceID : Allow user to set InstanceID
type GetSubscriptionOptions ¶
type GetSubscriptionOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Unique identifier for Subscription. ID *string `json:"id" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetSubscriptionOptions : The GetSubscription options.
func (*GetSubscriptionOptions) SetHeaders ¶
func (options *GetSubscriptionOptions) SetHeaders(param map[string]string) *GetSubscriptionOptions
SetHeaders : Allow user to set Headers
func (*GetSubscriptionOptions) SetID ¶
func (_options *GetSubscriptionOptions) SetID(id string) *GetSubscriptionOptions
SetID : Allow user to set ID
func (*GetSubscriptionOptions) SetInstanceID ¶
func (_options *GetSubscriptionOptions) SetInstanceID(instanceID string) *GetSubscriptionOptions
SetInstanceID : Allow user to set InstanceID
type GetTopicOptions ¶
type GetTopicOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Unique identifier for Topic. ID *string `json:"id" validate:"required,ne="` // Include sub topics. Include *string `json:"include,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
GetTopicOptions : The GetTopic options.
func (*GetTopicOptions) SetHeaders ¶
func (options *GetTopicOptions) SetHeaders(param map[string]string) *GetTopicOptions
SetHeaders : Allow user to set Headers
func (*GetTopicOptions) SetID ¶
func (_options *GetTopicOptions) SetID(id string) *GetTopicOptions
SetID : Allow user to set ID
func (*GetTopicOptions) SetInclude ¶
func (_options *GetTopicOptions) SetInclude(include string) *GetTopicOptions
SetInclude : Allow user to set Include
func (*GetTopicOptions) SetInstanceID ¶
func (_options *GetTopicOptions) SetInstanceID(instanceID string) *GetTopicOptions
SetInstanceID : Allow user to set InstanceID
type ListDestinationsOptions ¶
type ListDestinationsOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Page limit for paginated results. Limit *int64 `json:"limit,omitempty"` // offset for paginated results. Offset *int64 `json:"offset,omitempty"` // Search string for filtering results. Search *string `json:"search,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
ListDestinationsOptions : The ListDestinations options.
func (*ListDestinationsOptions) SetHeaders ¶
func (options *ListDestinationsOptions) SetHeaders(param map[string]string) *ListDestinationsOptions
SetHeaders : Allow user to set Headers
func (*ListDestinationsOptions) SetInstanceID ¶
func (_options *ListDestinationsOptions) SetInstanceID(instanceID string) *ListDestinationsOptions
SetInstanceID : Allow user to set InstanceID
func (*ListDestinationsOptions) SetLimit ¶
func (_options *ListDestinationsOptions) SetLimit(limit int64) *ListDestinationsOptions
SetLimit : Allow user to set Limit
func (*ListDestinationsOptions) SetOffset ¶
func (_options *ListDestinationsOptions) SetOffset(offset int64) *ListDestinationsOptions
SetOffset : Allow user to set Offset
func (*ListDestinationsOptions) SetSearch ¶
func (_options *ListDestinationsOptions) SetSearch(search string) *ListDestinationsOptions
SetSearch : Allow user to set Search
type ListSourcesOptions ¶
type ListSourcesOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Page limit for paginated results. Limit *int64 `json:"limit,omitempty"` // offset for paginated results. Offset *int64 `json:"offset,omitempty"` // Search string for filtering results. Search *string `json:"search,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
ListSourcesOptions : The ListSources options.
func (*ListSourcesOptions) SetHeaders ¶
func (options *ListSourcesOptions) SetHeaders(param map[string]string) *ListSourcesOptions
SetHeaders : Allow user to set Headers
func (*ListSourcesOptions) SetInstanceID ¶
func (_options *ListSourcesOptions) SetInstanceID(instanceID string) *ListSourcesOptions
SetInstanceID : Allow user to set InstanceID
func (*ListSourcesOptions) SetLimit ¶
func (_options *ListSourcesOptions) SetLimit(limit int64) *ListSourcesOptions
SetLimit : Allow user to set Limit
func (*ListSourcesOptions) SetOffset ¶
func (_options *ListSourcesOptions) SetOffset(offset int64) *ListSourcesOptions
SetOffset : Allow user to set Offset
func (*ListSourcesOptions) SetSearch ¶
func (_options *ListSourcesOptions) SetSearch(search string) *ListSourcesOptions
SetSearch : Allow user to set Search
type ListSubscriptionsOptions ¶
type ListSubscriptionsOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // offset for paginated results. Offset *int64 `json:"offset,omitempty"` // Page limit for paginated results. Limit *int64 `json:"limit,omitempty"` // Search string for filtering results. Search *string `json:"search,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
ListSubscriptionsOptions : The ListSubscriptions options.
func (*ListSubscriptionsOptions) SetHeaders ¶
func (options *ListSubscriptionsOptions) SetHeaders(param map[string]string) *ListSubscriptionsOptions
SetHeaders : Allow user to set Headers
func (*ListSubscriptionsOptions) SetInstanceID ¶
func (_options *ListSubscriptionsOptions) SetInstanceID(instanceID string) *ListSubscriptionsOptions
SetInstanceID : Allow user to set InstanceID
func (*ListSubscriptionsOptions) SetLimit ¶
func (_options *ListSubscriptionsOptions) SetLimit(limit int64) *ListSubscriptionsOptions
SetLimit : Allow user to set Limit
func (*ListSubscriptionsOptions) SetOffset ¶
func (_options *ListSubscriptionsOptions) SetOffset(offset int64) *ListSubscriptionsOptions
SetOffset : Allow user to set Offset
func (*ListSubscriptionsOptions) SetSearch ¶
func (_options *ListSubscriptionsOptions) SetSearch(search string) *ListSubscriptionsOptions
SetSearch : Allow user to set Search
type ListTopicsOptions ¶
type ListTopicsOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Page limit for paginated results. Limit *int64 `json:"limit,omitempty"` // offset for paginated results. Offset *int64 `json:"offset,omitempty"` // Search string for filtering results. Search *string `json:"search,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
ListTopicsOptions : The ListTopics options.
func (*ListTopicsOptions) SetHeaders ¶
func (options *ListTopicsOptions) SetHeaders(param map[string]string) *ListTopicsOptions
SetHeaders : Allow user to set Headers
func (*ListTopicsOptions) SetInstanceID ¶
func (_options *ListTopicsOptions) SetInstanceID(instanceID string) *ListTopicsOptions
SetInstanceID : Allow user to set InstanceID
func (*ListTopicsOptions) SetLimit ¶
func (_options *ListTopicsOptions) SetLimit(limit int64) *ListTopicsOptions
SetLimit : Allow user to set Limit
func (*ListTopicsOptions) SetOffset ¶
func (_options *ListTopicsOptions) SetOffset(offset int64) *ListTopicsOptions
SetOffset : Allow user to set Offset
func (*ListTopicsOptions) SetSearch ¶
func (_options *ListTopicsOptions) SetSearch(search string) *ListTopicsOptions
SetSearch : Allow user to set Search
type ReplaceTopicOptions ¶
type ReplaceTopicOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Unique identifier for Topic. ID *string `json:"id" validate:"required,ne="` // Name of the topic. Name *string `json:"name,omitempty"` // Description of the topic. Description *string `json:"description,omitempty"` // List of sources. Sources []TopicUpdateSourcesItem `json:"sources,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
ReplaceTopicOptions : The ReplaceTopic options.
func (*ReplaceTopicOptions) SetDescription ¶
func (_options *ReplaceTopicOptions) SetDescription(description string) *ReplaceTopicOptions
SetDescription : Allow user to set Description
func (*ReplaceTopicOptions) SetHeaders ¶
func (options *ReplaceTopicOptions) SetHeaders(param map[string]string) *ReplaceTopicOptions
SetHeaders : Allow user to set Headers
func (*ReplaceTopicOptions) SetID ¶
func (_options *ReplaceTopicOptions) SetID(id string) *ReplaceTopicOptions
SetID : Allow user to set ID
func (*ReplaceTopicOptions) SetInstanceID ¶
func (_options *ReplaceTopicOptions) SetInstanceID(instanceID string) *ReplaceTopicOptions
SetInstanceID : Allow user to set InstanceID
func (*ReplaceTopicOptions) SetName ¶
func (_options *ReplaceTopicOptions) SetName(name string) *ReplaceTopicOptions
SetName : Allow user to set Name
func (*ReplaceTopicOptions) SetSources ¶
func (_options *ReplaceTopicOptions) SetSources(sources []TopicUpdateSourcesItem) *ReplaceTopicOptions
SetSources : Allow user to set Sources
type Rules ¶
type Rules struct { // Whether the rule is enabled or not. Enabled *bool `json:"enabled,omitempty"` // Event type filter. EventTypeFilter *string `json:"event_type_filter" validate:"required"` // Notification filter. NotificationFilter *string `json:"notification_filter,omitempty"` }
Rules : Rule object.
type RulesGet ¶
type RulesGet struct { // Whether the rule is enabled or not. Enabled *bool `json:"enabled" validate:"required"` // Event type filter. EventTypeFilter *string `json:"event_type_filter" validate:"required"` // Notification filter. NotificationFilter *string `json:"notification_filter" validate:"required"` // Last time the topic was updated. UpdatedAt *string `json:"updated_at" validate:"required"` // Autogenerated rule ID. ID *string `json:"id" validate:"required"` }
RulesGet : Rule object.
type Source ¶
type Source struct { // The id of the source. ID *string `json:"id" validate:"required"` // The name of the source. Name *string `json:"name" validate:"required"` // The description of the source. Description *string `json:"description" validate:"required"` // The status of the source. Enabled *bool `json:"enabled" validate:"required"` // Type of the source. Type *string `json:"type" validate:"required"` // The last updated time of the source. UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` // The number of topics. TopicCount *int64 `json:"topic_count" validate:"required"` // The names of the topics. TopicNames []string `json:"topic_names" validate:"required"` }
Source : Payload describing a source generate request.
type SourceList ¶
type SourceList struct { // Number of sources. TotalCount *int64 `json:"total_count" validate:"required"` // Current offset. Offset *int64 `json:"offset" validate:"required"` // limit to show sources. Limit *int64 `json:"limit" validate:"required"` // List of sources. Sources []SourcesListItem `json:"sources" validate:"required"` }
SourceList : Payload describing a source list request.
type SourcesListItem ¶
type SourcesListItem struct { // ID of the source. ID *string `json:"id" validate:"required"` // Name of the source. Name *string `json:"name" validate:"required"` // Description of the source. Description *string `json:"description" validate:"required"` // Type of the source. Type *string `json:"type" validate:"required"` // Whether the source is enabled or not. Enabled *bool `json:"enabled" validate:"required"` // Time of the last update. UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` // Number of topics. TopicCount *int64 `json:"topic_count" validate:"required"` }
SourcesListItem : Payload describing a source list item.
type Subscription ¶
type Subscription struct { // Subscription ID. ID *string `json:"id" validate:"required"` // Subscription name. Name *string `json:"name" validate:"required"` // Subscription description. Description *string `json:"description" validate:"required"` // Last updated time. UpdatedAt *string `json:"updated_at" validate:"required"` // From Email ID (it will be displayed only in case of smtp_ibm destination type). From *string `json:"from,omitempty"` // The type of destination. DestinationType *string `json:"destination_type" validate:"required"` // The destination ID. DestinationID *string `json:"destination_id" validate:"required"` // The destination name. DestinationName *string `json:"destination_name" validate:"required"` // Topic ID. TopicID *string `json:"topic_id" validate:"required"` // Topic name. TopicName *string `json:"topic_name" validate:"required"` Attributes SubscriptionAttributesIntf `json:"attributes" validate:"required"` // contains filtered or unexported fields }
Subscription : Subscription object.
func (*Subscription) GetProperties ¶
func (o *Subscription) GetProperties() map[string]interface{}
GetProperties allows the user to retrieve the map of arbitrary properties from an instance of Subscription
func (*Subscription) GetProperty ¶
func (o *Subscription) GetProperty(key string) interface{}
GetProperty allows the user to retrieve an arbitrary property from an instance of Subscription
func (*Subscription) MarshalJSON ¶
func (o *Subscription) MarshalJSON() (buffer []byte, err error)
MarshalJSON performs custom serialization for instances of Subscription
func (*Subscription) SetProperties ¶
func (o *Subscription) SetProperties(m map[string]interface{})
SetProperties allows the user to set a map of arbitrary properties on an instance of Subscription
func (*Subscription) SetProperty ¶
func (o *Subscription) SetProperty(key string, value interface{})
SetProperty allows the user to set an arbitrary property on an instance of Subscription
type SubscriptionAttributes ¶
type SubscriptionAttributes struct { // The phone number to send the SMS to. To []string `json:"to,omitempty"` // The recipient selection method. RecipientSelection *string `json:"recipient_selection,omitempty"` // Whether to add the notification payload to the email. AddNotificationPayload *bool `json:"add_notification_payload,omitempty"` // The email address to reply to. ReplyTo *string `json:"reply_to,omitempty"` // Signing webhook attributes. SigningEnabled *bool `json:"signing_enabled,omitempty"` }
SubscriptionAttributes : SubscriptionAttributes struct Models which "extend" this model: - SubscriptionAttributesSmsAttributesResponse - SubscriptionAttributesEmailAttributesResponse - SubscriptionAttributesWebhookAttributesResponse
type SubscriptionAttributesEmailAttributesResponse ¶
type SubscriptionAttributesEmailAttributesResponse struct { // The email id string. To []string `json:"to" validate:"required"` // Whether to add the notification payload to the email. AddNotificationPayload *bool `json:"add_notification_payload" validate:"required"` // The email address to reply to. ReplyTo *string `json:"reply_to" validate:"required"` // The recipient selection method. RecipientSelection *string `json:"recipient_selection" validate:"required"` }
SubscriptionAttributesEmailAttributesResponse : The attributes for an email notification. This model "extends" SubscriptionAttributes
type SubscriptionAttributesIntf ¶
type SubscriptionAttributesIntf interface {
// contains filtered or unexported methods
}
type SubscriptionAttributesSmsAttributesResponse ¶
type SubscriptionAttributesSmsAttributesResponse struct { // The phone number to send the SMS to. To []string `json:"to" validate:"required"` // The recipient selection method. RecipientSelection *string `json:"recipient_selection" validate:"required"` }
SubscriptionAttributesSmsAttributesResponse : SMS attributes object. This model "extends" SubscriptionAttributes
type SubscriptionAttributesWebhookAttributesResponse ¶
type SubscriptionAttributesWebhookAttributesResponse struct { // Signing webhook attributes. SigningEnabled *bool `json:"signing_enabled" validate:"required"` // Decision for Notification Payload to be added. AddNotificationPayload *bool `json:"add_notification_payload" validate:"required"` }
SubscriptionAttributesWebhookAttributesResponse : The attributes for a webhook notification. This model "extends" SubscriptionAttributes
type SubscriptionCreateAttributes ¶
type SubscriptionCreateAttributes struct { // The phone number to send the SMS to. To []string `json:"to,omitempty"` // Whether to add the notification payload to the email. AddNotificationPayload *bool `json:"add_notification_payload,omitempty"` // The email address to reply to. ReplyTo *string `json:"reply_to,omitempty"` // Signing webhook attributes. SigningEnabled *bool `json:"signing_enabled,omitempty"` }
SubscriptionCreateAttributes : SubscriptionCreateAttributes struct Models which "extend" this model: - SubscriptionCreateAttributesSmsAttributes - SubscriptionCreateAttributesEmailAttributes - SubscriptionCreateAttributesWebhookAttributes
type SubscriptionCreateAttributesEmailAttributes ¶
type SubscriptionCreateAttributesEmailAttributes struct { // The email id string. To []string `json:"to" validate:"required"` // Whether to add the notification payload to the email. AddNotificationPayload *bool `json:"add_notification_payload" validate:"required"` // The email address to reply to. ReplyTo *string `json:"reply_to,omitempty"` }
SubscriptionCreateAttributesEmailAttributes : The attributes for an email notification. This model "extends" SubscriptionCreateAttributes
type SubscriptionCreateAttributesIntf ¶
type SubscriptionCreateAttributesIntf interface {
// contains filtered or unexported methods
}
type SubscriptionCreateAttributesSmsAttributes ¶
type SubscriptionCreateAttributesSmsAttributes struct { // The phone number to send the SMS to. To []string `json:"to" validate:"required"` }
SubscriptionCreateAttributesSmsAttributes : SMS attributes object. This model "extends" SubscriptionCreateAttributes
type SubscriptionCreateAttributesWebhookAttributes ¶
type SubscriptionCreateAttributesWebhookAttributes struct { // Signing webhook attributes. SigningEnabled *bool `json:"signing_enabled" validate:"required"` }
SubscriptionCreateAttributesWebhookAttributes : The attributes for a webhook notification. This model "extends" SubscriptionCreateAttributes
type SubscriptionList ¶
type SubscriptionList struct { // Number of subscriptions. TotalCount *int64 `json:"total_count" validate:"required"` // Current offset. Offset *int64 `json:"offset" validate:"required"` // limit to show subscriptions. Limit *int64 `json:"limit" validate:"required"` // List of subscriptions. Subscriptions []SubscriptionListItem `json:"subscriptions" validate:"required"` }
SubscriptionList : Subscription list object.
type SubscriptionListItem ¶
type SubscriptionListItem struct { // ID of the subscription. ID *string `json:"id" validate:"required"` // Name of the subscription. Name *string `json:"name" validate:"required"` // Description of the subscription. Description *string `json:"description" validate:"required"` // ID of the destination. DestinationID *string `json:"destination_id" validate:"required"` // Name of the destination. DestinationName *string `json:"destination_name,omitempty"` // The type of destination. DestinationType *string `json:"destination_type" validate:"required"` // ID of the topic. TopicID *string `json:"topic_id" validate:"required"` // Name of the topic. TopicName *string `json:"topic_name,omitempty"` // Last updated time of the subscription. UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"` }
SubscriptionListItem : Subscription list item.
type SubscriptionUpdateAttributes ¶
type SubscriptionUpdateAttributes struct { // The phone number to send the SMS to. To []string `json:"to,omitempty"` // Whether to add the notification payload to the email. AddNotificationPayload *bool `json:"add_notification_payload,omitempty"` // The email address to reply to. ReplyTo *string `json:"reply_to,omitempty"` // Signing webhook attributes. SigningEnabled *bool `json:"signing_enabled,omitempty"` }
SubscriptionUpdateAttributes : SubscriptionUpdateAttributes struct Models which "extend" this model: - SubscriptionUpdateAttributesSmsAttributes - SubscriptionUpdateAttributesEmailAttributes - SubscriptionUpdateAttributesWebhookAttributes
type SubscriptionUpdateAttributesEmailAttributes ¶
type SubscriptionUpdateAttributesEmailAttributes struct { // The email id string. To []string `json:"to" validate:"required"` // Whether to add the notification payload to the email. AddNotificationPayload *bool `json:"add_notification_payload" validate:"required"` // The email address to reply to. ReplyTo *string `json:"reply_to,omitempty"` }
SubscriptionUpdateAttributesEmailAttributes : The attributes for an email notification. This model "extends" SubscriptionUpdateAttributes
type SubscriptionUpdateAttributesIntf ¶
type SubscriptionUpdateAttributesIntf interface {
// contains filtered or unexported methods
}
type SubscriptionUpdateAttributesSmsAttributes ¶
type SubscriptionUpdateAttributesSmsAttributes struct { // The phone number to send the SMS to. To []string `json:"to" validate:"required"` }
SubscriptionUpdateAttributesSmsAttributes : SMS attributes object. This model "extends" SubscriptionUpdateAttributes
type SubscriptionUpdateAttributesWebhookAttributes ¶
type SubscriptionUpdateAttributesWebhookAttributes struct { // Signing webhook attributes. SigningEnabled *bool `json:"signing_enabled" validate:"required"` }
SubscriptionUpdateAttributesWebhookAttributes : The attributes for a webhook notification. This model "extends" SubscriptionUpdateAttributes
type Topic ¶
type Topic struct { // Autogenerated topic ID. ID *string `json:"id" validate:"required"` // Description of the topic. Description *string `json:"description" validate:"required"` // Name of the topic. Name *string `json:"name" validate:"required"` // Last time the topic was updated. UpdatedAt *string `json:"updated_at" validate:"required"` // Number of sources. SourceCount *int64 `json:"source_count" validate:"required"` // List of sources. Sources []TopicSourcesItem `json:"sources" validate:"required"` // Number of subscriptions. SubscriptionCount *int64 `json:"subscription_count" validate:"required"` // List of subscriptions. Subscriptions []SubscriptionListItem `json:"subscriptions" validate:"required"` }
Topic : Topic object.
type TopicList ¶
type TopicList struct { // Number of topics. TotalCount *int64 `json:"total_count" validate:"required"` // Current offset. Offset *int64 `json:"offset" validate:"required"` // limit to show subscriptions. Limit *int64 `json:"limit" validate:"required"` // List of topics. Topics []TopicsListItem `json:"topics" validate:"required"` }
TopicList : Topic list object.
type TopicResponse ¶
type TopicResponse struct { // Autogenerated topic ID. ID *string `json:"id" validate:"required"` // Name of the topic. Name *string `json:"name" validate:"required"` // Description of the topic. Description *string `json:"description" validate:"required"` // Last time the topic was updated. CreatedAt *string `json:"created_at" validate:"required"` }
TopicResponse : Topic object.
type TopicSourcesItem ¶
type TopicSourcesItem struct { // ID of the source. ID *string `json:"id" validate:"required"` // Name of the source. Name *string `json:"name" validate:"required"` // List of rules. Rules []RulesGet `json:"rules" validate:"required"` }
TopicSourcesItem : TopicSourcesItem struct
type TopicUpdateSourcesItem ¶
type TopicUpdateSourcesItem struct { // ID of the source. ID *string `json:"id" validate:"required"` // List of rules. Rules []Rules `json:"rules" validate:"required"` }
TopicUpdateSourcesItem : TopicUpdateSourcesItem struct
type TopicsListItem ¶
type TopicsListItem struct { // Autogenerated topic ID. ID *string `json:"id" validate:"required"` // Name of the topic. Name *string `json:"name" validate:"required"` // Description of the topic. Description *string `json:"description" validate:"required"` // Number of sources. SourceCount *int64 `json:"source_count" validate:"required"` // List of source names. SourcesNames []string `json:"sources_names" validate:"required"` // Number of subscriptions. SubscriptionCount *int64 `json:"subscription_count" validate:"required"` }
TopicsListItem : Topic list item object.
type UpdateDestinationOptions ¶
type UpdateDestinationOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Unique identifier for Destination. ID *string `json:"id" validate:"required,ne="` // Destination name. Name *string `json:"name,omitempty"` // Destination description. Description *string `json:"description,omitempty"` // Payload describing a destination configuration. Config *DestinationConfig `json:"config,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
UpdateDestinationOptions : The UpdateDestination options.
func (*UpdateDestinationOptions) SetConfig ¶
func (_options *UpdateDestinationOptions) SetConfig(config *DestinationConfig) *UpdateDestinationOptions
SetConfig : Allow user to set Config
func (*UpdateDestinationOptions) SetDescription ¶
func (_options *UpdateDestinationOptions) SetDescription(description string) *UpdateDestinationOptions
SetDescription : Allow user to set Description
func (*UpdateDestinationOptions) SetHeaders ¶
func (options *UpdateDestinationOptions) SetHeaders(param map[string]string) *UpdateDestinationOptions
SetHeaders : Allow user to set Headers
func (*UpdateDestinationOptions) SetID ¶
func (_options *UpdateDestinationOptions) SetID(id string) *UpdateDestinationOptions
SetID : Allow user to set ID
func (*UpdateDestinationOptions) SetInstanceID ¶
func (_options *UpdateDestinationOptions) SetInstanceID(instanceID string) *UpdateDestinationOptions
SetInstanceID : Allow user to set InstanceID
func (*UpdateDestinationOptions) SetName ¶
func (_options *UpdateDestinationOptions) SetName(name string) *UpdateDestinationOptions
SetName : Allow user to set Name
type UpdateSubscriptionOptions ¶
type UpdateSubscriptionOptions struct { // Unique identifier for IBM Cloud Event Notifications instance. InstanceID *string `json:"instance_id" validate:"required,ne="` // Unique identifier for Subscription. ID *string `json:"id" validate:"required,ne="` // Name of the subscription. Name *string `json:"name,omitempty"` // Description of the subscription. Description *string `json:"description,omitempty"` Attributes SubscriptionUpdateAttributesIntf `json:"attributes,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
UpdateSubscriptionOptions : The UpdateSubscription options.
func (*UpdateSubscriptionOptions) SetAttributes ¶
func (_options *UpdateSubscriptionOptions) SetAttributes(attributes SubscriptionUpdateAttributesIntf) *UpdateSubscriptionOptions
SetAttributes : Allow user to set Attributes
func (*UpdateSubscriptionOptions) SetDescription ¶
func (_options *UpdateSubscriptionOptions) SetDescription(description string) *UpdateSubscriptionOptions
SetDescription : Allow user to set Description
func (*UpdateSubscriptionOptions) SetHeaders ¶
func (options *UpdateSubscriptionOptions) SetHeaders(param map[string]string) *UpdateSubscriptionOptions
SetHeaders : Allow user to set Headers
func (*UpdateSubscriptionOptions) SetID ¶
func (_options *UpdateSubscriptionOptions) SetID(id string) *UpdateSubscriptionOptions
SetID : Allow user to set ID
func (*UpdateSubscriptionOptions) SetInstanceID ¶
func (_options *UpdateSubscriptionOptions) SetInstanceID(instanceID string) *UpdateSubscriptionOptions
SetInstanceID : Allow user to set InstanceID
func (*UpdateSubscriptionOptions) SetName ¶
func (_options *UpdateSubscriptionOptions) SetName(name string) *UpdateSubscriptionOptions
SetName : Allow user to set Name