Help us shape the future of Go! Take the 2026 Go Developer Survey

provider

package
v0.12.778 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2026 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SchemaDelimiter string = docparser.SchemaDelimiter
)

Variables

View Source
var (
	DummyAuth bool = false //nolint:revive,gochecknoglobals // prefer declarative
)

Functions

This section is empty.

Types

type GenericProvider

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

func (*GenericProvider) Auth

func (gp *GenericProvider) Auth(
	authCtx *dto.AuthCtx,
	authTypeRequested string,
	enforceRevokeFirst bool,
) (*http.Client, error)

func (*GenericProvider) AuthRevoke

func (gp *GenericProvider) AuthRevoke(authCtx *dto.AuthCtx) error

func (*GenericProvider) CheckCredentialFile

func (gp *GenericProvider) CheckCredentialFile(authCtx *dto.AuthCtx) error

func (*GenericProvider) EnhanceMetadataFilter

func (gp *GenericProvider) EnhanceMetadataFilter(
	metadataType string,
	metadataFilter func(formulation.ITable) (formulation.ITable, error),
	colsVisited map[string]bool,
) (func(formulation.ITable) (formulation.ITable, error), error)

func (*GenericProvider) GetCurrentService

func (gp *GenericProvider) GetCurrentService() string

func (*GenericProvider) GetDefaultHTTPClient added in v0.9.337

func (gp *GenericProvider) GetDefaultHTTPClient() *http.Client

func (*GenericProvider) GetDefaultKeyForDeleteItems

func (gp *GenericProvider) GetDefaultKeyForDeleteItems() string

func (*GenericProvider) GetFirstMethodForAction

func (gp *GenericProvider) GetFirstMethodForAction(
	serviceName string,
	resourceName string,
	iqlAction string,
	runtimeCtx dto.RuntimeCtx,
) (formulation.StandardOperationStore, string, error)

func (*GenericProvider) GetLikeableColumns

func (gp *GenericProvider) GetLikeableColumns(tableName string) []string

func (*GenericProvider) GetMethodForAction

func (gp *GenericProvider) GetMethodForAction(
	serviceName string,
	resourceName string,
	iqlAction string,
	parameters parserutil.ColumnKeyedDatastore,
	runtimeCtx dto.RuntimeCtx,
) (formulation.StandardOperationStore, string, error)

func (*GenericProvider) GetMethodSelector

func (gp *GenericProvider) GetMethodSelector() methodselect.IMethodSelector

func (*GenericProvider) GetObjectSchema

func (gp *GenericProvider) GetObjectSchema(
	serviceName string,
	resourceName string,
	schemaName string,
) (formulation.Schema, error)

func (*GenericProvider) GetProvider

func (gp *GenericProvider) GetProvider() (formulation.Provider, error)

func (*GenericProvider) GetProviderServicesRedacted

func (gp *GenericProvider) GetProviderServicesRedacted(
	runtimeCtx dto.RuntimeCtx,
	extended bool,
) (map[string]formulation.ProviderService, error)

func (*GenericProvider) GetProviderString

func (gp *GenericProvider) GetProviderString() string

func (*GenericProvider) GetResource

func (gp *GenericProvider) GetResource(
	serviceKey string,
	resourceKey string,
	runtimeCtx dto.RuntimeCtx,
) (formulation.Resource, error)

func (*GenericProvider) GetResourcesMap

func (gp *GenericProvider) GetResourcesMap(
	serviceKey string,
	runtimeCtx dto.RuntimeCtx,
) (map[string]formulation.Resource, error)

func (*GenericProvider) GetResourcesRedacted

func (gp *GenericProvider) GetResourcesRedacted(
	currentService string,
	runtimeCtx dto.RuntimeCtx,
	extended bool,
) (map[string]formulation.Resource, error)

func (*GenericProvider) GetServiceShard

func (gp *GenericProvider) GetServiceShard(
	serviceKey string,
	resourceKey string,
	runtimeCtx dto.RuntimeCtx,
) (formulation.Service, error)

func (*GenericProvider) GetVersion

func (gp *GenericProvider) GetVersion() string

func (*GenericProvider) InferDescribeMethod

