data_source

Documentation

Index

• Constants
• func SetMetaData(ctx context.Context, config *types.BaseTargetConfig, ...) error
• type DataSourceImportConfig
• type DataSourceImportResult
• type DataSourceImporter
  • func NewDataSourceImporter(config *DataSourceImportConfig, statusUpdater job.TaskEventUpdater) DataSourceImporter
• type DataSourceSync
  • func (s *DataSourceSync) GetParts() []job.TaskPart
  • func (s *DataSourceSync) GetResultObject() interface{}
  • func (s *DataSourceSync) GetTaskResults() []job.TaskResult
  • func (s *DataSourceSync) IsClientValid(ctx context.Context, c plugin.PluginClient) (bool, error)
  • func (s *DataSourceSync) ProcessResults(results interface{}) error
  • func (s *DataSourceSync) StartSyncAndQueueTaskPart(ctx context.Context, client plugin.PluginClient, ...) (job.JobStatus, string, error)
• type PostProcessor
  • func NewPostProcessor(config *PostProcessorConfig) PostProcessor
  • func (p *PostProcessor) Close(_ context.Context) error
  • func (p *PostProcessor) NeedsPostProcessing() bool
  • func (p *PostProcessor) PostProcess(inputFilePath string, outputFile string) (*PostProcessorResult, error)
• type PostProcessorConfig
• type PostProcessorOutputFileWriter
• type PostProcessorResult
• type QueryResponse
• type Response

Constants

const JSON_EXTENSION = ".json"

Functions

func SetMetaData

func SetMetaData(ctx context.Context, config *types.BaseTargetConfig, metadata *data_source.MetaData) error

Types

type DataSourceImportConfig

type DataSourceImportConfig struct {
	types.BaseTargetConfig
	TargetFile      string
	DeleteUntouched bool

	// TagSourcesScope is the set of sources that will be looked at when merging the tags. Tags with other sources will remain untouched.
	// If not specified, the default is to take all sources for which tags are defined in the import file.
	TagSourcesScope []string `json:"tagSourcesScope"`
}

type DataSourceImportResult

type DataSourceImportResult struct {
	DataObjectsAdded   int `json:"dataObjectsAdded"`
	DataObjectsUpdated int `json:"dataObjectsUpdated"`
	DataObjectsRemoved int `json:"dataObjectsRemoved"`

	Warnings []string `json:"warnings"`
}

type DataSourceImporter

type DataSourceImporter interface {
	TriggerImport(ctx context.Context, jobId string) (job.JobStatus, string, error)
}

func NewDataSourceImporter

func NewDataSourceImporter(config *DataSourceImportConfig, statusUpdater job.TaskEventUpdater) DataSourceImporter

type DataSourceSync

type DataSourceSync struct {
	TargetConfig *types.BaseTargetConfig
	JobId        string
	// contains filtered or unexported fields
}

func (*DataSourceSync) GetParts

func (s *DataSourceSync) GetParts() []job.TaskPart

func (*DataSourceSync) GetResultObject

func (s *DataSourceSync) GetResultObject() interface{}

func (*DataSourceSync) GetTaskResults

func (s *DataSourceSync) GetTaskResults() []job.TaskResult

func (*DataSourceSync) IsClientValid

func (s *DataSourceSync) IsClientValid(ctx context.Context, c plugin.PluginClient) (bool, error)

func (*DataSourceSync) ProcessResults

func (s *DataSourceSync) ProcessResults(results interface{}) error

func (*DataSourceSync) StartSyncAndQueueTaskPart

func (s *DataSourceSync) StartSyncAndQueueTaskPart(ctx context.Context, client plugin.PluginClient, statusUpdater job.TaskEventUpdater) (job.JobStatus, string, error)

type PostProcessor

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

func NewPostProcessor

func NewPostProcessor(config *PostProcessorConfig) PostProcessor

func (*PostProcessor) Close

func (p *PostProcessor) Close(_ context.Context) error

func (*PostProcessor) NeedsPostProcessing

func (p *PostProcessor) NeedsPostProcessing() bool

func (*PostProcessor) PostProcess

func (p *PostProcessor) PostProcess(inputFilePath string, outputFile string) (*PostProcessorResult, error)

type PostProcessorConfig

type PostProcessorConfig struct {
	TagOverwriteKeyForOwners string
	DataSourceId             string
	DataObjectParent         string
	DataObjectExcludes       []string
	TargetLogger             hclog.Logger
}

type PostProcessorOutputFileWriter

type PostProcessorOutputFileWriter interface {
	AddDataObjects(dataObjects ...*data_source.DataObject) error
}

type PostProcessorResult

type PostProcessorResult struct {
	DataObjectsTouchedCount int
}

type QueryResponse

type QueryResponse struct {
	Subtask subtaskResponse `json:"subtask"`
}

type Response

type Response struct {
	Response QueryResponse `json:"importDataSourceRequest"`
}