v1alpha1

Documentation

Overview

Package v1alpha1 defines versioned interfaces for archive capability

Index

• Variables
• type ArchiveCapable

Variables

var ArchiveV1alpha1GV = schema.GroupVersion{Group: archive.CapabilityName, Version: "v1alpha1"}

ArchiveV1alpha1GV is group version used to register these objects

Types

type ArchiveCapable

type ArchiveCapable interface {
	// Upsert create or update a record
	Upsert(ctx context.Context, record *archivev1alpha1.Record) error
	// Delete delete a record
	Delete(ctx context.Context, cluster string, uid string, opts *archivev1alpha1.DeleteOption) error
	// DeleteBatch delete records by conditions
	DeleteBatch(ctx context.Context, conditions []archivev1alpha1.Condition, opts *archivev1alpha1.DeleteOption) error

	// ListRecords list records by conditions
	ListRecords(ctx context.Context, query archivev1alpha1.Query, opts *archivev1alpha1.ListOptions) (*archivev1alpha1.RecordList, error)
	// ListRelatedRecords list related records by conditions
	ListRelatedRecords(ctx context.Context, query archivev1alpha1.Query, opts *archivev1alpha1.ListOptions) (*archivev1alpha1.RecordList, error)
	// Aggregate aggregate records by conditions
	Aggregate(ctx context.Context, aggs archivev1alpha1.AggregateQuery, opts *archivev1alpha1.ListOptions) (*archivev1alpha1.AggregateResult, error)
}

ArchiveCapable defines methods of archive capability