Documentation
¶
Index ¶
- func GetFunctionName(i interface{}) string
- type Config
- type Migrator
- type Provider
- func (p *Provider) ConfigureProvider(ctx context.Context, request *cqproto.ConfigureProviderRequest) (*cqproto.ConfigureProviderResponse, error)
- func (p *Provider) FetchResources(ctx context.Context, request *cqproto.FetchResourcesRequest, ...) error
- func (p *Provider) GetProviderConfig(_ context.Context, _ *cqproto.GetProviderConfigRequest) (*cqproto.GetProviderConfigResponse, error)
- func (p *Provider) GetProviderSchema(_ context.Context, _ *cqproto.GetProviderSchemaRequest) (*cqproto.GetProviderSchemaResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetFunctionName ¶
func GetFunctionName(i interface{}) string
Types ¶
type Config ¶
type Config interface {
// Example returns a configuration example (with comments) so user clients can generate an example config
Example() string
}
Config Every provider implements a resources field we only want to extract that in fetch execution
type Migrator ¶
type Migrator struct {
// contains filtered or unexported fields
}
Migrator handles creation of schema.Table in database if they don't exist
type Provider ¶
type Provider struct {
// Name of plugin i.e aws,gcp, azure etc'
Name string
// Version of the provider
Version string
// Configure the provider and return context
Configure func(hclog.Logger, interface{}) (schema.ClientMeta, error)
// ResourceMap is all resources supported by this plugin
ResourceMap map[string]*schema.Table
// Configuration decoded from configure request
Config func() Config
// Logger to call, this logger is passed to the serve.Serve Client, if not define Serve will create one instead.
Logger hclog.Logger
// contains filtered or unexported fields
}
Provider is the base structure required to pass and serve an sdk provider.Provider
func (*Provider) ConfigureProvider ¶ added in v0.2.0
func (p *Provider) ConfigureProvider(ctx context.Context, request *cqproto.ConfigureProviderRequest) (*cqproto.ConfigureProviderResponse, error)
func (*Provider) FetchResources ¶ added in v0.2.0
func (p *Provider) FetchResources(ctx context.Context, request *cqproto.FetchResourcesRequest, sender cqproto.FetchResourcesSender) error
func (*Provider) GetProviderConfig ¶ added in v0.2.0
func (p *Provider) GetProviderConfig(_ context.Context, _ *cqproto.GetProviderConfigRequest) (*cqproto.GetProviderConfigResponse, error)
func (*Provider) GetProviderSchema ¶ added in v0.2.0
func (p *Provider) GetProviderSchema(_ context.Context, _ *cqproto.GetProviderSchemaRequest) (*cqproto.GetProviderSchemaResponse, error)
Directories
¶
| Path | Synopsis |
|---|---|
|
Package docs helps create provider documentation
|
Package docs helps create provider documentation |
Click to show internal directories.
Click to hide internal directories.