notification

package
v1.16.0 Latest Latest
Warning

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

Go to latest
Published: Oct 30, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Endpoint

type Endpoint struct {
	ID       *string `json:"id,omitempty"` // read-only
	Name     *string `json:"name,omitempty"`
	Protocol *string `json:"protocol,omitempty"`
	Url      *string `json:"url,omitempty"`

	NotificationEndpointSlackAppConfig *NotificationEndpointSlackAppConfig `json:"notificationEndpointSlackAppConfig,omitempty"`
	EmailAddresses                     []*string                           `json:"emailAddresses,omitempty"`
	// contains filtered or unexported fields
}

func (Endpoint) MarshalJSON

func (o Endpoint) MarshalJSON() ([]byte, error)

func (*Endpoint) SetEmailAddresses added in v1.15.0

func (o *Endpoint) SetEmailAddresses(v []*string) *Endpoint

func (*Endpoint) SetName

func (o *Endpoint) SetName(v *string) *Endpoint

func (*Endpoint) SetNotificationEndpointSlackAppConfig added in v1.15.0

func (o *Endpoint) SetNotificationEndpointSlackAppConfig(v *NotificationEndpointSlackAppConfig) *Endpoint

func (*Endpoint) SetProtocol

func (o *Endpoint) SetProtocol(v *string) *Endpoint

func (*Endpoint) SetUrl

func (o *Endpoint) SetUrl(v *string) *Endpoint

type EventSubscription

type EventSubscription struct {
	ID                     *string `json:"id,omitempty"` // read-only
	NotificationEndpointId *string `json:"notificationEndpointId,omitempty"`
	Scope                  *string `json:"scope,omitempty"`
	ScopeId                *string `json:"scopeId,omitempty"`
	EventType              *string `json:"eventType,omitempty"`
	// contains filtered or unexported fields
}

func (EventSubscription) MarshalJSON

func (o EventSubscription) MarshalJSON() ([]byte, error)

func (*EventSubscription) SetEventType

func (o *EventSubscription) SetEventType(v *string) *EventSubscription

func (*EventSubscription) SetID

func (*EventSubscription) SetNotificationEndpointId

func (o *EventSubscription) SetNotificationEndpointId(v *string) *EventSubscription

func (*EventSubscription) SetScope

func (o *EventSubscription) SetScope(v *string) *EventSubscription

func (*EventSubscription) SetScopeId

func (o *EventSubscription) SetScopeId(v *string) *EventSubscription

type NotificationEndpointSlackAppConfig added in v1.15.0

type NotificationEndpointSlackAppConfig struct {
	NotificationSlackAppId *string `json:"notificationSlackAppId,omitempty"`
	ChannelId              *string `json:"channelId,omitempty"`
	// contains filtered or unexported fields
}

func (NotificationEndpointSlackAppConfig) MarshalJSON added in v1.15.0

func (o NotificationEndpointSlackAppConfig) MarshalJSON() ([]byte, error)

func (*NotificationEndpointSlackAppConfig) SetChannelId added in v1.15.0

func (*NotificationEndpointSlackAppConfig) SetNotificationSlackAppId added in v1.15.0

type NotificationSlackApp added in v1.15.0

type NotificationSlackApp struct {
	ID           *string `json:"id,omitempty"` // read-only
	Name         *string `json:"name,omitempty"`
	BotAuthToken *string `json:"botAuthToken,omitempty"`
	// contains filtered or unexported fields
}

func (NotificationSlackApp) MarshalJSON added in v1.15.0

func (o NotificationSlackApp) MarshalJSON() ([]byte, error)

func (*NotificationSlackApp) SetBotAuthToken added in v1.15.0

func (o *NotificationSlackApp) SetBotAuthToken(v *string) *NotificationSlackApp

func (*NotificationSlackApp) SetName added in v1.15.0

type Service

