event_destinations

Documentation

Index

• type Client
  • func NewClient(cfg *ngrok.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, arg *ngrok.EventDestinationCreate) (*ngrok.EventDestination, error)
  • func (c *Client) Delete(ctx context.Context, id string) error
  • func (c *Client) Get(ctx context.Context, id string) (*ngrok.EventDestination, error)
  • func (c *Client) List(paging *ngrok.Paging) *Iter
  • func (c *Client) Update(ctx context.Context, arg *ngrok.EventDestinationUpdate) (*ngrok.EventDestination, error)
• type Iter
  • func (it *Iter) Err() error
  • func (it *Iter) Item() *ngrok.EventDestination
  • func (it *Iter) Next(ctx context.Context) bool

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg *ngrok.ClientConfig) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, arg *ngrok.EventDestinationCreate) (*ngrok.EventDestination, error)

Create a new Event Destination. It will not apply to anything until it is associated with an Event Stream, and that Event Stream is associated with an Endpoint Config.

https://ngrok.com/docs/api#api-event-destinations-create

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, id string) error

Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.

https://ngrok.com/docs/api#api-event-destinations-delete

func (*Client) Get

func (c *Client) Get(ctx context.Context, id string) (*ngrok.EventDestination, error)

Get detailed information about an Event Destination by ID.

https://ngrok.com/docs/api#api-event-destinations-get

func (*Client) List

func (c *Client) List(paging *ngrok.Paging) *Iter

List all Event Destinations on this account.

https://ngrok.com/docs/api#api-event-destinations-list

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.EventDestinationUpdate) (*ngrok.EventDestination, error)

Update attributes of an Event Destination.

https://ngrok.com/docs/api#api-event-destinations-update

type Iter

type Iter struct {
	// contains filtered or unexported fields
}

Iter allows the caller to iterate through a list of values while automatically fetching new pages worth of values from the API.

func (*Iter) Err

func (it *Iter) Err() error

If Next() returned false because an error was encountered while fetching the next value Err() will return that error. A caller should always check Err() after Next() returns false.

func (*Iter) Item

func (it *Iter) Item() *ngrok.EventDestination

Item() returns the EventDestination currently pointed to by the iterator.

func (*Iter) Next

func (it *Iter) Next(ctx context.Context) bool

Next returns true if there is another value available in the iterator. If it returs true it also advances the iterator to that next available item.