cqproto

type CQPlugin struct {
	// GRPCPlugin must still implement the Stub interface
	plugin.Plugin
	// Concrete implementation, written in Go. This is only used for plugins
	// that are written in Go.
	Impl CQProviderServer
}

type CQProvider interface {
	// GetProviderSchema is called when CloudQuery needs to know what the
	// provider's tables and version
	GetProviderSchema(context.Context, *GetProviderSchemaRequest) (*GetProviderSchemaResponse, error)

	// GetProviderConfig is called when CloudQuery wants to generate a configuration example for a provider
	GetProviderConfig(context.Context, *GetProviderConfigRequest) (*GetProviderConfigResponse, error)

	// ConfigureProvider is called to pass the user-specified provider
	// configuration to the provider.
	ConfigureProvider(context.Context, *ConfigureProviderRequest) (*ConfigureProviderResponse, error)

	// FetchResources is called when CloudQuery requests to fetch one or more resources from the provider.
	// The provider reports back status updates on the resources fetching progress.
	FetchResources(context.Context, *FetchResourcesRequest) (FetchResourcesStream, error)

	// Gets info about specific module config embedded inside provider
	GetModuleInfo(context.Context, *GetModuleRequest) (*GetModuleResponse, error)
}

type CQProviderServer interface {
	// GetProviderSchema is called when CloudQuery needs to know what the
	// provider's tables and version
	GetProviderSchema(context.Context, *GetProviderSchemaRequest) (*GetProviderSchemaResponse, error)

	// GetProviderConfig is called when CloudQuery wants to generate a configuration example for a provider
	GetProviderConfig(context.Context, *GetProviderConfigRequest) (*GetProviderConfigResponse, error)

	// ConfigureProvider is called to pass the user-specified provider
	// configuration to the provider.
	ConfigureProvider(context.Context, *ConfigureProviderRequest) (*ConfigureProviderResponse, error)

	// FetchResources is called when CloudQuery requests to fetch one or more resources from the provider.
	// The provider reports back status updates on the resources fetching progress.
	FetchResources(context.Context, *FetchResourcesRequest, FetchResourcesSender) error

	// Gets info about specific module config embedded inside provider
	GetModuleInfo(context.Context, *GetModuleRequest) (*GetModuleResponse, error)
}

type ConfigureProviderRequest struct {
	// CloudQueryVersion is the version of CloudQuery executing the request.
	CloudQueryVersion string
	// ConnectionDetails holds information regarding connection to the CloudQuery database
	Connection ConnectionDetails
	// Config is the configuration the user supplied for the provider
	Config []byte
	// Fields to inject to every resource on insert
	ExtraFields map[string]interface{}
}

type ConfigureProviderResponse struct {
	// Error should be set to a string describing the error.
	// The error can be either from malformed configuration or failure to setup
	Error string
}

type ConnectionDetails struct {
	Type string
	DSN  string
}

type FailedResourceFetch struct {
	// table name of the failed resource fetch
	TableName string
	// root/parent table name
	RootTableName string
	// root/parent primary key values
	RootPrimaryKeyValues []string
	// error message for this resource fetch failure
	Error string
}

type FetchResourcesRequest struct {
	// List of resources to fetch
	Resources []string
	// PartialFetchingEnabled if true enables partial fetching
	PartialFetchingEnabled bool
	// ParallelFetchingLimit limits parallel resources fetch at a time is more than 0
	ParallelFetchingLimit uint64
	// MaxGoroutines specified an approximate maximum number of goroutines that will be spanwd during fetch
	MaxGoroutines uint64
	// Timeout for each parent resource resolve call
	Timeout time.Duration
	// Metadata for the fetch
	Metadata map[string]interface{}
}

type FetchResourcesResponse struct {
	ResourceName string
	// map of resources that have finished fetching
	FinishedResources map[string]bool
	// Amount of resources collected so far
	ResourceCount uint64
	// Error value if any, if returned the stream will be canceled
	Error string
	// list of resources where the fetching failed
	PartialFetchFailedResources []*FailedResourceFetch
	// fetch summary of resource that finished execution
	Summary ResourceFetchSummary
}

type FetchResourcesSender interface {
	Send(*FetchResourcesResponse) error
}

type FetchResourcesStream interface {
	Recv() (*FetchResourcesResponse, error)
}

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

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

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

type GRPCServer struct {
	// This is the real implementation
	Impl CQProviderServer
	internal.UnimplementedProviderServer
}

type GetModuleRequest struct {
	Module            string
	PreferredVersions []uint32
}

type GetModuleResponse struct {
	Data              map[uint32]ModuleInfo // version vs Info
	AvailableVersions []uint32              // all available versions, regardless of being requested in PreferredVersions or not
	Diagnostics       diag.Diagnostics
}

type GetProviderConfigRequest struct{}

type GetProviderConfigResponse struct {
	Config []byte
}

type GetProviderSchemaRequest struct{}

type GetProviderSchemaResponse struct {
	// Name is the name of the provider being executed
	Name string
	// Version is the current version provider being executed
	Version string
	// ResourceTables is a map of tables this provider creates
	ResourceTables map[string]*schema.Table
	// Migrations scripts available for the provider, for all dialects
	Migrations map[string]map[string][]byte
}

type ModuleFile struct {
	Name     string
	Contents []byte
}

type ModuleInfo struct {
	Files  []*ModuleFile
	Extras map[string]string
}

type ProviderDiagnostic struct {
	ResourceName       string
	ResourceId         []string
	DiagnosticType     diag.DiagnosticType
	DiagnosticSeverity diag.Severity
	Summary            string
	Details            string
}

type ResourceFetchStatus int

type ResourceFetchSummary struct {
	// Execution status of resource
	Status ResourceFetchStatus
	// Total Amount of resources collected by this resource
	ResourceCount uint64
	// Diagnostics of failed resource fetch, the diagnostic provides insights such as severity, summary and
	// details on how to solve this issue
	Diagnostics diag.Diagnostics
}