platformnotificationsv1

package
v0.94.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 19, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package platformnotificationsv1 : Operations and models for the PlatformNotificationsV1 service

Index

Constants

View Source
const (
	TestDestinationRequestBodyPrototype_NotificationType_Announcements     = "announcements"
	TestDestinationRequestBodyPrototype_NotificationType_BillingAndUsage   = "billing_and_usage"
	TestDestinationRequestBodyPrototype_NotificationType_Incident          = "incident"
	TestDestinationRequestBodyPrototype_NotificationType_Maintenance       = "maintenance"
	TestDestinationRequestBodyPrototype_NotificationType_Resource          = "resource"
	TestDestinationRequestBodyPrototype_NotificationType_SecurityBulletins = "security_bulletins"
)

Constants associated with the TestDestinationRequestBodyPrototype.NotificationType property. The type of the notification to test.

View Source
const (
	TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype_NotificationType_Announcements     = "announcements"
	TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype_NotificationType_BillingAndUsage   = "billing_and_usage"
	TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype_NotificationType_Incident          = "incident"
	TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype_NotificationType_Maintenance       = "maintenance"
	TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype_NotificationType_Resource          = "resource"
	TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype_NotificationType_SecurityBulletins = "security_bulletins"
)

Constants associated with the TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype.NotificationType property. The type of the notification to test.

View Source
const (
	AddDestinationEventNotificationDestination_DestinationType_EventNotifications = "event_notifications"
)

Constants associated with the AddDestinationEventNotificationDestination.DestinationType property. The type of the destination.

View Source
const (
	AddDestinationPrototypeEventNotificationDestinationPrototype_DestinationType_EventNotifications = "event_notifications"
)

Constants associated with the AddDestinationPrototypeEventNotificationDestinationPrototype.DestinationType property. The type of the destination.

View Source
const (
	AddDestinationPrototype_DestinationType_EventNotifications = "event_notifications"
)

Constants associated with the AddDestinationPrototype.DestinationType property. The type of the destination.

View Source
const (
	AddDestination_DestinationType_EventNotifications = "event_notifications"
)

Constants associated with the AddDestination.DestinationType property. The type of the destination.

View Source
const DefaultServiceName = "platform_notifications"

DefaultServiceName is the default key used to find external configuration information.

View Source
const DefaultServiceURL = "https://notifications.cloud.ibm.com/api"

DefaultServiceURL is the default URL to make service requests to.

View Source
const (
	TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype_DestinationType_EventNotifications = "event_notifications"
)

Constants associated with the TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype.DestinationType property. The type of the destination.

View Source
const (
	TestDestinationRequestBodyPrototype_DestinationType_EventNotifications = "event_notifications"
)

Constants associated with the TestDestinationRequestBodyPrototype.DestinationType property. The type of the destination.

Variables

This section is empty.

Functions

func GetServiceURLForRegion

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAddDestination

func UnmarshalAddDestination(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddDestination unmarshals an instance of AddDestination from the specified map of raw messages.

func UnmarshalAddDestinationCollection

func UnmarshalAddDestinationCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddDestinationCollection unmarshals an instance of AddDestinationCollection from the specified map of raw messages.

func UnmarshalAddDestinationEventNotificationDestination

func UnmarshalAddDestinationEventNotificationDestination(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddDestinationEventNotificationDestination unmarshals an instance of AddDestinationEventNotificationDestination from the specified map of raw messages.

func UnmarshalAddDestinationPrototype

func UnmarshalAddDestinationPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddDestinationPrototype unmarshals an instance of AddDestinationPrototype from the specified map of raw messages.

func UnmarshalAddDestinationPrototypeEventNotificationDestinationPrototype

func UnmarshalAddDestinationPrototypeEventNotificationDestinationPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddDestinationPrototypeEventNotificationDestinationPrototype unmarshals an instance of AddDestinationPrototypeEventNotificationDestinationPrototype from the specified map of raw messages.

func UnmarshalTestDestinationRequestBodyPrototype

func UnmarshalTestDestinationRequestBodyPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTestDestinationRequestBodyPrototype unmarshals an instance of TestDestinationRequestBodyPrototype from the specified map of raw messages.

func UnmarshalTestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype

func UnmarshalTestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype unmarshals an instance of TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype from the specified map of raw messages.

func UnmarshalTestDestinationResponseBody

func UnmarshalTestDestinationResponseBody(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTestDestinationResponseBody unmarshals an instance of TestDestinationResponseBody from the specified map of raw messages.

Types

type AddDestination

type AddDestination struct {
	// The GUID of the Event Notifications instance.
	DestinationID *strfmt.UUID `json:"destination_id,omitempty"`

	// The type of the destination.
	DestinationType *string `json:"destination_type,omitempty"`
}

AddDestination : AddDestination struct Models which "extend" this model: - AddDestinationEventNotificationDestination

type AddDestinationCollection

type AddDestinationCollection struct {
	// Array of destination entries.
	Destinations []AddDestinationIntf `json:"destinations" validate:"required"`
}

AddDestinationCollection : List of destinations in the distribution list.

type AddDestinationEventNotificationDestination

type AddDestinationEventNotificationDestination struct {
	// The GUID of the Event Notifications instance.
	DestinationID *strfmt.UUID `json:"destination_id" validate:"required"`

	// The type of the destination.
	DestinationType *string `json:"destination_type" validate:"required"`
}

AddDestinationEventNotificationDestination : An Event Notifications destination entry in the distribution list. This model "extends" AddDestination

type AddDestinationIntf

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

type AddDestinationPrototype

type AddDestinationPrototype struct {
	// The GUID of the Event Notifications instance.
	DestinationID *strfmt.UUID `json:"destination_id,omitempty"`

	// The type of the destination.
	DestinationType *string `json:"destination_type" validate:"required"`
}

AddDestinationPrototype : AddDestinationPrototype struct Models which "extend" this model: - AddDestinationPrototypeEventNotificationDestinationPrototype

type AddDestinationPrototypeEventNotificationDestinationPrototype

type AddDestinationPrototypeEventNotificationDestinationPrototype struct {
	// The GUID of the Event Notifications instance.
	DestinationID *strfmt.UUID `json:"destination_id" validate:"required"`

	// The type of the destination.
	DestinationType *string `json:"destination_type" validate:"required"`
}

AddDestinationPrototypeEventNotificationDestinationPrototype : Prototype for creating an Event Notifications destination entry. This model "extends" AddDestinationPrototype

type AddDestinationPrototypeIntf

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

type CreateDistributionListDestinationOptions

type CreateDistributionListDestinationOptions struct {
	// The IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required,ne="`

	AddDestinationPrototype AddDestinationPrototypeIntf `json:"AddDestinationPrototype" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

CreateDistributionListDestinationOptions : The CreateDistributionListDestination options.

func (*CreateDistributionListDestinationOptions) SetAccountID

SetAccountID : Allow user to set AccountID

func (*CreateDistributionListDestinationOptions) SetAddDestinationPrototype

func (_options *CreateDistributionListDestinationOptions) SetAddDestinationPrototype(addDestinationPrototype AddDestinationPrototypeIntf) *CreateDistributionListDestinationOptions

SetAddDestinationPrototype : Allow user to set AddDestinationPrototype

func (*CreateDistributionListDestinationOptions) SetHeaders

SetHeaders : Allow user to set Headers

type DeleteDistributionListDestinationOptions

type DeleteDistributionListDestinationOptions struct {
	// The IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The ID of the destination.
	DestinationID *string `json:"destination_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

DeleteDistributionListDestinationOptions : The DeleteDistributionListDestination options.

func (*DeleteDistributionListDestinationOptions) SetAccountID

SetAccountID : Allow user to set AccountID

func (*DeleteDistributionListDestinationOptions) SetDestinationID

SetDestinationID : Allow user to set DestinationID

func (*DeleteDistributionListDestinationOptions) SetHeaders

SetHeaders : Allow user to set Headers

type GetDistributionListDestinationOptions

type GetDistributionListDestinationOptions struct {
	// The IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The ID of the destination.
	DestinationID *string `json:"destination_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

GetDistributionListDestinationOptions : The GetDistributionListDestination options.

func (*GetDistributionListDestinationOptions) SetAccountID

SetAccountID : Allow user to set AccountID

func (*GetDistributionListDestinationOptions) SetDestinationID

func (_options *GetDistributionListDestinationOptions) SetDestinationID(destinationID string) *GetDistributionListDestinationOptions

SetDestinationID : Allow user to set DestinationID

func (*GetDistributionListDestinationOptions) SetHeaders

SetHeaders : Allow user to set Headers

type ListDistributionListDestinationsOptions

type ListDistributionListDestinationsOptions struct {
	// The IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

ListDistributionListDestinationsOptions : The ListDistributionListDestinations options.

func (*ListDistributionListDestinationsOptions) SetAccountID

SetAccountID : Allow user to set AccountID

func (*ListDistributionListDestinationsOptions) SetHeaders

SetHeaders : Allow user to set Headers

type PlatformNotificationsV1

type PlatformNotificationsV1 struct {
	Service *core.BaseService
}

PlatformNotificationsV1 : **This API is currently in beta and subject to change.**

API for managing notification distribution lists for IBM Cloud accounts.

API Version: 1.0.0

func NewPlatformNotificationsV1

func NewPlatformNotificationsV1(options *PlatformNotificationsV1Options) (service *PlatformNotificationsV1, err error)

NewPlatformNotificationsV1 : constructs an instance of PlatformNotificationsV1 with passed in options.

func NewPlatformNotificationsV1UsingExternalConfig

func NewPlatformNotificationsV1UsingExternalConfig(options *PlatformNotificationsV1Options) (platformNotifications *PlatformNotificationsV1, err error)

NewPlatformNotificationsV1UsingExternalConfig : constructs an instance of PlatformNotificationsV1 with passed in options and external configuration.

func (*PlatformNotificationsV1) Clone

func (platformNotifications *PlatformNotificationsV1) Clone() *PlatformNotificationsV1

Clone makes a copy of "platformNotifications" suitable for processing requests.

func (*PlatformNotificationsV1) CreateDistributionListDestination

func (platformNotifications *PlatformNotificationsV1) CreateDistributionListDestination(createDistributionListDestinationOptions *CreateDistributionListDestinationOptions) (result AddDestinationIntf, response *core.DetailedResponse, err error)

CreateDistributionListDestination : Add a destination entry Add a destination entry to the distribution list. A maximum of 10 destination entries per destination type. In terms of enterprise accounts, you can provide an Event Notifications destination that is from a different account than the distribution list account, provided these two accounts are from the same enterprise and the user has permission to manage the Event Notifications destinations on both accounts.

func (*PlatformNotificationsV1) CreateDistributionListDestinationWithContext

func (platformNotifications *PlatformNotificationsV1) CreateDistributionListDestinationWithContext(ctx context.Context, createDistributionListDestinationOptions *CreateDistributionListDestinationOptions) (result AddDestinationIntf, response *core.DetailedResponse, err error)

CreateDistributionListDestinationWithContext is an alternate form of the CreateDistributionListDestination method which supports a Context parameter

func (*PlatformNotificationsV1) DeleteDistributionListDestination

func (platformNotifications *PlatformNotificationsV1) DeleteDistributionListDestination(deleteDistributionListDestinationOptions *DeleteDistributionListDestinationOptions) (response *core.DetailedResponse, err error)

DeleteDistributionListDestination : Delete destination entry Remove a destination entry.

func (*PlatformNotificationsV1) DeleteDistributionListDestinationWithContext

func (platformNotifications *PlatformNotificationsV1) DeleteDistributionListDestinationWithContext(ctx context.Context, deleteDistributionListDestinationOptions *DeleteDistributionListDestinationOptions) (response *core.DetailedResponse, err error)

DeleteDistributionListDestinationWithContext is an alternate form of the DeleteDistributionListDestination method which supports a Context parameter

func (*PlatformNotificationsV1) DisableRetries

func (platformNotifications *PlatformNotificationsV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*PlatformNotificationsV1) EnableRetries

func (platformNotifications *PlatformNotificationsV1) 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 (*PlatformNotificationsV1) GetDistributionListDestination

func (platformNotifications *PlatformNotificationsV1) GetDistributionListDestination(getDistributionListDestinationOptions *GetDistributionListDestinationOptions) (result AddDestinationIntf, response *core.DetailedResponse, err error)

GetDistributionListDestination : Get a destination entry Retrieve a specific destination from the distribution list of the account.

func (*PlatformNotificationsV1) GetDistributionListDestinationWithContext

func (platformNotifications *PlatformNotificationsV1) GetDistributionListDestinationWithContext(ctx context.Context, getDistributionListDestinationOptions *GetDistributionListDestinationOptions) (result AddDestinationIntf, response *core.DetailedResponse, err error)

GetDistributionListDestinationWithContext is an alternate form of the GetDistributionListDestination method which supports a Context parameter

func (*PlatformNotificationsV1) GetEnableGzipCompression

func (platformNotifications *PlatformNotificationsV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*PlatformNotificationsV1) GetServiceURL

func (platformNotifications *PlatformNotificationsV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*PlatformNotificationsV1) ListDistributionListDestinations

func (platformNotifications *PlatformNotificationsV1) ListDistributionListDestinations(listDistributionListDestinationsOptions *ListDistributionListDestinationsOptions) (result *AddDestinationCollection, response *core.DetailedResponse, err error)

ListDistributionListDestinations : Get all destination entries Retrieve all destinations in the distribution list for the specified account.

func (*PlatformNotificationsV1) ListDistributionListDestinationsWithContext

func (platformNotifications *PlatformNotificationsV1) ListDistributionListDestinationsWithContext(ctx context.Context, listDistributionListDestinationsOptions *ListDistributionListDestinationsOptions) (result *AddDestinationCollection, response *core.DetailedResponse, err error)

ListDistributionListDestinationsWithContext is an alternate form of the ListDistributionListDestinations method which supports a Context parameter

func (*PlatformNotificationsV1) NewAddDestinationPrototypeEventNotificationDestinationPrototype

func (*PlatformNotificationsV1) NewAddDestinationPrototypeEventNotificationDestinationPrototype(destinationID *strfmt.UUID, destinationType string) (_model *AddDestinationPrototypeEventNotificationDestinationPrototype, err error)

NewAddDestinationPrototypeEventNotificationDestinationPrototype : Instantiate AddDestinationPrototypeEventNotificationDestinationPrototype (Generic Model Constructor)

func (*PlatformNotificationsV1) NewCreateDistributionListDestinationOptions

func (*PlatformNotificationsV1) NewCreateDistributionListDestinationOptions(accountID string, addDestinationPrototype AddDestinationPrototypeIntf) *CreateDistributionListDestinationOptions

NewCreateDistributionListDestinationOptions : Instantiate CreateDistributionListDestinationOptions

func (*PlatformNotificationsV1) NewDeleteDistributionListDestinationOptions

func (*PlatformNotificationsV1) NewDeleteDistributionListDestinationOptions(accountID string, destinationID string) *DeleteDistributionListDestinationOptions

NewDeleteDistributionListDestinationOptions : Instantiate DeleteDistributionListDestinationOptions

func (*PlatformNotificationsV1) NewGetDistributionListDestinationOptions

func (*PlatformNotificationsV1) NewGetDistributionListDestinationOptions(accountID string, destinationID string) *GetDistributionListDestinationOptions

NewGetDistributionListDestinationOptions : Instantiate GetDistributionListDestinationOptions

func (*PlatformNotificationsV1) NewListDistributionListDestinationsOptions

func (*PlatformNotificationsV1) NewListDistributionListDestinationsOptions(accountID string) *ListDistributionListDestinationsOptions

NewListDistributionListDestinationsOptions : Instantiate ListDistributionListDestinationsOptions

func (*PlatformNotificationsV1) NewTestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype

func (*PlatformNotificationsV1) NewTestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype(destinationType string, notificationType string) (_model *TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype, err error)

NewTestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype : Instantiate TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype (Generic Model Constructor)

func (*PlatformNotificationsV1) NewTestDistributionListDestinationOptions

func (*PlatformNotificationsV1) NewTestDistributionListDestinationOptions(accountID string, destinationID string, testDestinationRequestBodyPrototype TestDestinationRequestBodyPrototypeIntf) *TestDistributionListDestinationOptions

NewTestDistributionListDestinationOptions : Instantiate TestDistributionListDestinationOptions

func (*PlatformNotificationsV1) SetDefaultHeaders

func (platformNotifications *PlatformNotificationsV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*PlatformNotificationsV1) SetEnableGzipCompression

func (platformNotifications *PlatformNotificationsV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*PlatformNotificationsV1) SetServiceURL

func (platformNotifications *PlatformNotificationsV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*PlatformNotificationsV1) TestDistributionListDestination

func (platformNotifications *PlatformNotificationsV1) TestDistributionListDestination(testDistributionListDestinationOptions *TestDistributionListDestinationOptions) (result *TestDestinationResponseBody, response *core.DetailedResponse, err error)

TestDistributionListDestination : Test destination entry Send a test notification to a destination in the distribution list. This allows you to verify that the destination is properly configured and can receive notifications.

func (*PlatformNotificationsV1) TestDistributionListDestinationWithContext

func (platformNotifications *PlatformNotificationsV1) TestDistributionListDestinationWithContext(ctx context.Context, testDistributionListDestinationOptions *TestDistributionListDestinationOptions) (result *TestDestinationResponseBody, response *core.DetailedResponse, err error)

TestDistributionListDestinationWithContext is an alternate form of the TestDistributionListDestination method which supports a Context parameter

type PlatformNotificationsV1Options

type PlatformNotificationsV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

PlatformNotificationsV1Options : Service options

type TestDestinationRequestBodyPrototype

type TestDestinationRequestBodyPrototype struct {
	// The type of the destination.
	DestinationType *string `json:"destination_type" validate:"required"`

	// The type of the notification to test.
	NotificationType *string `json:"notification_type,omitempty"`
}

TestDestinationRequestBodyPrototype : TestDestinationRequestBodyPrototype struct Models which "extend" this model: - TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype

type TestDestinationRequestBodyPrototypeIntf

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

type TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype

type TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype struct {
	// The type of the destination.
	DestinationType *string `json:"destination_type" validate:"required"`

	// The type of the notification to test.
	NotificationType *string `json:"notification_type" validate:"required"`
}

TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype : Request body for testing an Event Notifications destination. This model "extends" TestDestinationRequestBodyPrototype

type TestDestinationResponseBody

type TestDestinationResponseBody struct {
	// The status message that indicates the test result.
	Message *string `json:"message" validate:"required"`
}

TestDestinationResponseBody : Response from the test notification endpoint.

type TestDistributionListDestinationOptions

type TestDistributionListDestinationOptions struct {
	// The IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The ID of the destination.
	DestinationID *string `json:"destination_id" validate:"required,ne="`

	TestDestinationRequestBodyPrototype TestDestinationRequestBodyPrototypeIntf `json:"TestDestinationRequestBodyPrototype" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

TestDistributionListDestinationOptions : The TestDistributionListDestination options.

func (*TestDistributionListDestinationOptions) SetAccountID

SetAccountID : Allow user to set AccountID

func (*TestDistributionListDestinationOptions) SetDestinationID

SetDestinationID : Allow user to set DestinationID

func (*TestDistributionListDestinationOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*TestDistributionListDestinationOptions) SetTestDestinationRequestBodyPrototype

func (_options *TestDistributionListDestinationOptions) SetTestDestinationRequestBodyPrototype(testDestinationRequestBodyPrototype TestDestinationRequestBodyPrototypeIntf) *TestDistributionListDestinationOptions

SetTestDestinationRequestBodyPrototype : Allow user to set TestDestinationRequestBodyPrototype

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL