datarouter

Documentation

Index

• func RegisterDataSource(data DataSource) func(Router) Router
• type DataSource
• type DataSourceServerAdapter
• type Router
  • func New(opts ...RouterOpt) Router
  • func (r Router) ReadDataSource(ctx context.Context, req *tfprotov6.ReadDataSourceRequest, meta tftypes.Value) (*tfprotov6.ReadDataSourceResponse, error)
  • func (r Router) Schemas() map[string]*tfprotov6.Schema
  • func (r Router) ValidateDataResourceConfig(ctx context.Context, req *tfprotov6.ValidateDataResourceConfigRequest, ...) (*tfprotov6.ValidateDataResourceConfigResponse, error)
• type RouterOpt

Functions

func RegisterDataSource

func RegisterDataSource(data DataSource) func(Router) Router

RegisterDataSource registers a DataSource with the Router.

Types

type DataSource

type DataSource interface {
	DataSourceServerAdapter
	Name() string
	Schema() *tfprotov6.Schema
	SetProviderConfig(val tftypes.Value) error
}

DataSource is the DataSource.

type DataSourceServerAdapter

type DataSourceServerAdapter interface {
	ValidateDataResourceConfig(ctx context.Context, req tfprotov6.ValidateDataResourceConfigRequest, res *tfprotov6.ValidateDataResourceConfigResponse)
	ReadDataSource(ctx context.Context, req tfprotov6.ReadDataSourceRequest, res *tfprotov6.ReadDataSourceResponse)
}

DataSourceServerAdapter Adapter for a tfprotov6.DataSourceServer removing the error return type from all methods.

type Router

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

Router routes requests to the various data resources.

func New

func New(opts ...RouterOpt) Router

New takes zero or more functional options and return a new DataSource router.

func (Router) ReadDataSource

func (r Router) ReadDataSource(ctx context.Context, req *tfprotov6.ReadDataSourceRequest, meta tftypes.Value) (*tfprotov6.ReadDataSourceResponse, error)

ReadDataSource refreshes the data sources state.

func (Router) Schemas

func (r Router) Schemas() map[string]*tfprotov6.Schema

Schemas returns the data router schemas.

func (Router) ValidateDataResourceConfig

func (r Router) ValidateDataResourceConfig(ctx context.Context, req *tfprotov6.ValidateDataResourceConfigRequest, meta tftypes.Value) (*tfprotov6.ValidateDataResourceConfigResponse, error)

ValidateDataResourceConfig validates the data sources config.

type RouterOpt

type RouterOpt func(Router) Router

RouterOpt is a functional option for the data router.