Documentation
¶
Index ¶
- Variables
- type BucketsService
- func (s *BucketsService) AddScope(ctx context.Context, bucket string, req bucketapi.AddBucketScopeRequest) error
- func (s *BucketsService) Delete(ctx context.Context, bucket string) error
- func (s *BucketsService) DeleteProjectData(ctx context.Context, organization, projectID string) (bucketapi.DeleteProjectDataResponse, error)
- func (s *BucketsService) DeleteScope(ctx context.Context, bucket, organization, path, projectID string) error
- func (s *BucketsService) List(ctx context.Context) (bucketapi.BucketsResponse, error)
- func (s *BucketsService) ListScopes(ctx context.Context, bucket string) ([]bucketapi.BucketScopeResponse, error)
- func (s *BucketsService) Put(ctx context.Context, req bucketapi.PutBucketRequest) error
- type DRSService
- func (s *DRSService) DeleteObject(ctx context.Context, objectID string, deleteStorageData bool) error
- func (s *DRSService) GetAccessURL(ctx context.Context, objectID, accessID string) (drsapi.AccessURL, error)
- func (s *DRSService) GetObject(ctx context.Context, objectID string) (drsapi.DrsObject, error)
- func (s *DRSService) RegisterObjects(ctx context.Context, req drsapi.RegisterObjectsJSONRequestBody) (drsapi.N201ObjectsCreated, error)
- func (s *DRSService) ReplaceObject(ctx context.Context, objectID, expectedOldSHA string, ...) (drsapi.DrsObject, error)
- func (s *DRSService) UpdateObjectAccessMethods(ctx context.Context, objectID string, accessMethods []drsapi.AccessMethod) (drsapi.DrsObject, error)
- type DataService
- func (d *DataService) CanonicalObjectURL(signedURL, bucketHint, fallbackDID string) (string, error)
- func (d *DataService) Delete(ctx context.Context, guid string) error
- func (d *DataService) DeleteFile(ctx context.Context, guid string) (string, error)
- func (d *DataService) Download(ctx context.Context, signedURL string, rangeStart, rangeEnd *int64) (*http.Response, error)
- func (d *DataService) DownloadURL(ctx context.Context, did string, expiresIn int, redirect bool) (internalapi.InternalSignedURL, error)
- func (d *DataService) GetRangeReader(ctx context.Context, guid string, offset, length int64) (io.ReadCloser, error)
- func (d *DataService) GetReader(ctx context.Context, guid string) (io.ReadCloser, error)
- func (d *DataService) InitMultipartUploadWithMetadata(ctx context.Context, guid, filename, bucket string, ...) (string, string, error)
- func (d *DataService) Logger() transfer.TransferLogger
- func (d *DataService) MultipartAbort(ctx context.Context, uploadID string) error
- func (d *DataService) MultipartComplete(ctx context.Context, guid string, uploadID string, ...) error
- func (d *DataService) MultipartCompleteWithLocation(ctx context.Context, guid string, uploadID string, ...) (string, error)
- func (d *DataService) MultipartCompletionReplaySafe(context.Context, string, string, []transfer.MultipartPart) bool
- func (d *DataService) MultipartInit(ctx context.Context, guid string) (string, error)
- func (d *DataService) MultipartPart(ctx context.Context, guid string, uploadID string, partNum int, body io.Reader) (string, error)
- func (d *DataService) MultipartPartURLs(ctx context.Context, guid string, uploadID string, partNumbers []int32) (transfer.MultipartPartURLBatch, error)
- func (d *DataService) ResolveDownloadURL(ctx context.Context, guid string, accessID string) (string, error)
- func (d *DataService) ResolveUploadURL(ctx context.Context, guid, filename string, metadata common.FileMetadata, ...) (string, error)
- func (d *DataService) Stat(ctx context.Context, guid string) (*transfer.ObjectMetadata, error)
- func (d *DataService) Upload(ctx context.Context, url string, body io.Reader, size int64) error
- func (d *DataService) UploadBlank(ctx context.Context, req internalapi.InternalUploadBlankRequest) (internalapi.InternalUploadBlankOutput, error)
- func (d *DataService) UploadBulk(ctx context.Context, req internalapi.InternalUploadBulkRequest) (internalapi.InternalUploadBulkOutput, error)
- func (d *DataService) UploadPart(ctx context.Context, url string, body io.Reader, size int64) (string, error)
- func (d *DataService) UploadURL(ctx context.Context, fileID string, ...) (internalapi.InternalSignedURL, error)
- type DeleteByQueryOptions
- type HealthService
- type IndexService
- func (s *IndexService) Create(ctx context.Context, rec internalapi.InternalRecord) (internalapi.InternalRecordResponse, error)
- func (s *IndexService) Delete(ctx context.Context, did string) error
- func (s *IndexService) DeleteByQuery(ctx context.Context, opts DeleteByQueryOptions) (internalapi.DeleteByQueryResponse, error)
- func (s *IndexService) Get(ctx context.Context, did string) (internalapi.InternalRecordResponse, error)
- func (s *IndexService) List(ctx context.Context, opts ListRecordsOptions) (internalapi.ListRecordsResponse, error)
- func (s *IndexService) RemoveControlledAccess(ctx context.Context, did, resource string) (internalapi.InternalRecordResponse, error)
- func (s *IndexService) Update(ctx context.Context, did string, rec internalapi.InternalRecord) (internalapi.InternalRecordResponse, error)
- func (s *IndexService) Upsert(ctx context.Context, did, objectURL, recordPath string, size int64, ...) error
- type LFSService
- func (s *LFSService) Batch(ctx context.Context, op lfsapi.BatchRequestOperation, ...) (*lfsapi.BatchResponse, error)
- func (s *LFSService) StageMetadata(ctx context.Context, candidates []lfsapi.DrsObjectCandidate, ttl *int64) (int32, error)
- func (s *LFSService) Verify(ctx context.Context, oid string, size int64) error
- type ListRecordsOptions
- type MetricsFilesOptions
- type MetricsService
- func (s *MetricsService) File(ctx context.Context, objectID string) (metricsapi.FileUsage, error)
- func (s *MetricsService) Files(ctx context.Context, opts MetricsFilesOptions) ([]metricsapi.FileUsage, error)
- func (s *MetricsService) Summary(ctx context.Context, opts MetricsSummaryOptions) (metricsapi.FileUsageSummary, error)
- func (s *MetricsService) TransferBreakdown(ctx context.Context, opts TransferMetricsOptions) (metricsapi.TransferBreakdownResponse, error)
- func (s *MetricsService) TransferBreakdownPage(ctx context.Context, opts TransferMetricsOptions, limit, offset int) (metricsapi.TransferBreakdownResponse, error)
- func (s *MetricsService) TransferSummary(ctx context.Context, opts TransferMetricsOptions) (metricsapi.TransferAttributionSummary, error)
- type MetricsSummaryOptions
- type TransferMetricsOptions
Constants ¶
This section is empty.
Variables ¶
var ErrObjectNotFound = errorapi.ErrNotFound
Deprecated: use errorapi.ErrNotFound.
Functions ¶
This section is empty.
Types ¶
type BucketsService ¶
type BucketsService struct {
// contains filtered or unexported fields
}
func NewBucketsService ¶
func NewBucketsService(gen bucketapi.ClientWithResponsesInterface) *BucketsService
func (*BucketsService) AddScope ¶
func (s *BucketsService) AddScope(ctx context.Context, bucket string, req bucketapi.AddBucketScopeRequest) error
func (*BucketsService) Delete ¶
func (s *BucketsService) Delete(ctx context.Context, bucket string) error
func (*BucketsService) DeleteProjectData ¶ added in v0.3.1
func (s *BucketsService) DeleteProjectData(ctx context.Context, organization, projectID string) (bucketapi.DeleteProjectDataResponse, error)
func (*BucketsService) DeleteScope ¶ added in v0.3.1
func (s *BucketsService) DeleteScope(ctx context.Context, bucket, organization, path, projectID string) error
func (*BucketsService) List ¶
func (s *BucketsService) List(ctx context.Context) (bucketapi.BucketsResponse, error)
func (*BucketsService) ListScopes ¶ added in v0.3.1
func (s *BucketsService) ListScopes(ctx context.Context, bucket string) ([]bucketapi.BucketScopeResponse, error)
func (*BucketsService) Put ¶
func (s *BucketsService) Put(ctx context.Context, req bucketapi.PutBucketRequest) error
type DRSService ¶
type DRSService struct {
// contains filtered or unexported fields
}
func NewDRSService ¶
func NewDRSService(gen drsapi.ClientWithResponsesInterface) *DRSService
func (*DRSService) DeleteObject ¶ added in v0.2.8
func (*DRSService) GetAccessURL ¶
func (*DRSService) RegisterObjects ¶
func (s *DRSService) RegisterObjects(ctx context.Context, req drsapi.RegisterObjectsJSONRequestBody) (drsapi.N201ObjectsCreated, error)
func (*DRSService) ReplaceObject ¶ added in v0.3.9
func (s *DRSService) ReplaceObject(ctx context.Context, objectID, expectedOldSHA string, candidate drsapi.DrsObjectCandidate) (drsapi.DrsObject, error)
func (*DRSService) UpdateObjectAccessMethods ¶ added in v0.3.0
func (s *DRSService) UpdateObjectAccessMethods(ctx context.Context, objectID string, accessMethods []drsapi.AccessMethod) (drsapi.DrsObject, error)
type DataService ¶
type DataService struct {
// contains filtered or unexported fields
}
func NewDataService ¶
func NewDataService(gen internalapi.ClientWithResponsesInterface, client request.HTTPDoer, l *logs.Gen3Logger, drs *DRSService) *DataService
func (*DataService) CanonicalObjectURL ¶
func (d *DataService) CanonicalObjectURL(signedURL, bucketHint, fallbackDID string) (string, error)
func (*DataService) DeleteFile ¶
func (*DataService) DownloadURL ¶
func (d *DataService) DownloadURL(ctx context.Context, did string, expiresIn int, redirect bool) (internalapi.InternalSignedURL, error)
func (*DataService) GetRangeReader ¶
func (d *DataService) GetRangeReader(ctx context.Context, guid string, offset, length int64) (io.ReadCloser, error)
func (*DataService) GetReader ¶
func (d *DataService) GetReader(ctx context.Context, guid string) (io.ReadCloser, error)
func (*DataService) InitMultipartUploadWithMetadata ¶ added in v0.3.0
func (d *DataService) InitMultipartUploadWithMetadata(ctx context.Context, guid, filename, bucket string, metadata common.FileMetadata) (string, string, error)
func (*DataService) Logger ¶
func (d *DataService) Logger() transfer.TransferLogger
func (*DataService) MultipartAbort ¶ added in v0.3.8
func (d *DataService) MultipartAbort(ctx context.Context, uploadID string) error
MultipartAbort releases a server-side multipart session. It is safe to repeat and does not run automatically for transient upload failures, so callers retain resumability until they explicitly abandon an upload.
func (*DataService) MultipartComplete ¶
func (d *DataService) MultipartComplete(ctx context.Context, guid string, uploadID string, parts []transfer.MultipartPart) error
func (*DataService) MultipartCompleteWithLocation ¶ added in v0.3.8
func (d *DataService) MultipartCompleteWithLocation(ctx context.Context, guid string, uploadID string, parts []transfer.MultipartPart) (string, error)
MultipartCompleteWithLocation returns the storage location selected by the upload session.
func (*DataService) MultipartCompletionReplaySafe ¶ added in v0.3.8
func (d *DataService) MultipartCompletionReplaySafe(context.Context, string, string, []transfer.MultipartPart) bool
MultipartCompletionReplaySafe reports that the server makes completion retries idempotent.
func (*DataService) MultipartInit ¶
func (*DataService) MultipartPart ¶
func (*DataService) MultipartPartURLs ¶ added in v0.3.10
func (d *DataService) MultipartPartURLs(ctx context.Context, guid string, uploadID string, partNumbers []int32) (transfer.MultipartPartURLBatch, error)
func (*DataService) ResolveDownloadURL ¶
func (*DataService) ResolveUploadURL ¶
func (d *DataService) ResolveUploadURL(ctx context.Context, guid, filename string, metadata common.FileMetadata, bucket string) (string, error)
func (*DataService) Stat ¶
func (d *DataService) Stat(ctx context.Context, guid string) (*transfer.ObjectMetadata, error)
func (*DataService) UploadBlank ¶
func (d *DataService) UploadBlank(ctx context.Context, req internalapi.InternalUploadBlankRequest) (internalapi.InternalUploadBlankOutput, error)
func (*DataService) UploadBulk ¶
func (d *DataService) UploadBulk(ctx context.Context, req internalapi.InternalUploadBulkRequest) (internalapi.InternalUploadBulkOutput, error)
func (*DataService) UploadPart ¶
func (*DataService) UploadURL ¶
func (d *DataService) UploadURL(ctx context.Context, fileID string, params *internalapi.InternalUploadURLParams) (internalapi.InternalSignedURL, error)
type DeleteByQueryOptions ¶
type HealthService ¶
type HealthService struct {
// contains filtered or unexported fields
}
func NewHealthService ¶
func NewHealthService(baseURL string, client request.HTTPDoer) *HealthService
type IndexService ¶
type IndexService struct {
// contains filtered or unexported fields
}
func NewIndexService ¶
func NewIndexService(gen internalapi.ClientWithResponsesInterface) *IndexService
func (*IndexService) Create ¶
func (s *IndexService) Create(ctx context.Context, rec internalapi.InternalRecord) (internalapi.InternalRecordResponse, error)
func (*IndexService) DeleteByQuery ¶
func (s *IndexService) DeleteByQuery(ctx context.Context, opts DeleteByQueryOptions) (internalapi.DeleteByQueryResponse, error)
func (*IndexService) Get ¶
func (s *IndexService) Get(ctx context.Context, did string) (internalapi.InternalRecordResponse, error)
func (*IndexService) List ¶
func (s *IndexService) List(ctx context.Context, opts ListRecordsOptions) (internalapi.ListRecordsResponse, error)
func (*IndexService) RemoveControlledAccess ¶ added in v0.2.8
func (s *IndexService) RemoveControlledAccess(ctx context.Context, did, resource string) (internalapi.InternalRecordResponse, error)
func (*IndexService) Update ¶
func (s *IndexService) Update(ctx context.Context, did string, rec internalapi.InternalRecord) (internalapi.InternalRecordResponse, error)
type LFSService ¶
type LFSService struct {
// contains filtered or unexported fields
}
func NewLFSService ¶
func NewLFSService(gen lfsapi.ClientWithResponsesInterface) *LFSService
func (*LFSService) Batch ¶
func (s *LFSService) Batch(ctx context.Context, op lfsapi.BatchRequestOperation, objects []lfsapi.BatchRequestObject) (*lfsapi.BatchResponse, error)
Batch executes a Git LFS Batch API request.
func (*LFSService) StageMetadata ¶
func (s *LFSService) StageMetadata(ctx context.Context, candidates []lfsapi.DrsObjectCandidate, ttl *int64) (int32, error)
StageMetadata stages object metadata for deferred registration.
type ListRecordsOptions ¶
type MetricsFilesOptions ¶
type MetricsService ¶
type MetricsService struct {
// contains filtered or unexported fields
}
func NewMetricsService ¶
func NewMetricsService(gen metricsapi.ClientWithResponsesInterface) *MetricsService
func (*MetricsService) File ¶
func (s *MetricsService) File(ctx context.Context, objectID string) (metricsapi.FileUsage, error)
func (*MetricsService) Files ¶
func (s *MetricsService) Files(ctx context.Context, opts MetricsFilesOptions) ([]metricsapi.FileUsage, error)
func (*MetricsService) Summary ¶
func (s *MetricsService) Summary(ctx context.Context, opts MetricsSummaryOptions) (metricsapi.FileUsageSummary, error)
func (*MetricsService) TransferBreakdown ¶
func (s *MetricsService) TransferBreakdown(ctx context.Context, opts TransferMetricsOptions) (metricsapi.TransferBreakdownResponse, error)
func (*MetricsService) TransferBreakdownPage ¶ added in v0.3.9
func (s *MetricsService) TransferBreakdownPage(ctx context.Context, opts TransferMetricsOptions, limit, offset int) (metricsapi.TransferBreakdownResponse, error)
TransferBreakdownPage fetches one bounded page. TransferBreakdown follows next_offset and collects every page for callers that need complete totals.
func (*MetricsService) TransferSummary ¶
func (s *MetricsService) TransferSummary(ctx context.Context, opts TransferMetricsOptions) (metricsapi.TransferAttributionSummary, error)