Documentation
¶
Index ¶
- func AWSFactory(ctx context.Context) awsfactory.AWSFactory
- func AclCatalogAuthoriser(ctx context.Context) *catalogacl.CatalogAuthorizer
- func AclCatalogShare(ctx context.Context) *catalogacl.ShareAlbumCase
- func AclCatalogUnShare(ctx context.Context) *catalogacl.UnShareAlbumCase
- func AclQueries(ctx context.Context) *aclcore.ScopeQueries
- func AclRepository(ctx context.Context) *aclscopedynamodb.Repository
- func AlbumQueries(ctx context.Context) *catalog.AlbumQueries
- func AlbumView(ctx context.Context) *catalogviews.AlbumView
- func AlbumViewRepository(ctx context.Context) *catalogviewsdynamodb.AlbumViewRepository
- func CatalogMediaQueries(ctx context.Context) *catalog.MediaQueries
- func CatalogRepository(ctx context.Context) *catalogdynamo.Repository
- func CatalogToACLAdapter(ctx context.Context) *catalogacl.ReverseReader
- func InsertMediasCase(ctx context.Context) *catalog.InsertMedias
- func NewInsertMediaAdapter(ctx context.Context) backup.InsertMediaPort
- func OwnerDriftReconciler(ctx context.Context, dry bool, options ...catalogviews.DriftOption) *catalogviews.OwnerDriftReconciler
- func TimelineRepository(ctx context.Context) *catalog.TimelineRepositoryAdapter
- type ASyncArchiveAdapterForCatalog
- type AWSAdapterNames
- type AWSCloud
- type AWSCloudBuilder
- type AlbumCreatorCataloguerFactory
- type ArchiveAdapterForCatalog
- type ArchiveFactory
- type AsyncArchiveFactory
- type CatalogFactory
- type DryRunCataloguerFactory
- type Factory
- type MultiFilesBackup
- type MultiFilesScanner
- type SimpleCatalogFactory
- func (s *SimpleCatalogFactory) AmendAlbumDatesCase(ctx context.Context) *catalog.AmendAlbumDates
- func (s *SimpleCatalogFactory) CreateAlbumCase(ctx context.Context) *catalog.CreateAlbum
- func (s *SimpleCatalogFactory) CreateAlbumDeleteCase(ctx context.Context) *catalog.DeleteAlbum
- func (s *SimpleCatalogFactory) RenameAlbumCase(ctx context.Context) *catalog.RenameAlbum
- type StaticAWSAdapterNames
- func (s StaticAWSAdapterNames) ArchiveCacheBucketName() string
- func (s StaticAWSAdapterNames) ArchiveJobsSNSARN() string
- func (s StaticAWSAdapterNames) ArchiveJobsSQSURL() string
- func (s StaticAWSAdapterNames) ArchiveMainBucketName() string
- func (s StaticAWSAdapterNames) ArchiveRelocateJobsSQSURL() string
- func (s StaticAWSAdapterNames) DynamoDBName() string
- type SyncArchiveAdapterForCatalog
- type SyncArchiveFactory
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AWSFactory ¶
func AWSFactory(ctx context.Context) awsfactory.AWSFactory
func AclCatalogAuthoriser ¶ added in v1.6.4
func AclCatalogAuthoriser(ctx context.Context) *catalogacl.CatalogAuthorizer
func AclCatalogShare ¶ added in v1.6.4
func AclCatalogShare(ctx context.Context) *catalogacl.ShareAlbumCase
func AclCatalogUnShare ¶ added in v1.6.4
func AclCatalogUnShare(ctx context.Context) *catalogacl.UnShareAlbumCase
func AclQueries ¶ added in v1.5.49
func AclQueries(ctx context.Context) *aclcore.ScopeQueries
func AclRepository ¶ added in v1.5.49
func AclRepository(ctx context.Context) *aclscopedynamodb.Repository
func AlbumQueries ¶ added in v1.6.4
func AlbumQueries(ctx context.Context) *catalog.AlbumQueries
func AlbumViewRepository ¶ added in v1.6.4
func AlbumViewRepository(ctx context.Context) *catalogviewsdynamodb.AlbumViewRepository
func CatalogMediaQueries ¶ added in v1.6.4
func CatalogMediaQueries(ctx context.Context) *catalog.MediaQueries
func CatalogRepository ¶
func CatalogRepository(ctx context.Context) *catalogdynamo.Repository
func CatalogToACLAdapter ¶ added in v1.6.4
func CatalogToACLAdapter(ctx context.Context) *catalogacl.ReverseReader
func InsertMediasCase ¶ added in v1.5.47
func InsertMediasCase(ctx context.Context) *catalog.InsertMedias
func NewInsertMediaAdapter ¶ added in v1.5.57
func NewInsertMediaAdapter(ctx context.Context) backup.InsertMediaPort
func OwnerDriftReconciler ¶ added in v1.6.7
func OwnerDriftReconciler(ctx context.Context, dry bool, options ...catalogviews.DriftOption) *catalogviews.OwnerDriftReconciler
func TimelineRepository ¶ added in v1.9.53
func TimelineRepository(ctx context.Context) *catalog.TimelineRepositoryAdapter
Types ¶
type ASyncArchiveAdapterForCatalog ¶ added in v1.7.10
type ASyncArchiveAdapterForCatalog struct {
AWSFactory awsfactory.AWSFactory
AWSAdapterNames AWSAdapterNames
}
func (*ASyncArchiveAdapterForCatalog) ArchiveTimelineMutationObserver ¶ added in v1.7.10
func (s *ASyncArchiveAdapterForCatalog) ArchiveTimelineMutationObserver(ctx context.Context) catalog.TimelineMutationObserver
type AWSAdapterNames ¶
type AWSAdapterNames interface {
DynamoDBName() string
ArchiveMainBucketName() string
ArchiveCacheBucketName() string
ArchiveJobsSNSARN() string
ArchiveJobsSQSURL() string
ArchiveRelocateJobsSQSURL() string
}
var (
AWSNames AWSAdapterNames // Names provides the config required by the adapters
)
type AWSCloud ¶ added in v1.6.13
type AWSCloud struct {
awsfactory.AWSFactory
ArchiveFactory
*SimpleCatalogFactory
Names AWSAdapterNames
}
func (*AWSCloud) InitArchive ¶ added in v1.6.18
type AWSCloudBuilder ¶ added in v1.6.13
type AWSCloudBuilder struct {
// contains filtered or unexported fields
}
func StartAWSCloudBuilder ¶ added in v1.6.13
func StartAWSCloudBuilder(names AWSAdapterNames) *AWSCloudBuilder
StartAWSCloudBuilder creates a version of the application directly connected to AWS cloud using DynamoDB and S3.
func (*AWSCloudBuilder) Build ¶ added in v1.6.13
func (a *AWSCloudBuilder) Build(ctx context.Context) (*AWSCloud, error)
Build creates the application factory ; and set legacy global variables
func (*AWSCloudBuilder) OverridesAWSFactory ¶ added in v1.6.13
func (a *AWSCloudBuilder) OverridesAWSFactory(factory awsfactory.AWSFactory, err error) *AWSCloudBuilder
OverridesAWSFactory allows to use an alternative AWS configuration where credentials are not contextual (unlike lambdas)
func (*AWSCloudBuilder) WithAdvancedAWSAsyncFeatures ¶ added in v1.6.13
func (a *AWSCloudBuilder) WithAdvancedAWSAsyncFeatures() *AWSCloudBuilder
WithAdvancedAWSAsyncFeatures enable the use of SNS/SQS to process asynchronously the archive jobs. (required lambdas to be listening the messages)
type AlbumCreatorCataloguerFactory ¶ added in v1.7.0
type AlbumCreatorCataloguerFactory struct{}
func (*AlbumCreatorCataloguerFactory) NewOwnerScopedCataloguer ¶ added in v1.7.0
func (f *AlbumCreatorCataloguerFactory) NewOwnerScopedCataloguer(ctx context.Context, owner ownermodel.Owner) (backup.Cataloguer, error)
type ArchiveAdapterForCatalog ¶ added in v1.7.10
type ArchiveAdapterForCatalog interface {
ArchiveTimelineMutationObserver(ctx context.Context) catalog.TimelineMutationObserver
}
type ArchiveFactory ¶ added in v1.6.13
type ArchiveFactory interface {
ArchiveAsyncJobAdapter(ctx context.Context) archive.AsyncJobAdapter
}
type AsyncArchiveFactory ¶ added in v1.6.13
type AsyncArchiveFactory struct{}
func (*AsyncArchiveFactory) ArchiveAsyncJobAdapter ¶ added in v1.6.13
func (a *AsyncArchiveFactory) ArchiveAsyncJobAdapter(ctx context.Context) archive.AsyncJobAdapter
type CatalogFactory ¶ added in v1.7.10
type CatalogFactory interface {
CreateAlbumCase(ctx context.Context) *catalog.CreateAlbum
CreateAlbumDeleteCase(ctx context.Context) *catalog.DeleteAlbum
RenameAlbumCase(ctx context.Context) *catalog.RenameAlbum
AmendAlbumDatesCase(ctx context.Context) *catalog.AmendAlbumDates
}
func Catalog ¶ added in v1.9.61
func Catalog() CatalogFactory
Catalog exposes the catalog use-case factory built during pkgfactory bootstrap. It is the same instance the API lambdas reach through common.Factory, made available so tests and tooling can trigger album mutations without duplicating the wiring.
type DryRunCataloguerFactory ¶ added in v1.7.0
type DryRunCataloguerFactory struct{}
func (*DryRunCataloguerFactory) NewOwnerScopedCataloguer ¶ added in v1.7.0
func (f *DryRunCataloguerFactory) NewOwnerScopedCataloguer(ctx context.Context, owner ownermodel.Owner) (backup.Cataloguer, error)
type Factory ¶ added in v1.5.54
type Factory interface {
ArchiveFactory
CatalogFactory
// InitArchive shouldn't be used directly but is exposed to support legacy implementation
InitArchive(ctx context.Context)
}
Factory is the builder of the application ; any direct variables are deprecated in favour of moving to the appropriate factory implementation.
type MultiFilesBackup ¶ added in v1.6.13
type MultiFilesBackup func(ctx context.Context, owner ownermodel.Owner, volumeSource backup.SourceVolume, optionsSlice ...backup.Options) (backup.Report, error)
func NewMultiFilesBackup ¶ added in v1.6.13
func NewMultiFilesBackup(ctx context.Context) MultiFilesBackup
type MultiFilesScanner ¶ added in v1.6.13
type MultiFilesScanner func(ctx context.Context, owner string, volume backup.SourceVolume, optionSlice ...backup.Options) ([]*backup.ScannedFolder, error)
func NewMultiFilesScanner ¶ added in v1.6.13
func NewMultiFilesScanner(ctx context.Context) MultiFilesScanner
type SimpleCatalogFactory ¶ added in v1.7.10
type SimpleCatalogFactory struct {
ArchiveAdapterForCatalog ArchiveAdapterForCatalog
}
func (*SimpleCatalogFactory) AmendAlbumDatesCase ¶ added in v1.7.10
func (s *SimpleCatalogFactory) AmendAlbumDatesCase(ctx context.Context) *catalog.AmendAlbumDates
func (*SimpleCatalogFactory) CreateAlbumCase ¶ added in v1.7.10
func (s *SimpleCatalogFactory) CreateAlbumCase(ctx context.Context) *catalog.CreateAlbum
func (*SimpleCatalogFactory) CreateAlbumDeleteCase ¶ added in v1.7.10
func (s *SimpleCatalogFactory) CreateAlbumDeleteCase(ctx context.Context) *catalog.DeleteAlbum
func (*SimpleCatalogFactory) RenameAlbumCase ¶ added in v1.7.10
func (s *SimpleCatalogFactory) RenameAlbumCase(ctx context.Context) *catalog.RenameAlbum
type StaticAWSAdapterNames ¶ added in v1.6.13
type StaticAWSAdapterNames struct {
DynamoDBNameValue string
ArchiveMainBucketNameValue string
ArchiveCacheBucketNameValue string
ArchiveJobsSNSARNValue string
ArchiveJobsSQSURLValue string
ArchiveRelocateJobsSQSURLValue string
}
func (StaticAWSAdapterNames) ArchiveCacheBucketName ¶ added in v1.6.13
func (s StaticAWSAdapterNames) ArchiveCacheBucketName() string
func (StaticAWSAdapterNames) ArchiveJobsSNSARN ¶ added in v1.6.13
func (s StaticAWSAdapterNames) ArchiveJobsSNSARN() string
func (StaticAWSAdapterNames) ArchiveJobsSQSURL ¶ added in v1.6.13
func (s StaticAWSAdapterNames) ArchiveJobsSQSURL() string
func (StaticAWSAdapterNames) ArchiveMainBucketName ¶ added in v1.6.13
func (s StaticAWSAdapterNames) ArchiveMainBucketName() string
func (StaticAWSAdapterNames) ArchiveRelocateJobsSQSURL ¶ added in v1.7.10
func (s StaticAWSAdapterNames) ArchiveRelocateJobsSQSURL() string
func (StaticAWSAdapterNames) DynamoDBName ¶ added in v1.6.13
func (s StaticAWSAdapterNames) DynamoDBName() string
type SyncArchiveAdapterForCatalog ¶ added in v1.7.10
type SyncArchiveAdapterForCatalog struct{}
func (*SyncArchiveAdapterForCatalog) ArchiveTimelineMutationObserver ¶ added in v1.7.10
func (s *SyncArchiveAdapterForCatalog) ArchiveTimelineMutationObserver(ctx context.Context) catalog.TimelineMutationObserver
type SyncArchiveFactory ¶ added in v1.6.13
type SyncArchiveFactory struct{}
func (*SyncArchiveFactory) ArchiveAsyncJobAdapter ¶ added in v1.6.13
func (a *SyncArchiveFactory) ArchiveAsyncJobAdapter(ctx context.Context) archive.AsyncJobAdapter