Documentation ¶
Index ¶
- Constants
- Variables
- func DefaultMetadataOptions(metadata *MetadataModular, cfg *gfspconfig.GfSpConfig) error
- func NewMetadataModular(app *gfspapp.GfSpBaseApp, cfg *gfspconfig.GfSpConfig) (coremodule.Modular, error)
- type MetadataModular
- func (r *MetadataModular) GfSpGetBucketByBucketID(ctx context.Context, req *types.GfSpGetBucketByBucketIDRequest) (resp *types.GfSpGetBucketByBucketIDResponse, err error)
- func (r *MetadataModular) GfSpGetBucketByBucketName(ctx context.Context, req *types.GfSpGetBucketByBucketNameRequest) (resp *types.GfSpGetBucketByBucketNameResponse, err error)
- func (r *MetadataModular) GfSpGetBucketMeta(ctx context.Context, req *types.GfSpGetBucketMetaRequest) (resp *types.GfSpGetBucketMetaResponse, err error)
- func (r *MetadataModular) GfSpGetBucketReadQuota(ctx context.Context, req *types.GfSpGetBucketReadQuotaRequest) (*types.GfSpGetBucketReadQuotaResponse, error)
- func (r *MetadataModular) GfSpGetEndpointBySpId(ctx context.Context, req *types.GfSpGetEndpointBySpIdRequest) (resp *types.GfSpGetEndpointBySpIdResponse, err error)
- func (r *MetadataModular) GfSpGetGlobalVirtualGroup(ctx context.Context, req *types.GfSpGetGlobalVirtualGroupRequest) (resp *types.GfSpGetGlobalVirtualGroupResponse, err error)
- func (r *MetadataModular) GfSpGetGlobalVirtualGroupByGvgID(ctx context.Context, req *types.GfSpGetGlobalVirtualGroupByGvgIDRequest) (resp *types.GfSpGetGlobalVirtualGroupByGvgIDResponse, err error)
- func (r *MetadataModular) GfSpGetGroupList(ctx context.Context, req *types.GfSpGetGroupListRequest) (resp *types.GfSpGetGroupListResponse, err error)
- func (r *MetadataModular) GfSpGetObjectMeta(ctx context.Context, req *types.GfSpGetObjectMetaRequest) (resp *types.GfSpGetObjectMetaResponse, err error)
- func (r *MetadataModular) GfSpGetPaymentByBucketID(ctx context.Context, req *types.GfSpGetPaymentByBucketIDRequest) (resp *types.GfSpGetPaymentByBucketIDResponse, err error)
- func (r *MetadataModular) GfSpGetPaymentByBucketName(ctx context.Context, req *types.GfSpGetPaymentByBucketNameRequest) (resp *types.GfSpGetPaymentByBucketNameResponse, err error)
- func (r *MetadataModular) GfSpGetSPInfo(ctx context.Context, req *types.GfSpGetSPInfoRequest) (resp *types.GfSpGetSPInfoResponse, err error)
- func (r *MetadataModular) GfSpGetUserBuckets(ctx context.Context, req *types.GfSpGetUserBucketsRequest) (resp *types.GfSpGetUserBucketsResponse, err error)
- func (r *MetadataModular) GfSpGetUserBucketsCount(ctx context.Context, req *types.GfSpGetUserBucketsCountRequest) (resp *types.GfSpGetUserBucketsCountResponse, err error)
- func (r *MetadataModular) GfSpGetVirtualGroupFamily(ctx context.Context, req *types.GfSpGetVirtualGroupFamilyRequest) (resp *types.GfSpGetVirtualGroupFamilyResponse, err error)
- func (r *MetadataModular) GfSpListBucketReadRecord(ctx context.Context, req *types.GfSpListBucketReadRecordRequest) (*types.GfSpListBucketReadRecordResponse, error)
- func (r *MetadataModular) GfSpListBucketsByBucketID(ctx context.Context, req *types.GfSpListBucketsByBucketIDRequest) (resp *types.GfSpListBucketsByBucketIDResponse, err error)
- func (r *MetadataModular) GfSpListDeletedObjectsByBlockNumberRange(ctx context.Context, ...) (resp *types.GfSpListDeletedObjectsByBlockNumberRangeResponse, err error)
- func (r *MetadataModular) GfSpListExpiredBucketsBySp(ctx context.Context, req *types.GfSpListExpiredBucketsBySpRequest) (resp *types.GfSpListExpiredBucketsBySpResponse, err error)
- func (r *MetadataModular) GfSpListGlobalVirtualGroupsByBucket(ctx context.Context, req *types.GfSpListGlobalVirtualGroupsByBucketRequest) (resp *types.GfSpListGlobalVirtualGroupsByBucketResponse, err error)
- func (r *MetadataModular) GfSpListGlobalVirtualGroupsBySecondarySP(ctx context.Context, ...) (resp *types.GfSpListGlobalVirtualGroupsBySecondarySPResponse, err error)
- func (r *MetadataModular) GfSpListMigrateBucketEvents(ctx context.Context, req *types.GfSpListMigrateBucketEventsRequest) (resp *types.GfSpListMigrateBucketEventsResponse, err error)
- func (r *MetadataModular) GfSpListObjectsByBucketName(ctx context.Context, req *types.GfSpListObjectsByBucketNameRequest) (resp *types.GfSpListObjectsByBucketNameResponse, err error)
- func (r *MetadataModular) GfSpListObjectsByGVGAndBucketForGC(ctx context.Context, req *types.GfSpListObjectsByGVGAndBucketForGCRequest) (resp *types.GfSpListObjectsByGVGAndBucketForGCResponse, err error)
- func (r *MetadataModular) GfSpListObjectsByObjectID(ctx context.Context, req *types.GfSpListObjectsByObjectIDRequest) (resp *types.GfSpListObjectsByObjectIDResponse, err error)
- func (r *MetadataModular) GfSpListObjectsInGVG(ctx context.Context, req *types.GfSpListObjectsInGVGRequest) (resp *types.GfSpListObjectsInGVGResponse, err error)
- func (r *MetadataModular) GfSpListObjectsInGVGAndBucket(ctx context.Context, req *types.GfSpListObjectsInGVGAndBucketRequest) (resp *types.GfSpListObjectsInGVGAndBucketResponse, err error)
- func (r *MetadataModular) GfSpListSpExitEvents(ctx context.Context, req *types.GfSpListSpExitEventsRequest) (resp *types.GfSpListSpExitEventsResponse, err error)
- func (r *MetadataModular) GfSpListSwapOutEvents(ctx context.Context, req *types.GfSpListSwapOutEventsRequest) (resp *types.GfSpListSwapOutEventsResponse, err error)
- func (r *MetadataModular) GfSpListVirtualGroupFamiliesBySpID(ctx context.Context, req *types.GfSpListVirtualGroupFamiliesBySpIDRequest) (resp *types.GfSpListVirtualGroupFamiliesBySpIDResponse, err error)
- func (r *MetadataModular) GfSpQueryResumableUploadSegment(ctx context.Context, req *types.GfSpQueryResumableUploadSegmentRequest) (*types.GfSpQueryResumableUploadSegmentResponse, error)
- func (r *MetadataModular) GfSpQueryUploadProgress(ctx context.Context, req *types.GfSpQueryUploadProgressRequest) (*types.GfSpQueryUploadProgressResponse, error)
- func (r *MetadataModular) GfSpVerifyPermission(ctx context.Context, req *storagetypes.QueryVerifyPermissionRequest) (resp *storagetypes.QueryVerifyPermissionResponse, err error)
- func (r *MetadataModular) GfSpVerifyPermissionByID(ctx context.Context, req *types.GfSpVerifyPermissionByIDRequest) (resp *types.GfSpVerifyPermissionByIDResponse, err error)
- func (r *MetadataModular) Name() string
- func (r *MetadataModular) ReleaseResource(ctx context.Context, span rcmgr.ResourceScopeSpan)
- func (r *MetadataModular) ReserveResource(ctx context.Context, state *rcmgr.ScopeStat) (rcmgr.ResourceScopeSpan, error)
- func (r *MetadataModular) Start(ctx context.Context) error
- func (r *MetadataModular) Stop(ctx context.Context) error
- func (r *MetadataModular) VerifyBucketPermission(ctx context.Context, bucketInfo *bsdb.Bucket, operator sdk.AccAddress, ...) (permtypes.Effect, error)
- func (r *MetadataModular) VerifyGroupPermission(ctx context.Context, groupInfo *bsdb.Group, operator sdk.AccAddress, ...) (permtypes.Effect, error)
- func (r *MetadataModular) VerifyObjectPermission(ctx context.Context, bucketInfo *bsdb.Bucket, objectInfo *bsdb.Object, ...) (permtypes.Effect, error)
- func (r *MetadataModular) VerifyPolicy(ctx context.Context, resourceID math.Uint, resourceType resource.ResourceType, ...) (permtypes.Effect, error)
Constants ¶
const ( // DefaultQuerySPParallelPerNode defines the max parallel for retrieving request DefaultQuerySPParallelPerNode int64 = 10240 // DefaultBsDBSwitchCheckIntervalSec defines the default db switch check interval in seconds DefaultBsDBSwitchCheckIntervalSec = 30 )
const (
DefaultMetadataStatisticsInterval = 60
)
Variables ¶
var ( MetadataModularName = strings.ToLower("Metadata") MetadataModularDescription = "Retrieves sp metadata and info." )
var ( ErrDanglingPointer = gfsperrors.Register(MetadataModularName, http.StatusBadRequest, 90001, "OoooH... request lost, try again later") ErrExceedRequest = gfsperrors.Register(MetadataModularName, http.StatusNotAcceptable, 90002, "request exceed") ErrNoRecord = gfsperrors.Register(MetadataModularName, http.StatusNotFound, 90003, "no uploading record") ErrGfSpDB = gfsperrors.Register(MetadataModularName, http.StatusInternalServerError, 95202, "server slipped away, try again later") ErrNoSuchSP = gfsperrors.Register(MetadataModularName, http.StatusNotFound, 90004, "no such sp") ErrExceedBlockHeight = gfsperrors.Register(MetadataModularName, http.StatusBadRequest, 90005, "request block height exceed latest height") )
var ( // ErrInvalidParams defines invalid params ErrInvalidParams = errors.New("invalid params") // ErrInvalidBucketName defines invalid bucket name ErrInvalidBucketName = errors.New("invalid bucket name") // ErrNoSuchBucket defines not existed bucket error ErrNoSuchBucket = errors.New("the specified bucket does not exist") // ErrNoSuchGroup defines not existed group error ErrNoSuchGroup = errors.New("the specified group does not exist") // ErrNoSuchObject defines not existed object error ErrNoSuchObject = errors.New("the specified key does not exist") )
Functions ¶
func DefaultMetadataOptions ¶
func DefaultMetadataOptions(metadata *MetadataModular, cfg *gfspconfig.GfSpConfig) error
func NewMetadataModular ¶
func NewMetadataModular(app *gfspapp.GfSpBaseApp, cfg *gfspconfig.GfSpConfig) (coremodule.Modular, error)
Types ¶
type MetadataModular ¶
type MetadataModular struct {
// contains filtered or unexported fields
}
func (*MetadataModular) GfSpGetBucketByBucketID ¶
func (r *MetadataModular) GfSpGetBucketByBucketID(ctx context.Context, req *types.GfSpGetBucketByBucketIDRequest) (resp *types.GfSpGetBucketByBucketIDResponse, err error)
GfSpGetBucketByBucketID get buckets info by by a bucket id
func (*MetadataModular) GfSpGetBucketByBucketName ¶
func (r *MetadataModular) GfSpGetBucketByBucketName(ctx context.Context, req *types.GfSpGetBucketByBucketNameRequest) (resp *types.GfSpGetBucketByBucketNameResponse, err error)
GfSpGetBucketByBucketName get buckets info by a bucket name
func (*MetadataModular) GfSpGetBucketMeta ¶
func (r *MetadataModular) GfSpGetBucketMeta( ctx context.Context, req *types.GfSpGetBucketMetaRequest) ( resp *types.GfSpGetBucketMetaResponse, err error)
GfSpGetBucketMeta get bucket metadata
func (*MetadataModular) GfSpGetBucketReadQuota ¶
func (r *MetadataModular) GfSpGetBucketReadQuota( ctx context.Context, req *types.GfSpGetBucketReadQuotaRequest) ( *types.GfSpGetBucketReadQuotaResponse, error)
func (*MetadataModular) GfSpGetEndpointBySpId ¶ added in v0.2.3
func (r *MetadataModular) GfSpGetEndpointBySpId( ctx context.Context, req *types.GfSpGetEndpointBySpIdRequest) ( resp *types.GfSpGetEndpointBySpIdResponse, err error)
GfSpGetEndpointBySpId get endpoint by sp id
func (*MetadataModular) GfSpGetGlobalVirtualGroup ¶ added in v0.2.3
func (r *MetadataModular) GfSpGetGlobalVirtualGroup(ctx context.Context, req *types.GfSpGetGlobalVirtualGroupRequest) (resp *types.GfSpGetGlobalVirtualGroupResponse, err error)
GfSpGetGlobalVirtualGroup get global virtual group by lvg id and bucket id
func (*MetadataModular) GfSpGetGlobalVirtualGroupByGvgID ¶ added in v0.2.3
func (r *MetadataModular) GfSpGetGlobalVirtualGroupByGvgID(ctx context.Context, req *types.GfSpGetGlobalVirtualGroupByGvgIDRequest) (resp *types.GfSpGetGlobalVirtualGroupByGvgIDResponse, err error)
GfSpGetGlobalVirtualGroupByGvgID get global virtual group by gvg id
func (*MetadataModular) GfSpGetGroupList ¶
func (r *MetadataModular) GfSpGetGroupList(ctx context.Context, req *types.GfSpGetGroupListRequest) (resp *types.GfSpGetGroupListResponse, err error)
GfSpGetGroupList get group list by queryName/prefix/sourceType
func (*MetadataModular) GfSpGetObjectMeta ¶
func (r *MetadataModular) GfSpGetObjectMeta(ctx context.Context, req *types.GfSpGetObjectMetaRequest) (resp *types.GfSpGetObjectMetaResponse, err error)
GfSpGetObjectMeta get object metadata
func (*MetadataModular) GfSpGetPaymentByBucketID ¶
func (r *MetadataModular) GfSpGetPaymentByBucketID(ctx context.Context, req *types.GfSpGetPaymentByBucketIDRequest) (resp *types.GfSpGetPaymentByBucketIDResponse, err error)
GfSpGetPaymentByBucketID get bucket payment info by a bucket id
func (*MetadataModular) GfSpGetPaymentByBucketName ¶
func (r *MetadataModular) GfSpGetPaymentByBucketName(ctx context.Context, req *types.GfSpGetPaymentByBucketNameRequest) (resp *types.GfSpGetPaymentByBucketNameResponse, err error)
GfSpGetPaymentByBucketName get bucket payment info by a bucket name
func (*MetadataModular) GfSpGetSPInfo ¶ added in v0.2.3
func (r *MetadataModular) GfSpGetSPInfo(ctx context.Context, req *types.GfSpGetSPInfoRequest) (resp *types.GfSpGetSPInfoResponse, err error)
GfSpGetSPInfo get sp info by operator address
func (*MetadataModular) GfSpGetUserBuckets ¶
func (r *MetadataModular) GfSpGetUserBuckets( ctx context.Context, req *types.GfSpGetUserBucketsRequest) ( resp *types.GfSpGetUserBucketsResponse, err error)
func (*MetadataModular) GfSpGetUserBucketsCount ¶
func (r *MetadataModular) GfSpGetUserBucketsCount(ctx context.Context, req *types.GfSpGetUserBucketsCountRequest) (resp *types.GfSpGetUserBucketsCountResponse, err error)
GfSpGetUserBucketsCount get buckets count by a user address
func (*MetadataModular) GfSpGetVirtualGroupFamily ¶ added in v0.2.3
func (r *MetadataModular) GfSpGetVirtualGroupFamily(ctx context.Context, req *types.GfSpGetVirtualGroupFamilyRequest) (resp *types.GfSpGetVirtualGroupFamilyResponse, err error)
GfSpGetVirtualGroupFamily get virtual group families by vgf id
func (*MetadataModular) GfSpListBucketReadRecord ¶
func (r *MetadataModular) GfSpListBucketReadRecord( ctx context.Context, req *types.GfSpListBucketReadRecordRequest) ( *types.GfSpListBucketReadRecordResponse, error)
func (*MetadataModular) GfSpListBucketsByBucketID ¶
func (r *MetadataModular) GfSpListBucketsByBucketID(ctx context.Context, req *types.GfSpListBucketsByBucketIDRequest) (resp *types.GfSpListBucketsByBucketIDResponse, err error)
GfSpListBucketsByBucketID list buckets by bucket ids
func (*MetadataModular) GfSpListDeletedObjectsByBlockNumberRange ¶
func (r *MetadataModular) GfSpListDeletedObjectsByBlockNumberRange(ctx context.Context, req *types.GfSpListDeletedObjectsByBlockNumberRangeRequest) (resp *types.GfSpListDeletedObjectsByBlockNumberRangeResponse, err error)
GfSpListDeletedObjectsByBlockNumberRange list deleted objects info by a block number range
func (*MetadataModular) GfSpListExpiredBucketsBySp ¶
func (r *MetadataModular) GfSpListExpiredBucketsBySp(ctx context.Context, req *types.GfSpListExpiredBucketsBySpRequest) (resp *types.GfSpListExpiredBucketsBySpResponse, err error)
GfSpListExpiredBucketsBySp list expired bucket by sp
func (*MetadataModular) GfSpListGlobalVirtualGroupsByBucket ¶ added in v0.2.3
func (r *MetadataModular) GfSpListGlobalVirtualGroupsByBucket(ctx context.Context, req *types.GfSpListGlobalVirtualGroupsByBucketRequest) (resp *types.GfSpListGlobalVirtualGroupsByBucketResponse, err error)
GfSpListGlobalVirtualGroupsByBucket list global virtual group by bucket id
func (*MetadataModular) GfSpListGlobalVirtualGroupsBySecondarySP ¶ added in v0.2.3
func (r *MetadataModular) GfSpListGlobalVirtualGroupsBySecondarySP(ctx context.Context, req *types.GfSpListGlobalVirtualGroupsBySecondarySPRequest) (resp *types.GfSpListGlobalVirtualGroupsBySecondarySPResponse, err error)
GfSpListGlobalVirtualGroupsBySecondarySP list global virtual group by secondary sp id
func (*MetadataModular) GfSpListMigrateBucketEvents ¶ added in v0.2.3
func (r *MetadataModular) GfSpListMigrateBucketEvents(ctx context.Context, req *types.GfSpListMigrateBucketEventsRequest) (resp *types.GfSpListMigrateBucketEventsResponse, err error)
GfSpListMigrateBucketEvents list migrate bucket events
func (*MetadataModular) GfSpListObjectsByBucketName ¶
func (r *MetadataModular) GfSpListObjectsByBucketName(ctx context.Context, req *types.GfSpListObjectsByBucketNameRequest) (resp *types.GfSpListObjectsByBucketNameResponse, err error)
GfSpListObjectsByBucketName list objects info by a bucket name
func (*MetadataModular) GfSpListObjectsByGVGAndBucketForGC ¶ added in v0.2.3
func (r *MetadataModular) GfSpListObjectsByGVGAndBucketForGC(ctx context.Context, req *types.GfSpListObjectsByGVGAndBucketForGCRequest) (resp *types.GfSpListObjectsByGVGAndBucketForGCResponse, err error)
GfSpListObjectsByGVGAndBucketForGC list objects by gvg and bucket for gc
func (*MetadataModular) GfSpListObjectsByObjectID ¶
func (r *MetadataModular) GfSpListObjectsByObjectID(ctx context.Context, req *types.GfSpListObjectsByObjectIDRequest) (resp *types.GfSpListObjectsByObjectIDResponse, err error)
GfSpListObjectsByObjectID list objects by object ids
func (*MetadataModular) GfSpListObjectsInGVG ¶ added in v0.2.3
func (r *MetadataModular) GfSpListObjectsInGVG(ctx context.Context, req *types.GfSpListObjectsInGVGRequest) (resp *types.GfSpListObjectsInGVGResponse, err error)
GfSpListObjectsInGVG list objects by gvg and bucket id
func (*MetadataModular) GfSpListObjectsInGVGAndBucket ¶ added in v0.2.3
func (r *MetadataModular) GfSpListObjectsInGVGAndBucket(ctx context.Context, req *types.GfSpListObjectsInGVGAndBucketRequest) (resp *types.GfSpListObjectsInGVGAndBucketResponse, err error)
GfSpListObjectsInGVGAndBucket list objects by gvg and bucket id
func (*MetadataModular) GfSpListSpExitEvents ¶ added in v0.2.3
func (r *MetadataModular) GfSpListSpExitEvents(ctx context.Context, req *types.GfSpListSpExitEventsRequest) (resp *types.GfSpListSpExitEventsResponse, err error)
GfSpListSpExitEvents list migrate sp exit events
func (*MetadataModular) GfSpListSwapOutEvents ¶ added in v0.2.3
func (r *MetadataModular) GfSpListSwapOutEvents(ctx context.Context, req *types.GfSpListSwapOutEventsRequest) (resp *types.GfSpListSwapOutEventsResponse, err error)
GfSpListSwapOutEvents list swap out events
func (*MetadataModular) GfSpListVirtualGroupFamiliesBySpID ¶ added in v0.2.3
func (r *MetadataModular) GfSpListVirtualGroupFamiliesBySpID(ctx context.Context, req *types.GfSpListVirtualGroupFamiliesBySpIDRequest) (resp *types.GfSpListVirtualGroupFamiliesBySpIDResponse, err error)
GfSpListVirtualGroupFamiliesBySpID list virtual group families by sp id
func (*MetadataModular) GfSpQueryResumableUploadSegment ¶ added in v0.2.3
func (r *MetadataModular) GfSpQueryResumableUploadSegment(ctx context.Context, req *types.GfSpQueryResumableUploadSegmentRequest) ( *types.GfSpQueryResumableUploadSegmentResponse, error)
func (*MetadataModular) GfSpQueryUploadProgress ¶
func (r *MetadataModular) GfSpQueryUploadProgress(ctx context.Context, req *types.GfSpQueryUploadProgressRequest) ( *types.GfSpQueryUploadProgressResponse, error)
func (*MetadataModular) GfSpVerifyPermission ¶
func (r *MetadataModular) GfSpVerifyPermission(ctx context.Context, req *storagetypes.QueryVerifyPermissionRequest) (resp *storagetypes.QueryVerifyPermissionResponse, err error)
GfSpVerifyPermission Verify the input account’s permission to input items
func (*MetadataModular) GfSpVerifyPermissionByID ¶ added in v0.2.3
func (r *MetadataModular) GfSpVerifyPermissionByID(ctx context.Context, req *types.GfSpVerifyPermissionByIDRequest) (resp *types.GfSpVerifyPermissionByIDResponse, err error)
GfSpVerifyPermissionByID Verify the input account’s permission to input source type and resource id
func (*MetadataModular) Name ¶
func (r *MetadataModular) Name() string
func (*MetadataModular) ReleaseResource ¶
func (r *MetadataModular) ReleaseResource( ctx context.Context, span rcmgr.ResourceScopeSpan)
func (*MetadataModular) ReserveResource ¶
func (r *MetadataModular) ReserveResource( ctx context.Context, state *rcmgr.ScopeStat) ( rcmgr.ResourceScopeSpan, error)
func (*MetadataModular) VerifyBucketPermission ¶
func (r *MetadataModular) VerifyBucketPermission(ctx context.Context, bucketInfo *bsdb.Bucket, operator sdk.AccAddress, action permtypes.ActionType, options *permtypes.VerifyOptions) (permtypes.Effect, error)
VerifyBucketPermission verify bucket permission
func (*MetadataModular) VerifyGroupPermission ¶ added in v0.2.3
func (r *MetadataModular) VerifyGroupPermission(ctx context.Context, groupInfo *bsdb.Group, operator sdk.AccAddress, action permtypes.ActionType) (permtypes.Effect, error)
VerifyGroupPermission verify group permission
func (*MetadataModular) VerifyObjectPermission ¶
func (r *MetadataModular) VerifyObjectPermission(ctx context.Context, bucketInfo *bsdb.Bucket, objectInfo *bsdb.Object, operator sdk.AccAddress, action permtypes.ActionType) (permtypes.Effect, error)
VerifyObjectPermission verify object permission
func (*MetadataModular) VerifyPolicy ¶
func (r *MetadataModular) VerifyPolicy(ctx context.Context, resourceID math.Uint, resourceType resource.ResourceType, operator sdk.AccAddress, action permtypes.ActionType, opts *permtypes.VerifyOptions) (permtypes.Effect, error)
VerifyPolicy verify policy of permission