type Service interface {
	CreateNotificationEndpoint(context.Context, *Endpoint) (*Endpoint, error)
	ListNotificationEndpoints(context.Context, *string, *string) ([]*Endpoint, error)
	ReadNotificationEndpoint(context.Context, string) (*Endpoint, error)
	UpdateNotificationEndpoint(context.Context, string, *Endpoint) (*Endpoint, error)
	DeleteNotificationEndpoint(context.Context, string) (*commons.EmptyResponse, error)

	ListEventSubscriptions(context.Context, string, *string) ([]*EventSubscription, error)
	CreateEventSubscription(context.Context, *EventSubscription) (*EventSubscription, error)
	DeleteEventSubscription(context.Context, string) (*commons.EmptyResponse, error)

	CreateNotificationSlackApp(context.Context, *NotificationSlackApp) (*NotificationSlackApp, error)
	ListNotificationSlackApps(context.Context, *string, *string) ([]*NotificationSlackApp, error)
	UpdateNotificationSlackApp(context.Context, string, *NotificationSlackApp) (*NotificationSlackApp, error)
	DeleteNotificationSlackApp(context.Context, string) (*commons.EmptyResponse, error)
}

Service provides the API operation methods for making requests to endpoints of the ControlMonkey API. See this package's package overview docs for details on the service.

func New

func New(sess *session.Session, cfgs ...*controlmonkey.Config) Service

type ServiceOp

type ServiceOp struct {
	Client *client.Client
}

func (*ServiceOp) CreateEventSubscription

func (s *ServiceOp) CreateEventSubscription(ctx context.Context, input *EventSubscription) (*EventSubscription, error)

func (*ServiceOp) CreateNotificationEndpoint

func (s *ServiceOp) CreateNotificationEndpoint(ctx context.Context, input *Endpoint) (*Endpoint, error)

func (*ServiceOp) CreateNotificationSlackApp added in v1.15.0

func (s *ServiceOp) CreateNotificationSlackApp(ctx context.Context, input *NotificationSlackApp) (*NotificationSlackApp, error)

func (*ServiceOp) DeleteEventSubscription

func (s *ServiceOp) DeleteEventSubscription(ctx context.Context, subscriptionId string) (*commons.EmptyResponse, error)

func (*ServiceOp) DeleteNotificationEndpoint

func (s *ServiceOp) DeleteNotificationEndpoint(ctx context.Context, endpointId string) (*commons.EmptyResponse, error)

func (*ServiceOp) DeleteNotificationSlackApp added in v1.15.0

func (s *ServiceOp) DeleteNotificationSlackApp(ctx context.Context, slackAppId string) (*commons.EmptyResponse, error)

func (*ServiceOp) ListEventSubscriptions

func (s *ServiceOp) ListEventSubscriptions(ctx context.Context, scope string, scopeId *string) ([]*EventSubscription, error)

func (*ServiceOp) ListNotificationEndpoints added in v1.10.0

func (s *ServiceOp) ListNotificationEndpoints(ctx context.Context, endpointId *string, endpointName *string) ([]*Endpoint, error)

func (*ServiceOp) ListNotificationSlackApps added in v1.15.0

func (s *ServiceOp) ListNotificationSlackApps(ctx context.Context, slackAppId *string, slackAppName *string) ([]*NotificationSlackApp, error)

func (*ServiceOp) ReadNotificationEndpoint

func (s *ServiceOp) ReadNotificationEndpoint(ctx context.Context, endpointId string) (*Endpoint, error)

func (*ServiceOp) UpdateNotificationEndpoint

func (s *ServiceOp) UpdateNotificationEndpoint(ctx context.Context, endpointId string, input *Endpoint) (*Endpoint, error)

func (*ServiceOp) UpdateNotificationSlackApp added in v1.15.0

func (s *ServiceOp) UpdateNotificationSlackApp(ctx context.Context, slackAppId string, input *NotificationSlackApp) (*NotificationSlackApp, error)

Jump to

Keyboard shortcuts

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