ip_policy_rules

Documentation

Index

• type Client
  • func NewClient(apiClient *ngrok.Client) *Client
  • func (c *Client) Create(ctx context.Context, arg *ngrok.IPPolicyRuleCreate) (*ngrok.IPPolicyRule, error)
  • func (c *Client) Delete(ctx context.Context, id string) error
  • func (c *Client) Get(ctx context.Context, id string) (*ngrok.IPPolicyRule, error)
  • func (c *Client) List(ctx context.Context, paging *ngrok.Paging) *Iter
  • func (c *Client) Update(ctx context.Context, arg *ngrok.IPPolicyRuleUpdate) (*ngrok.IPPolicyRule, error)
• type Iter
  • func (it *Iter) Err() error
  • func (it *Iter) Item() *ngrok.IPPolicyRule
  • func (it *Iter) Next() bool

Types

type Client

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

func NewClient

func NewClient(apiClient *ngrok.Client) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, arg *ngrok.IPPolicyRuleCreate) (*ngrok.IPPolicyRule, error)

Create a new IP policy rule attached to an IP Policy.

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

func (*Client) Delete

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

Delete an IP policy rule.

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

func (*Client) Get

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

Get detailed information about an IP policy rule by ID.

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

func (*Client) List

func (c *Client) List(ctx context.Context, paging *ngrok.Paging) *Iter

List all IP policy rules on this account

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

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.IPPolicyRuleUpdate) (*ngrok.IPPolicyRule, error)

Update attributes of an IP policy rule by ID

https://ngrok.com/docs/api#api-ip-policy-rules-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.IPPolicyRule

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

func (*Iter) Next

func (it *Iter) Next() 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.