client

Documentation

Index

• func Configure(logger hclog.Logger, config interface{}) (schema.ClientMeta, error)
• type Client
  • func (c *Client) Logger() hclog.Logger
• type Config
  • func (c Config) Example() string

Functions

func Configure

func Configure(logger hclog.Logger, config interface{}) (schema.ClientMeta, error)

Types

type Client

type Client struct {

	// CHANGEME:  Usually you store here your 3rd party clients and use them in the fetcher
	ThirdPartyClient interface{}
	// contains filtered or unexported fields
}

func (*Client) Logger

func (c *Client) Logger() hclog.Logger

type Config

type Config struct {
	// here goes top level configuration for your provider
	// This object will be pass filled in depending on user's configuration
	// CHANGEME
	ExampleConfig string `hcl:"example_config"`

	// resources that user asked to fetch
	// each resource can have optional additional configurations
	Resources []struct {
		Name  string
		Other map[string]interface{} `hcl:",inline"`
	}
}

func (Config) Example

func (c Config) Example() string