client

Documentation

Index

• type APIError
  • func (e *APIError) Error() string
• type Change
• type DopplerClient
  • func NewDopplerClient(dopplerToken string) (*DopplerClient, error)
  • func (c *DopplerClient) Authenticate() error
  • func (c *DopplerClient) BaseURL() *url.URL
  • func (c *DopplerClient) GetSecret(request SecretRequest) (*SecretResponse, error)
  • func (c *DopplerClient) GetSecrets(request SecretsRequest) (*SecretsResponse, error)
  • func (c *DopplerClient) SetBaseURL(urlStr string) error
  • func (c *DopplerClient) UpdateSecrets(request UpdateSecretsRequest) error
• type SecretRequest
• type SecretResponse
• type Secrets
• type SecretsRequest
• type SecretsResponse
• type UpdateSecretsRequest

Types

type APIError

type APIError struct {
	Err     error
	Message string
	Data    string
}

func (*APIError) Error

func (e *APIError) Error() string

type Change

type Change struct {
	Name         string  `json:"name"`
	OriginalName string  `json:"originalName"`
	Value        *string `json:"value"`
	ShouldDelete bool    `json:"shouldDelete,omitempty"`
}

type DopplerClient

type DopplerClient struct {
	DopplerToken string
	VerifyTLS    bool
	UserAgent    string
	// contains filtered or unexported fields
}

func NewDopplerClient

func NewDopplerClient(dopplerToken string) (*DopplerClient, error)

func (*DopplerClient) Authenticate

func (c *DopplerClient) Authenticate() error

func (*DopplerClient) BaseURL

func (c *DopplerClient) BaseURL() *url.URL

func (*DopplerClient) GetSecret

func (c *DopplerClient) GetSecret(request SecretRequest) (*SecretResponse, error)

func (*DopplerClient) GetSecrets

func (c *DopplerClient) GetSecrets(request SecretsRequest) (*SecretsResponse, error)

GetSecrets should only have an ETag supplied if Secrets are cached as SecretsResponse.Secrets will be nil if 304 (not modified) returned.

func (*DopplerClient) SetBaseURL

func (c *DopplerClient) SetBaseURL(urlStr string) error

func (*DopplerClient) UpdateSecrets

func (c *DopplerClient) UpdateSecrets(request UpdateSecretsRequest) error

type SecretRequest

type SecretRequest struct {
	Name    string
	Project string
	Config  string
}

type SecretResponse

type SecretResponse struct {
	Name  string
	Value string
}

type Secrets

type Secrets map[string]string

type SecretsRequest

type SecretsRequest struct {
	Project         string
	Config          string
	NameTransformer string
	Format          string
	ETag            string // Specifying an ETag implies that the caller has implemented response caching
}

type SecretsResponse

type SecretsResponse struct {
	Secrets  Secrets
	Body     []byte
	Modified bool
	ETag     string
}

type UpdateSecretsRequest

type UpdateSecretsRequest struct {
	Secrets        Secrets  `json:"secrets,omitempty"`
	ChangeRequests []Change `json:"change_requests,omitempty"`
	Project        string   `json:"project,omitempty"`
	Config         string   `json:"config,omitempty"`
}