failover

package
v3.4.0 Latest Latest
Warning

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

Go to latest
Published: Mar 10, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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.FailoverBackendCreate) (*ngrok.FailoverBackend, error)

Create a new Failover backend

https://ngrok.com/docs/api#api-failover-backends-create

func (*Client) Delete

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

Delete a Failover backend by ID. TODO what if used?

https://ngrok.com/docs/api#api-failover-backends-delete

func (*Client) Get

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

Get detailed information about a Failover backend by ID

https://ngrok.com/docs/api#api-failover-backends-get

func (*Client) List

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

List all Failover backends on this account

https://ngrok.com/docs/api#api-failover-backends-list

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.FailoverBackendUpdate) (*ngrok.FailoverBackend, error)

Update Failover backend by ID

https://ngrok.com/docs/api#api-failover-backends-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.FailoverBackend

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

Jump to

Keyboard shortcuts

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