provider

Documentation

Index

• Constants
• Variables
• func New(version string) func() provider.Provider
• func ToSnakeCase(s string) string
• func ValidName(s string) string
• type BulkSchedule
• type Filter
• type Override
• type Provider
  • func (p *Provider) ConfigValidators(context.Context) []provider.ConfigValidator
  • func (p *Provider) Configure(ctx context.Context, req provider.ConfigureRequest, ...)
  • func (p *Provider) DataSources(ctx context.Context) []func() datasource.DataSource
  • func (p *Provider) Metadata(ctx context.Context, req provider.MetadataRequest, ...)
  • func (p *Provider) Resources(ctx context.Context) []func() resource.Resource
  • func (p *Provider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse)
• type ProviderData
• type Target

Constants

const (
	// Name is the name of the provider.
	Name = "polytomic"

	//PolytomicDeploymentKey is the environment variable name for the Polytomic deployment key
	PolytomicDeploymentKey = "POLYTOMIC_DEPLOYMENT_KEY"
	//PolytomicAPIKey is the environment variable name for the Polytomic API key
	PolytomicAPIKey = "POLYTOMIC_API_KEY"
	//PolytomicDeploymentURL is the environment variable name for the Polytomic deployment URL
	PolytomicDeploymentURL = "POLYTOMIC_DEPLOYMENT_URL"

	PolytomicDefaultURL = "app.polytomic.com"
)

Variables

var (
	// ConnectionsMap is a map of all the connections that can be imported as
	// resources.
	ConnectionsMap = connectionsMap()

	// ConnectionDatasourcesMap is a map of all the connections that can be
	// imported as data sources.
	ConnectionDatasourcesMap = datasourcesMap()
)

Functions

func New

func New(version string) func() provider.Provider

func ToSnakeCase

func ToSnakeCase(s string) string

func ValidName

func ValidName(s string) string

A name must start with a letter or underscore and may contain only letters, digits, underscores, and dashes. e.g 100_users -> _100_users

Types

type BulkSchedule

type BulkSchedule struct {
	DayOfMonth *string `json:"day_of_month" url:"day_of_month,omitempty" tfsdk:"day_of_month"`
	DayOfWeek  *string `json:"day_of_week" url:"day_of_week,omitempty" tfsdk:"day_of_week"`
	Frequency  string  `json:"frequency" url:"frequency,omitempty" tfsdk:"frequency"`
	Hour       *string `json:"hour" url:"hour,omitempty" tfsdk:"hour"`
	Minute     *string `json:"minute" url:"minute,omitempty" tfsdk:"minute"`
	Month      *string `json:"month" url:"month,omitempty" tfsdk:"month"`
}

type Filter

type Filter struct {
	FieldID   string  `json:"field_id" tfsdk:"field_id" mapstructure:"field_id"`
	FieldType string  `json:"field_type" tfsdk:"field_type" mapstructure:"field_type"`
	Function  string  `json:"function" tfsdk:"function" mapstructure:"function"`
	Value     *string `json:"value" tfsdk:"value" mapstructure:"value"`
	Label     string  `json:"label" tfsdk:"label" mapstructure:"label"`
}

type Override

type Override struct {
	FieldID  string  `json:"field_id" tfsdk:"field_id" mapstructure:"field_id"`
	Function string  `json:"function" tfsdk:"function" mapstructure:"function"`
	Value    *string `json:"value" tfsdk:"value" mapstructure:"value"`
	Override *string `json:"override" tfsdk:"override" mapstructure:"override"`
}

type Provider

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

Provider satisfies the tfsdk.Provider interface and usually is included with all Resource and DataSource implementations.

func (*Provider) ConfigValidators

func (p *Provider) ConfigValidators(context.Context) []provider.ConfigValidator

func (*Provider) Configure

func (p *Provider) Configure(ctx context.Context, req provider.ConfigureRequest, resp *provider.ConfigureResponse)

func (*Provider) DataSources

func (p *Provider) DataSources(ctx context.Context) []func() datasource.DataSource

func (*Provider) Metadata

func (p *Provider) Metadata(ctx context.Context, req provider.MetadataRequest, resp *provider.MetadataResponse)

func (*Provider) Resources

func (p *Provider) Resources(ctx context.Context) []func() resource.Resource

func (*Provider) Schema

func (p *Provider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse)

type ProviderData

type ProviderData struct {
	DeploymentKey types.String `tfsdk:"deployment_api_key"`
	DeploymentUrl types.String `tfsdk:"deployment_url"`

	PartnerKey       types.String `tfsdk:"partner_key"`
	OrganizationUser types.String `tfsdk:"organization_user"`

	APIKey types.String `tfsdk:"api_key"`
}

ProviderData holds the provider configuration, which is used to construct Polytomic clients.

type Target

type Target struct {
	ConnectionID  string  `json:"connection_id" tfsdk:"connection_id" mapstructure:"connection_id"`
	Object        *string `json:"object" tfsdk:"object" mapstructure:"object"`
	SearchValues  string  `json:"search_values,omitempty" tfsdk:"search_values" mapstructure:"search_values,omitempty"`
	Configuration string  `json:"configuration,omitempty" tfsdk:"configuration" mapstructure:"configuration,omitempty"`
	NewName       *string `json:"new_name,omitempty" tfsdk:"new_name" mapstructure:"new_name"`
	FilterLogic   *string `json:"filter_logic,omitempty" tfsdk:"filter_logic" mapstructure:"filter_logic"`
}