reserved_domains

Documentation

Index

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

Create a new reserved domain.

https://ngrok.com/docs/api#api-reserved-domains-create

func (*Client) Delete

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

Delete a reserved domain.

https://ngrok.com/docs/api#api-reserved-domains-delete

func (*Client) DeleteCertificate

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

Detach the certificate attached to a reserved domain.

https://ngrok.com/docs/api#api-reserved-domains-delete-certificate

func (*Client) DeleteCertificateManagementPolicy

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

Detach the certificate management policy attached to a reserved domain.

https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy

func (*Client) Get

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

Get the details of a reserved domain.

https://ngrok.com/docs/api#api-reserved-domains-get

func (*Client) List

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

List all reserved domains on this account.

https://ngrok.com/docs/api#api-reserved-domains-list

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.ReservedDomainUpdate) (*ngrok.ReservedDomain, error)

Update the attributes of a reserved domain.

https://ngrok.com/docs/api#api-reserved-domains-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.ReservedDomain

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