func (*GenericProvider) InferMaxResultsElement

func (*GenericProvider) InferNextPageRequestElement

func (gp *GenericProvider) InferNextPageRequestElement(ho internaldto.Heirarchy) sdk_internal_dto.HTTPElement

func (*GenericProvider) InferNextPageResponseElement

func (gp *GenericProvider) InferNextPageResponseElement(ho internaldto.Heirarchy) sdk_internal_dto.HTTPElement

func (*GenericProvider) PersistStaticExternalSQLDataSource

func (gp *GenericProvider) PersistStaticExternalSQLDataSource(runtimeCtx dto.RuntimeCtx) error

func (*GenericProvider) SetCurrentService

func (gp *GenericProvider) SetCurrentService(serviceKey string)

func (*GenericProvider) ShowAuth

func (gp *GenericProvider) ShowAuth(authCtx *dto.AuthCtx) (*formulation.AuthMetadata, error)

type IProvider

type IProvider interface {
	Auth(authCtx *dto.AuthCtx, authTypeRequested string, enforceRevokeFirst bool) (*http.Client, error)

	AuthRevoke(authCtx *dto.AuthCtx) error

	CheckCredentialFile(authCtx *dto.AuthCtx) error

	GetDefaultHTTPClient() *http.Client

	EnhanceMetadataFilter(
		string,
		func(formulation.ITable) (formulation.ITable, error),
		map[string]bool) (func(formulation.ITable) (formulation.ITable, error), error)

	GetCurrentService() string

	GetDefaultKeyForDeleteItems() string

	GetFirstMethodForAction(
		serviceName string,
		resourceName string,
		iqlAction string,
		runtimeCtx dto.RuntimeCtx) (formulation.StandardOperationStore, string, error)

	GetLikeableColumns(string) []string

	GetMethodForAction(
		serviceName string,
		resourceName string,
		iqlAction string,
		parameters parserutil.ColumnKeyedDatastore,
		runtimeCtx dto.RuntimeCtx) (formulation.StandardOperationStore, string, error)

	GetMethodSelector() methodselect.IMethodSelector

	GetProvider() (formulation.Provider, error)

	GetProviderString() string

	GetProviderServicesRedacted(
		runtimeCtx dto.RuntimeCtx,
		extended bool) (map[string]formulation.ProviderService, error)

	GetResource(serviceKey string, resourceKey string, runtimeCtx dto.RuntimeCtx) (formulation.Resource, error)

	GetResourcesMap(
		serviceKey string,
		runtimeCtx dto.RuntimeCtx) (map[string]formulation.Resource, error)

	GetResourcesRedacted(
		currentService string,
		runtimeCtx dto.RuntimeCtx,
		extended bool) (map[string]formulation.Resource, error)

	GetServiceShard(serviceKey string, resourceKey string, runtimeCtx dto.RuntimeCtx) (formulation.Service, error)

	GetObjectSchema(serviceName string, resourceName string, schemaName string) (formulation.Schema, error)

	GetVersion() string

	InferDescribeMethod(formulation.Resource) (formulation.StandardOperationStore, string, error)

	InferMaxResultsElement(formulation.OperationStore) sdk_internal_dto.HTTPElement

	InferNextPageRequestElement(internaldto.Heirarchy) sdk_internal_dto.HTTPElement

	InferNextPageResponseElement(internaldto.Heirarchy) sdk_internal_dto.HTTPElement

	PersistStaticExternalSQLDataSource(dto.RuntimeCtx) error

	SetCurrentService(serviceKey string)

	ShowAuth(authCtx *dto.AuthCtx) (*formulation.AuthMetadata, error)
}

func GenerateProvider added in v0.9.250

func GenerateProvider(
	runtimeCtx dto.RuntimeCtx,
	providerStr,
	providerVersion string,
	reg formulation.RegistryAPI,
	sqlSystem sql_system.SQLSystem,
	persistenceSystem formulation.PersistenceSystem,
	defaultHTTPClient *http.Client,
) (IProvider, error)

type ProviderParam

type ProviderParam struct {
	Id     string //nolint:revive,stylecheck // TODO: review
	Type   string
	Format string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL