plugins

Documentation

Index

• type Client
  • func New(c HTTPClient) *Client
  • func (c *Client) Create(ctx context.Context, req CreateRequest) error
  • func (c *Client) Delete(ctx context.Context, req DeleteRequest) error
  • func (c *Client) Find(ctx context.Context, req FindRequest) (map[string]interface{}, error)
  • func (c *Client) Index(ctx context.Context, req IndexRequest) ([]IndexResponse, error)
  • func (c *Client) Update(ctx context.Context, req UpdateRequest) error
• type CreateRequest
• type DeleteRequest
• type FindRequest
• type HTTPClient
• type IndexRequest
• type IndexResponse
• type UpdateRequest

Types

type Client

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

func New

func New(c HTTPClient) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, req CreateRequest) error

Create Add ACME plugin configuration.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, req DeleteRequest) error

Delete Delete ACME plugin configuration.

func (*Client) Find

func (c *Client) Find(ctx context.Context, req FindRequest) (map[string]interface{}, error)

Find Get ACME plugin configuration.

func (*Client) Index

func (c *Client) Index(ctx context.Context, req IndexRequest) ([]IndexResponse, error)

Index ACME plugin index.

func (*Client) Update

func (c *Client) Update(ctx context.Context, req UpdateRequest) error

Update Update ACME plugin configuration.

type CreateRequest

type CreateRequest struct {
	Id   string `url:"id" json:"id"`     // ACME Plugin ID name
	Type string `url:"type" json:"type"` // ACME challenge type.

	// The following parameters are optional
	Api             *string           `url:"api,omitempty" json:"api,omitempty"`                           // API plugin name
	Data            *string           `url:"data,omitempty" json:"data,omitempty"`                         // DNS plugin data. (base64 encoded)
	Disable         *util.SpecialBool `url:"disable,omitempty" json:"disable,omitempty"`                   // Flag to disable the config.
	Nodes           *string           `url:"nodes,omitempty" json:"nodes,omitempty"`                       // List of cluster node names.
	ValidationDelay *int              `url:"validation-delay,omitempty" json:"validation-delay,omitempty"` // Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
}

type DeleteRequest

type DeleteRequest struct {
	Id string `url:"id" json:"id"` // Unique identifier for ACME plugin instance.

}

type FindRequest

type FindRequest struct {
	Id string `url:"id" json:"id"` // Unique identifier for ACME plugin instance.

}

type HTTPClient

type HTTPClient interface {
	Do(context.Context, string, string, interface{}, interface{}) error
}

type IndexRequest

type IndexRequest struct {

	// The following parameters are optional
	Type *string `url:"type,omitempty" json:"type,omitempty"` // Only list ACME plugins of a specific type
}

type IndexResponse

type IndexResponse struct {
	Plugin string `url:"plugin" json:"plugin"` // Unique identifier for ACME plugin instance.

}

type UpdateRequest

type UpdateRequest struct {
	Id string `url:"id" json:"id"` // ACME Plugin ID name

	// The following parameters are optional
	Api             *string           `url:"api,omitempty" json:"api,omitempty"`                           // API plugin name
	Data            *string           `url:"data,omitempty" json:"data,omitempty"`                         // DNS plugin data. (base64 encoded)
	Delete          *string           `url:"delete,omitempty" json:"delete,omitempty"`                     // A list of settings you want to delete.
	Digest          *string           `url:"digest,omitempty" json:"digest,omitempty"`                     // Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
	Disable         *util.SpecialBool `url:"disable,omitempty" json:"disable,omitempty"`                   // Flag to disable the config.
	Nodes           *string           `url:"nodes,omitempty" json:"nodes,omitempty"`                       // List of cluster node names.
	ValidationDelay *int              `url:"validation-delay,omitempty" json:"validation-delay,omitempty"` // Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
}