Documentation
¶
Index ¶
- Constants
- type GistUnit
- type RepoUnit
- type Source
- func (s *Source) Chunks(ctx context.Context, chunksChan chan *sources.Chunk, ...) error
- func (s *Source) Init(aCtx context.Context, name string, jobID sources.JobID, ...) error
- func (s *Source) JobID() sources.JobID
- func (s *Source) SourceID() sources.SourceID
- func (s *Source) Type() sourcespb.SourceType
- func (s *Source) Validate(ctx context.Context) []error
- func (s *Source) WithCustomContentWriter()
- func (s *Source) WithScanOptions(scanOptions *git.ScanOptions)
Constants ¶
View Source
const (
SourceType = sourcespb.SourceType_SOURCE_TYPE_GITHUB
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GistUnit ¶ added in v3.82.2
type GistUnit struct {
// contains filtered or unexported fields
}
func (GistUnit) SourceUnitID ¶ added in v3.82.2
func (g GistUnit) SourceUnitID() (string, sources.SourceUnitKind)
type RepoUnit ¶ added in v3.82.2
type RepoUnit struct {
// contains filtered or unexported fields
}
func (RepoUnit) SourceUnitID ¶ added in v3.82.2
func (r RepoUnit) SourceUnitID() (string, sources.SourceUnitKind)
type Source ¶
type Source struct {
sources.Progress
sources.CommonSourceUnitUnmarshaller
// contains filtered or unexported fields
}
func (*Source) Chunks ¶
func (s *Source) Chunks(ctx context.Context, chunksChan chan *sources.Chunk, targets ...sources.ChunkingTarget) error
Chunks emits chunks of bytes over a channel.
func (*Source) Init ¶
func (s *Source) Init(aCtx context.Context, name string, jobID sources.JobID, sourceID sources.SourceID, verify bool, connection *anypb.Any, concurrency int) error
Init returns an initialized GitHub source.
func (*Source) Type ¶
func (s *Source) Type() sourcespb.SourceType
Type returns the type of source. It is used for matching source types in configuration and job input.
func (*Source) Validate ¶ added in v3.53.0
Validate is used by enterprise CLI to validate the GitHub config file.
func (*Source) WithCustomContentWriter ¶ added in v3.66.3
func (s *Source) WithCustomContentWriter()
WithCustomContentWriter sets the useCustomContentWriter flag on the source.
func (*Source) WithScanOptions ¶ added in v3.28.0
func (s *Source) WithScanOptions(scanOptions *git.ScanOptions)
Source Files
Click to show internal directories.
Click to hide internal directories.