v1alpha1

Documentation

Overview

Package v1alpha1 defines versioned interfaces for file-store capability

Index

• Variables
• type FileMetaInterface
• type FileObject
• type FileObjectInterface
• type FileStoreCapable

Variables

var FileStoreV1alpha1GV = schema.GroupVersion{Group: filestore.CapabilityName, Version: "v1alpha1"}

FileStoreV1alpha1GV is group version used to register versioned resource

Types

type FileMetaInterface

type FileMetaInterface interface {
	// ListFileMetas for list file metas
	ListFileMetas(ctx context.Context, opt v1alpha1.FileMetaListOptions) ([]v1alpha1.FileMeta, error)
	// GetFileMeta for get file meta
	GetFileMeta(ctx context.Context, objectName string) (*v1alpha1.FileMeta, error)
}

FileMetaInterface for file meta

type FileObject

type FileObject struct {
	v1alpha1.FileMeta
	FileReadCloser io.ReadCloser
}

FileObject wraps FileMeta with file reader for implementing file download

type FileObjectInterface

type FileObjectInterface interface {
	// GetFileObject for get file object
	GetFileObject(ctx context.Context, objectName string) (*FileObject, error)
	// PutFileObject for put file object, use FileObject.Name to store objectName
	PutFileObject(ctx context.Context, obj *FileObject) (*v1alpha1.FileMeta,
		error)
	// DeleteFileObject for delete file object
	DeleteFileObject(ctx context.Context, objectName string) error
}

FileObjectInterface for file object

type FileStoreCapable

type FileStoreCapable interface {
	FileObjectInterface
	FileMetaInterface
}

FileStoreCapable defines methods of file-store capability