notification

Documentation

Index

• type Endpoint
  • func (o Endpoint) MarshalJSON() ([]byte, error)
  • func (o *Endpoint) SetName(v *string) *Endpoint
  • func (o *Endpoint) SetProtocol(v *string) *Endpoint
  • func (o *Endpoint) SetUrl(v *string) *Endpoint
• type EventSubscription
  • func (o EventSubscription) MarshalJSON() ([]byte, error)
  • func (o *EventSubscription) SetEventType(v *string) *EventSubscription
  • func (o *EventSubscription) SetID(v *string) *EventSubscription
  • func (o *EventSubscription) SetNotificationEndpointId(v *string) *EventSubscription
  • func (o *EventSubscription) SetScope(v *string) *EventSubscription
  • func (o *EventSubscription) SetScopeId(v *string) *EventSubscription
• type Service
  • func New(sess *session.Session, cfgs ...*controlmonkey.Config) Service
• type ServiceOp
  • func (s *ServiceOp) CreateEventSubscription(ctx context.Context, input *EventSubscription) (*EventSubscription, error)
  • func (s *ServiceOp) CreateNotificationEndpoint(ctx context.Context, input *Endpoint) (*Endpoint, error)
  • func (s *ServiceOp) DeleteEventSubscription(ctx context.Context, subscriptionId string) (*commons.EmptyResponse, error)
  • func (s *ServiceOp) DeleteNotificationEndpoint(ctx context.Context, endpointId string) (*commons.EmptyResponse, error)
  • func (s *ServiceOp) ListEventSubscriptions(ctx context.Context, scope string, scopeId *string) ([]*EventSubscription, error)
  • func (s *ServiceOp) ListNotificationEndpoints(ctx context.Context, endpointId *string, endpointName *string) ([]*Endpoint, error)
  • func (s *ServiceOp) ReadNotificationEndpoint(ctx context.Context, endpointId string) (*Endpoint, error)
  • func (s *ServiceOp) UpdateNotificationEndpoint(ctx context.Context, endpointId string, input *Endpoint) (*Endpoint, error)

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"`
	// contains filtered or unexported fields
}

func (Endpoint) MarshalJSON

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

func (*Endpoint) SetName

func (o *Endpoint) SetName(v *string) *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 (o *EventSubscription) SetID(v *string) *EventSubscription

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 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)
}

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) 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) ListEventSubscriptions

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

func (*ServiceOp) ListNotificationEndpoints

func (s *ServiceOp) ListNotificationEndpoints(ctx context.Context, endpointId *string, endpointName *string) ([]*Endpoint, 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)