pdcp

Documentation

Index

• Constants
• Variables
• type UploadWriter
  • func NewUploadWriterCallback(ctx context.Context, creds *pdcpauth.PDCPCredentials) (*UploadWriter, error)
  • func (u *UploadWriter) Close()
  • func (u *UploadWriter) GetWriterCallback() runner.OnResultCallback
  • func (u *UploadWriter) SetAssetGroupName(name string)
  • func (u *UploadWriter) SetAssetID(id string) error
  • func (u *UploadWriter) SetTeamID(id string)

Constants

const (
	MaxChunkSize = 4 * unitutils.Mega // 4 MB

	NoneTeamID = "none"
)

Variables

var (

	// EnableeUpload if set to true enables the upload feature
	HideAutoSaveMsg   = env.GetEnvOrDefault("DISABLE_CLOUD_UPLOAD_WRN", false)
	EnableCloudUpload = env.GetEnvOrDefault("ENABLE_CLOUD_UPLOAD", false)
)

Types

type UploadWriter

type UploadWriter struct {
	TeamID string
	// contains filtered or unexported fields
}

UploadWriter is a writer that uploads its output to pdcp server to enable web dashboard and more

func NewUploadWriterCallback

func NewUploadWriterCallback(ctx context.Context, creds *pdcpauth.PDCPCredentials) (*UploadWriter, error)

NewUploadWriterCallback creates a new upload writer callback which when enabled periodically uploads the results to pdcp assets dashboard

func (*UploadWriter) Close

func (u *UploadWriter) Close()

Close closes the upload writer

func (*UploadWriter) GetWriterCallback

func (u *UploadWriter) GetWriterCallback() runner.OnResultCallback

GetWriterCallback returns the writer callback

func (*UploadWriter) SetAssetGroupName

func (u *UploadWriter) SetAssetGroupName(name string)

SetAssetGroupName sets the scan name for the upload writer

func (*UploadWriter) SetAssetID

func (u *UploadWriter) SetAssetID(id string) error

SetAssetID sets the scan id for the upload writer

func (*UploadWriter) SetTeamID

func (u *UploadWriter) SetTeamID(id string)

SetTeamID sets the team id for the upload writer