ssh_credentials

Documentation

Index

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

Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.

https://ngrok.com/docs/api#api-ssh-credentials-create

func (*Client) Delete

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

Delete an ssh_credential by ID

https://ngrok.com/docs/api#api-ssh-credentials-delete

func (*Client) Get

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

Get detailed information about an ssh_credential

https://ngrok.com/docs/api#api-ssh-credentials-get

func (*Client) List

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

List all ssh credentials on this account

https://ngrok.com/docs/api#api-ssh-credentials-list

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.SSHCredentialUpdate) (*ngrok.SSHCredential, error)

Update attributes of an ssh_credential by ID

https://ngrok.com/docs/api#api-ssh-credentials-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.SSHCredential

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