ip_policies

Documentation

Index

• type Client
  • func NewClient(cfg *ngrok.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, arg *ngrok.IPPolicyCreate) (*ngrok.IPPolicy, error)
  • func (c *Client) Delete(ctx context.Context, id string) error
  • func (c *Client) Get(ctx context.Context, id string) (*ngrok.IPPolicy, error)
  • func (c *Client) List(paging *ngrok.Paging) *Iter
  • func (c *Client) Update(ctx context.Context, arg *ngrok.IPPolicyUpdate) (*ngrok.IPPolicy, error)
• type Iter
  • func (it *Iter) Err() error
  • func (it *Iter) Item() *ngrok.IPPolicy
  • 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.IPPolicyCreate) (*ngrok.IPPolicy, error)

Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.

https://ngrok.com/docs/api#api-ip-policies-create

func (*Client) Delete

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

Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.

https://ngrok.com/docs/api#api-ip-policies-delete

func (*Client) Get

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

Get detailed information about an IP policy by ID.

https://ngrok.com/docs/api#api-ip-policies-get

func (*Client) List

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

List all IP policies on this account

https://ngrok.com/docs/api#api-ip-policies-list

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.IPPolicyUpdate) (*ngrok.IPPolicy, error)

Update attributes of an IP policy by ID

https://ngrok.com/docs/api#api-ip-policies-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.IPPolicy

Item() returns the IPPolicy 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.