metricsapi

package
v0.2.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 27, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package metricsapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterHandlers 

func RegisterHandlers(router fiber.Router, si ServerInterface)

RegisterHandlers creates http.Handler with routing matching OpenAPI spec.

func RegisterHandlersWithOptions 

func RegisterHandlersWithOptions(router fiber.Router, si ServerInterface, options FiberServerOptions)

RegisterHandlersWithOptions creates http.Handler with additional options

Types

type AllowStale added in v0.2.5 

type AllowStale = bool

AllowStale defines model for AllowStale.

type Bucket added in v0.2.5 

type Bucket = string

Bucket defines model for Bucket.

type Direction added in v0.2.5 

type Direction = ProviderTransferDirection

Direction defines model for Direction.

type FiberServerOptions 

type FiberServerOptions struct {
	BaseURL     string
	Middlewares []MiddlewareFunc
}

FiberServerOptions provides options for the Fiber server.

type FileUsage 

type FileUsage struct {
	DownloadCount    *int64     `json:"download_count,omitempty"`
	LastAccessTime   *time.Time `json:"last_access_time"`
	LastDownloadTime *time.Time `json:"last_download_time"`
	LastUploadTime   *time.Time `json:"last_upload_time"`
	Name             *string    `json:"name,omitempty"`
	ObjectId         *string    `json:"object_id,omitempty"`
	Size             *int64     `json:"size,omitempty"`
	UploadCount      *int64     `json:"upload_count,omitempty"`
}

FileUsage defines model for FileUsage.

type FileUsageSummary 

type FileUsageSummary struct {
	InactiveFileCount *int64 `json:"inactive_file_count,omitempty"`
	TotalDownloads    *int64 `json:"total_downloads,omitempty"`
	TotalFiles        *int64 `json:"total_files,omitempty"`
	TotalUploads      *int64 `json:"total_uploads,omitempty"`
}

FileUsageSummary defines model for FileUsageSummary.

type From added in v0.2.5 

type From = time.Time

From defines model for From.

type GetMetricsFile200JSONResponse 

type GetMetricsFile200JSONResponse FileUsage

func (GetMetricsFile200JSONResponse) VisitGetMetricsFileResponse 

func (response GetMetricsFile200JSONResponse) VisitGetMetricsFileResponse(ctx fiber.Ctx) error

type GetMetricsFile400Response 

type GetMetricsFile400Response struct {
}

func (GetMetricsFile400Response) VisitGetMetricsFileResponse 

func (response GetMetricsFile400Response) VisitGetMetricsFileResponse(ctx fiber.Ctx) error

type GetMetricsFile401Response 

type GetMetricsFile401Response struct {
}

func (GetMetricsFile401Response) VisitGetMetricsFileResponse 

func (response GetMetricsFile401Response) VisitGetMetricsFileResponse(ctx fiber.Ctx) error

type GetMetricsFile403Response 

type GetMetricsFile403Response struct {
}

func (GetMetricsFile403Response) VisitGetMetricsFileResponse 

func (response GetMetricsFile403Response) VisitGetMetricsFileResponse(ctx fiber.Ctx) error

type GetMetricsFile404Response 

type GetMetricsFile404Response struct {
}

func (GetMetricsFile404Response) VisitGetMetricsFileResponse 

func (response GetMetricsFile404Response) VisitGetMetricsFileResponse(ctx fiber.Ctx) error

type GetMetricsFile500Response 

type GetMetricsFile500Response struct {
}

func (GetMetricsFile500Response) VisitGetMetricsFileResponse 

func (response GetMetricsFile500Response) VisitGetMetricsFileResponse(ctx fiber.Ctx) error

type GetMetricsFileParams added in v0.2.5 

type GetMetricsFileParams struct {
	// Organization Organization/program scope filter.
	Organization *Organization `form:"organization,omitempty" json:"organization,omitempty"`

	// Project Project scope filter. Requires organization when set.
	Project *Project `form:"project,omitempty" json:"project,omitempty"`
}

GetMetricsFileParams defines parameters for GetMetricsFile.

type GetMetricsFileRequestObject 

type GetMetricsFileRequestObject struct {
	ObjectId string `json:"object_id"`
	Params   GetMetricsFileParams
}

type GetMetricsFileResponseObject 

type GetMetricsFileResponseObject interface {
	VisitGetMetricsFileResponse(ctx fiber.Ctx) error
}

type GetMetricsSummary200JSONResponse 

type GetMetricsSummary200JSONResponse FileUsageSummary

func (GetMetricsSummary200JSONResponse) VisitGetMetricsSummaryResponse 

func (response GetMetricsSummary200JSONResponse) VisitGetMetricsSummaryResponse(ctx fiber.Ctx) error

type GetMetricsSummary400Response 

type GetMetricsSummary400Response struct {
}

func (GetMetricsSummary400Response) VisitGetMetricsSummaryResponse 

func (response GetMetricsSummary400Response) VisitGetMetricsSummaryResponse(ctx fiber.Ctx) error

type GetMetricsSummary401Response 

type GetMetricsSummary401Response struct {
}

func (GetMetricsSummary401Response) VisitGetMetricsSummaryResponse 

func (response GetMetricsSummary401Response) VisitGetMetricsSummaryResponse(ctx fiber.Ctx) error

type GetMetricsSummary403Response 

type GetMetricsSummary403Response struct {
}

func (GetMetricsSummary403Response) VisitGetMetricsSummaryResponse 

func (response GetMetricsSummary403Response) VisitGetMetricsSummaryResponse(ctx fiber.Ctx) error

type GetMetricsSummary500Response 

type GetMetricsSummary500Response struct {
}

func (GetMetricsSummary500Response) VisitGetMetricsSummaryResponse 

func (response GetMetricsSummary500Response) VisitGetMetricsSummaryResponse(ctx fiber.Ctx) error

type GetMetricsSummaryParams 

type GetMetricsSummaryParams struct {
	InactiveDays *int `form:"inactive_days,omitempty" json:"inactive_days,omitempty"`

	// Organization Organization/program scope filter.
	Organization *Organization `form:"organization,omitempty" json:"organization,omitempty"`

	// Project Project scope filter. Requires organization when set.
	Project *Project `form:"project,omitempty" json:"project,omitempty"`
}

GetMetricsSummaryParams defines parameters for GetMetricsSummary.

type GetMetricsSummaryRequestObject 

type GetMetricsSummaryRequestObject struct {
	Params GetMetricsSummaryParams
}

type GetMetricsSummaryResponseObject 

type GetMetricsSummaryResponseObject interface {
	VisitGetMetricsSummaryResponse(ctx fiber.Ctx) error
}

type GetTransferBreakdown200JSONResponse added in v0.2.5 

type GetTransferBreakdown200JSONResponse TransferBreakdownResponse

func (GetTransferBreakdown200JSONResponse) VisitGetTransferBreakdownResponse added in v0.2.5 

func (response GetTransferBreakdown200JSONResponse) VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error

type GetTransferBreakdown400Response added in v0.2.5 

type GetTransferBreakdown400Response struct {
}

func (GetTransferBreakdown400Response) VisitGetTransferBreakdownResponse added in v0.2.5 

func (response GetTransferBreakdown400Response) VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error

type GetTransferBreakdown401Response added in v0.2.5 

type GetTransferBreakdown401Response struct {
}

func (GetTransferBreakdown401Response) VisitGetTransferBreakdownResponse added in v0.2.5 

func (response GetTransferBreakdown401Response) VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error

type GetTransferBreakdown403Response added in v0.2.5 

type GetTransferBreakdown403Response struct {
}

func (GetTransferBreakdown403Response) VisitGetTransferBreakdownResponse added in v0.2.5 

func (response GetTransferBreakdown403Response) VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error

type GetTransferBreakdown500Response added in v0.2.5 

type GetTransferBreakdown500Response struct {
}

func (GetTransferBreakdown500Response) VisitGetTransferBreakdownResponse added in v0.2.5 

func (response GetTransferBreakdown500Response) VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error

type GetTransferBreakdownParams added in v0.2.5 

type GetTransferBreakdownParams struct {
	// Organization Organization/program scope filter.
	Organization *Organization `form:"organization,omitempty" json:"organization,omitempty"`

	// Project Project scope filter. Requires organization when set.
	Project              *Project              `form:"project,omitempty" json:"project,omitempty"`
	Direction            *Direction            `form:"direction,omitempty" json:"direction,omitempty"`
	ReconciliationStatus *ReconciliationStatus `form:"reconciliation_status,omitempty" json:"reconciliation_status,omitempty"`
	From                 *From                 `form:"from,omitempty" json:"from,omitempty"`
	To                   *To                   `form:"to,omitempty" json:"to,omitempty"`
	Provider             *Provider             `form:"provider,omitempty" json:"provider,omitempty"`
	Bucket               *Bucket               `form:"bucket,omitempty" json:"bucket,omitempty"`
	Sha256               *SHA256               `form:"sha256,omitempty" json:"sha256,omitempty"`

	// User Actor email or subject filter.
	User *User `form:"user,omitempty" json:"user,omitempty"`

	// AllowStale Deprecated. Transfer metrics always return persisted provider events with freshness metadata, including missing sync windows and latest completed sync time.
	AllowStale *AllowStale                        `form:"allow_stale,omitempty" json:"allow_stale,omitempty"`
	GroupBy    *GetTransferBreakdownParamsGroupBy `form:"group_by,omitempty" json:"group_by,omitempty"`
}

GetTransferBreakdownParams defines parameters for GetTransferBreakdown.

type GetTransferBreakdownParamsGroupBy added in v0.2.5 

type GetTransferBreakdownParamsGroupBy string

GetTransferBreakdownParamsGroupBy defines parameters for GetTransferBreakdown. 

const (
	GetTransferBreakdownParamsGroupByObject   GetTransferBreakdownParamsGroupBy = "object"
	GetTransferBreakdownParamsGroupByProvider GetTransferBreakdownParamsGroupBy = "provider"
	GetTransferBreakdownParamsGroupByScope    GetTransferBreakdownParamsGroupBy = "scope"
	GetTransferBreakdownParamsGroupByUser     GetTransferBreakdownParamsGroupBy = "user"
)

Defines values for GetTransferBreakdownParamsGroupBy.

type GetTransferBreakdownRequestObject added in v0.2.5 

type GetTransferBreakdownRequestObject struct {
	Params GetTransferBreakdownParams
}

type GetTransferBreakdownResponseObject added in v0.2.5 

type GetTransferBreakdownResponseObject interface {
	VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error
}

type GetTransferSummary200JSONResponse added in v0.2.5 

type GetTransferSummary200JSONResponse TransferAttributionSummary

func (GetTransferSummary200JSONResponse) VisitGetTransferSummaryResponse added in v0.2.5 

func (response GetTransferSummary200JSONResponse) VisitGetTransferSummaryResponse(ctx fiber.Ctx) error

type GetTransferSummary400Response added in v0.2.5 

type GetTransferSummary400Response struct {
}

func (GetTransferSummary400Response) VisitGetTransferSummaryResponse added in v0.2.5 

func (response GetTransferSummary400Response) VisitGetTransferSummaryResponse(ctx fiber.Ctx) error

type GetTransferSummary401Response added in v0.2.5 

type GetTransferSummary401Response struct {
}

func (GetTransferSummary401Response) VisitGetTransferSummaryResponse added in v0.2.5 

func (response GetTransferSummary401Response) VisitGetTransferSummaryResponse(ctx fiber.Ctx) error

type GetTransferSummary403Response added in v0.2.5 

type GetTransferSummary403Response struct {
}

func (GetTransferSummary403Response) VisitGetTransferSummaryResponse added in v0.2.5 

func (response GetTransferSummary403Response) VisitGetTransferSummaryResponse(ctx fiber.Ctx) error

type GetTransferSummary500Response added in v0.2.5 

type GetTransferSummary500Response struct {
}

func (GetTransferSummary500Response) VisitGetTransferSummaryResponse added in v0.2.5 

func (response GetTransferSummary500Response) VisitGetTransferSummaryResponse(ctx fiber.Ctx) error

type GetTransferSummaryParams added in v0.2.5 

type GetTransferSummaryParams struct {
	// Organization Organization/program scope filter.
	Organization *Organization `form:"organization,omitempty" json:"organization,omitempty"`

	// Project Project scope filter. Requires organization when set.
	Project              *Project              `form:"project,omitempty" json:"project,omitempty"`
	Direction            *Direction            `form:"direction,omitempty" json:"direction,omitempty"`
	ReconciliationStatus *ReconciliationStatus `form:"reconciliation_status,omitempty" json:"reconciliation_status,omitempty"`
	From                 *From                 `form:"from,omitempty" json:"from,omitempty"`
	To                   *To                   `form:"to,omitempty" json:"to,omitempty"`
	Provider             *Provider             `form:"provider,omitempty" json:"provider,omitempty"`
	Bucket               *Bucket               `form:"bucket,omitempty" json:"bucket,omitempty"`
	Sha256               *SHA256               `form:"sha256,omitempty" json:"sha256,omitempty"`

	// User Actor email or subject filter.
	User *User `form:"user,omitempty" json:"user,omitempty"`

	// AllowStale Deprecated. Transfer metrics always return persisted provider events with freshness metadata, including missing sync windows and latest completed sync time.
	AllowStale *AllowStale `form:"allow_stale,omitempty" json:"allow_stale,omitempty"`
}

GetTransferSummaryParams defines parameters for GetTransferSummary.

type GetTransferSummaryRequestObject added in v0.2.5 

type GetTransferSummaryRequestObject struct {
	Params GetTransferSummaryParams
}

type GetTransferSummaryResponseObject added in v0.2.5 

type GetTransferSummaryResponseObject interface {
	VisitGetTransferSummaryResponse(ctx fiber.Ctx) error
}

type ListMetricsFiles200JSONResponse 

type ListMetricsFiles200JSONResponse MetricsListResponse

func (ListMetricsFiles200JSONResponse) VisitListMetricsFilesResponse 

func (response ListMetricsFiles200JSONResponse) VisitListMetricsFilesResponse(ctx fiber.Ctx) error

type ListMetricsFiles400Response 

type ListMetricsFiles400Response struct {
}

func (ListMetricsFiles400Response) VisitListMetricsFilesResponse 

func (response ListMetricsFiles400Response) VisitListMetricsFilesResponse(ctx fiber.Ctx) error

type ListMetricsFiles401Response 

type ListMetricsFiles401Response struct {
}

func (ListMetricsFiles401Response) VisitListMetricsFilesResponse 

func (response ListMetricsFiles401Response) VisitListMetricsFilesResponse(ctx fiber.Ctx) error

type ListMetricsFiles403Response 

type ListMetricsFiles403Response struct {
}

func (ListMetricsFiles403Response) VisitListMetricsFilesResponse 

func (response ListMetricsFiles403Response) VisitListMetricsFilesResponse(ctx fiber.Ctx) error

type ListMetricsFiles500Response 

type ListMetricsFiles500Response struct {
}

func (ListMetricsFiles500Response) VisitListMetricsFilesResponse 

func (response ListMetricsFiles500Response) VisitListMetricsFilesResponse(ctx fiber.Ctx) error

type ListMetricsFilesParams 

type ListMetricsFilesParams struct {
	Limit        *int `form:"limit,omitempty" json:"limit,omitempty"`
	Offset       *int `form:"offset,omitempty" json:"offset,omitempty"`
	InactiveDays *int `form:"inactive_days,omitempty" json:"inactive_days,omitempty"`

	// Organization Organization/program scope filter.
	Organization *Organization `form:"organization,omitempty" json:"organization,omitempty"`

	// Project Project scope filter. Requires organization when set.
	Project *Project `form:"project,omitempty" json:"project,omitempty"`
}

ListMetricsFilesParams defines parameters for ListMetricsFiles.

type ListMetricsFilesRequestObject 

type ListMetricsFilesRequestObject struct {
	Params ListMetricsFilesParams
}

type ListMetricsFilesResponseObject 

type ListMetricsFilesResponseObject interface {
	VisitListMetricsFilesResponse(ctx fiber.Ctx) error
}

type ListProviderTransferSync200JSONResponse added in v0.2.5 

type ListProviderTransferSync200JSONResponse ProviderTransferSyncResponse

func (ListProviderTransferSync200JSONResponse) VisitListProviderTransferSyncResponse added in v0.2.5 

func (response ListProviderTransferSync200JSONResponse) VisitListProviderTransferSyncResponse(ctx fiber.Ctx) error

type ListProviderTransferSync400Response added in v0.2.5 

type ListProviderTransferSync400Response struct {
}

func (ListProviderTransferSync400Response) VisitListProviderTransferSyncResponse added in v0.2.5 

func (response ListProviderTransferSync400Response) VisitListProviderTransferSyncResponse(ctx fiber.Ctx) error

type ListProviderTransferSync401Response added in v0.2.5 

type ListProviderTransferSync401Response struct {
}

func (ListProviderTransferSync401Response) VisitListProviderTransferSyncResponse added in v0.2.5 

func (response ListProviderTransferSync401Response) VisitListProviderTransferSyncResponse(ctx fiber.Ctx) error

type ListProviderTransferSync403Response added in v0.2.5 

type ListProviderTransferSync403Response struct {
}

func (ListProviderTransferSync403Response) VisitListProviderTransferSyncResponse added in v0.2.5 

func (response ListProviderTransferSync403Response) VisitListProviderTransferSyncResponse(ctx fiber.Ctx) error

type ListProviderTransferSync500Response added in v0.2.5 

type ListProviderTransferSync500Response struct {
}

func (ListProviderTransferSync500Response) VisitListProviderTransferSyncResponse added in v0.2.5 

func (response ListProviderTransferSync500Response) VisitListProviderTransferSyncResponse(ctx fiber.Ctx) error

type ListProviderTransferSyncParams added in v0.2.5 

type ListProviderTransferSyncParams struct {
	// Organization Organization/program scope filter.
	Organization *Organization `form:"organization,omitempty" json:"organization,omitempty"`

	// Project Project scope filter. Requires organization when set.
	Project  *Project  `form:"project,omitempty" json:"project,omitempty"`
	From     *From     `form:"from,omitempty" json:"from,omitempty"`
	To       *To       `form:"to,omitempty" json:"to,omitempty"`
	Provider *Provider `form:"provider,omitempty" json:"provider,omitempty"`
	Bucket   *Bucket   `form:"bucket,omitempty" json:"bucket,omitempty"`
	Limit    *int      `form:"limit,omitempty" json:"limit,omitempty"`
}

ListProviderTransferSyncParams defines parameters for ListProviderTransferSync.

type ListProviderTransferSyncRequestObject added in v0.2.5 

type ListProviderTransferSyncRequestObject struct {
	Params ListProviderTransferSyncParams
}

type ListProviderTransferSyncResponseObject added in v0.2.5 

type ListProviderTransferSyncResponseObject interface {
	VisitListProviderTransferSyncResponse(ctx fiber.Ctx) error
}

type MetricsListResponse 

type MetricsListResponse struct {
	Data   *[]FileUsage `json:"data,omitempty"`
	Limit  *int         `json:"limit,omitempty"`
	Offset *int         `json:"offset,omitempty"`
}

MetricsListResponse defines model for MetricsListResponse.

type MiddlewareFunc 

type MiddlewareFunc fiber.Handler

type Organization added in v0.2.5 

type Organization = string

Organization defines model for Organization.

type Project added in v0.2.5 

type Project = string

Project defines model for Project.

type Provider added in v0.2.5 

type Provider = string

Provider defines model for Provider.

type ProviderTransferDirection added in v0.2.5 

type ProviderTransferDirection string

ProviderTransferDirection defines model for ProviderTransferDirection. 

const (
	Download ProviderTransferDirection = "download"
	Upload   ProviderTransferDirection = "upload"
)

Defines values for ProviderTransferDirection.

type ProviderTransferEvent added in v0.2.5 

type ProviderTransferEvent struct {
	AccessGrantId    *string                   `json:"access_grant_id,omitempty"`
	AccessId         *string                   `json:"access_id,omitempty"`
	ActorEmail       *string                   `json:"actor_email,omitempty"`
	ActorSubject     *string                   `json:"actor_subject,omitempty"`
	AuthMode         *string                   `json:"auth_mode,omitempty"`
	Bucket           string                    `json:"bucket"`
	BytesTransferred int64                     `json:"bytes_transferred"`
	Direction        ProviderTransferDirection `json:"direction"`
	EventTime        *time.Time                `json:"event_time,omitempty"`
	HttpMethod       *string                   `json:"http_method,omitempty"`
	HttpStatus       *int                      `json:"http_status,omitempty"`

	// ObjectId DRS object DID when known.
	ObjectId     *string `json:"object_id,omitempty"`
	ObjectKey    *string `json:"object_key,omitempty"`
	ObjectSize   *int64  `json:"object_size,omitempty"`
	Organization *string `json:"organization,omitempty"`
	Project      *string `json:"project,omitempty"`
	Provider     string  `json:"provider"`

	// ProviderEventId Provider/importer idempotency key.
	ProviderEventId      string                                `json:"provider_event_id"`
	ProviderRequestId    *string                               `json:"provider_request_id,omitempty"`
	RangeEnd             *int64                                `json:"range_end"`
	RangeStart           *int64                                `json:"range_start"`
	RawEventRef          *string                               `json:"raw_event_ref,omitempty"`
	ReconciliationStatus *ProviderTransferReconciliationStatus `json:"reconciliation_status,omitempty"`
	RequestId            *string                               `json:"request_id,omitempty"`
	RequesterPrincipal   *string                               `json:"requester_principal,omitempty"`
	Sha256               *string                               `json:"sha256,omitempty"`
	SourceIp             *string                               `json:"source_ip,omitempty"`
	StorageUrl           *string                               `json:"storage_url,omitempty"`
	UserAgent            *string                               `json:"user_agent,omitempty"`
}

ProviderTransferEvent defines model for ProviderTransferEvent.

type ProviderTransferEventsRequest added in v0.2.5 

type ProviderTransferEventsRequest struct {
	Events []ProviderTransferEvent `json:"events"`
}

ProviderTransferEventsRequest defines model for ProviderTransferEventsRequest.

type ProviderTransferReconciliationStatus added in v0.2.5 

type ProviderTransferReconciliationStatus string

ProviderTransferReconciliationStatus defines model for ProviderTransferReconciliationStatus. 

const (
	All       ProviderTransferReconciliationStatus = "all"
	Ambiguous ProviderTransferReconciliationStatus = "ambiguous"
	Matched   ProviderTransferReconciliationStatus = "matched"
	Unmatched ProviderTransferReconciliationStatus = "unmatched"
)

Defines values for ProviderTransferReconciliationStatus.

type ProviderTransferSyncRequest added in v0.2.5 

type ProviderTransferSyncRequest struct {
	AmbiguousEvents *int64 `json:"ambiguous_events,omitempty"`

	// Bucket Bucket filter. When omitted, all configured buckets are recorded.
	Bucket         *string   `json:"bucket,omitempty"`
	ErrorMessage   *string   `json:"error_message,omitempty"`
	From           time.Time `json:"from"`
	ImportedEvents *int64    `json:"imported_events,omitempty"`
	MatchedEvents  *int64    `json:"matched_events,omitempty"`
	Organization   *string   `json:"organization,omitempty"`
	Project        *string   `json:"project,omitempty"`

	// Provider Provider filter. When omitted, all configured buckets are recorded.
	Provider        *string                     `json:"provider,omitempty"`
	Status          *ProviderTransferSyncStatus `json:"status,omitempty"`
	To              time.Time                   `json:"to"`
	UnmatchedEvents *int64                      `json:"unmatched_events,omitempty"`
}

ProviderTransferSyncRequest defines model for ProviderTransferSyncRequest.

type ProviderTransferSyncResponse added in v0.2.5 

type ProviderTransferSyncResponse struct {
	Recorded *int                       `json:"recorded,omitempty"`
	SyncRuns *[]ProviderTransferSyncRun `json:"sync_runs,omitempty"`
}

ProviderTransferSyncResponse defines model for ProviderTransferSyncResponse.

type ProviderTransferSyncRun added in v0.2.5 

type ProviderTransferSyncRun struct {
	AmbiguousEvents *int64                      `json:"ambiguous_events,omitempty"`
	Bucket          *string                     `json:"bucket,omitempty"`
	CompletedAt     *time.Time                  `json:"completed_at"`
	ErrorMessage    *string                     `json:"error_message,omitempty"`
	From            *time.Time                  `json:"from,omitempty"`
	ImportedEvents  *int64                      `json:"imported_events,omitempty"`
	MatchedEvents   *int64                      `json:"matched_events,omitempty"`
	Organization    *string                     `json:"organization,omitempty"`
	Project         *string                     `json:"project,omitempty"`
	Provider        *string                     `json:"provider,omitempty"`
	RequestedAt     *time.Time                  `json:"requested_at,omitempty"`
	StartedAt       *time.Time                  `json:"started_at"`
	Status          *ProviderTransferSyncStatus `json:"status,omitempty"`
	SyncId          *string                     `json:"sync_id,omitempty"`
	To              *time.Time                  `json:"to,omitempty"`
	UnmatchedEvents *int64                      `json:"unmatched_events,omitempty"`
}

ProviderTransferSyncRun defines model for ProviderTransferSyncRun.

type ProviderTransferSyncStatus added in v0.2.5 

type ProviderTransferSyncStatus string

ProviderTransferSyncStatus defines model for ProviderTransferSyncStatus. 

const (
	Completed ProviderTransferSyncStatus = "completed"
	Failed    ProviderTransferSyncStatus = "failed"
	Pending   ProviderTransferSyncStatus = "pending"
)

Defines values for ProviderTransferSyncStatus.

type ReconciliationStatus added in v0.2.5 

type ReconciliationStatus = ProviderTransferReconciliationStatus

ReconciliationStatus defines model for ReconciliationStatus.

type RecordProviderTransferEvents201JSONResponse added in v0.2.5 

type RecordProviderTransferEvents201JSONResponse TransferEventsRecordedResponse

func (RecordProviderTransferEvents201JSONResponse) VisitRecordProviderTransferEventsResponse added in v0.2.5 

func (response RecordProviderTransferEvents201JSONResponse) VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error

type RecordProviderTransferEvents400Response added in v0.2.5 

type RecordProviderTransferEvents400Response struct {
}

func (RecordProviderTransferEvents400Response) VisitRecordProviderTransferEventsResponse added in v0.2.5 

func (response RecordProviderTransferEvents400Response) VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error

type RecordProviderTransferEvents401Response added in v0.2.5 

type RecordProviderTransferEvents401Response struct {
}

func (RecordProviderTransferEvents401Response) VisitRecordProviderTransferEventsResponse added in v0.2.5 

func (response RecordProviderTransferEvents401Response) VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error

type RecordProviderTransferEvents403Response added in v0.2.5 

type RecordProviderTransferEvents403Response struct {
}

func (RecordProviderTransferEvents403Response) VisitRecordProviderTransferEventsResponse added in v0.2.5 

func (response RecordProviderTransferEvents403Response) VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error

type RecordProviderTransferEvents500Response added in v0.2.5 

type RecordProviderTransferEvents500Response struct {
}

func (RecordProviderTransferEvents500Response) VisitRecordProviderTransferEventsResponse added in v0.2.5 

func (response RecordProviderTransferEvents500Response) VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error

type RecordProviderTransferEventsJSONRequestBody added in v0.2.5 

type RecordProviderTransferEventsJSONRequestBody = ProviderTransferEventsRequest

RecordProviderTransferEventsJSONRequestBody defines body for RecordProviderTransferEvents for application/json ContentType.

type RecordProviderTransferEventsParams added in v0.2.5 

type RecordProviderTransferEventsParams struct {
	// Organization Organization/program scope filter.
	Organization *Organization `form:"organization,omitempty" json:"organization,omitempty"`

	// Project Project scope filter. Requires organization when set.
	Project *Project `form:"project,omitempty" json:"project,omitempty"`
}

RecordProviderTransferEventsParams defines parameters for RecordProviderTransferEvents.

type RecordProviderTransferEventsRequestObject added in v0.2.5 

type RecordProviderTransferEventsRequestObject struct {
	Params RecordProviderTransferEventsParams
	Body   *RecordProviderTransferEventsJSONRequestBody
}

type RecordProviderTransferEventsResponseObject added in v0.2.5 

type RecordProviderTransferEventsResponseObject interface {
	VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error
}

type RecordProviderTransferSync201JSONResponse added in v0.2.5 

type RecordProviderTransferSync201JSONResponse ProviderTransferSyncResponse

func (RecordProviderTransferSync201JSONResponse) VisitRecordProviderTransferSyncResponse added in v0.2.5 

func (response RecordProviderTransferSync201JSONResponse) VisitRecordProviderTransferSyncResponse(ctx fiber.Ctx) error

type RecordProviderTransferSync400Response added in v0.2.5 

type RecordProviderTransferSync400Response struct {
}

func (RecordProviderTransferSync400Response) VisitRecordProviderTransferSyncResponse added in v0.2.5 

func (response RecordProviderTransferSync400Response) VisitRecordProviderTransferSyncResponse(ctx fiber.Ctx) error

type RecordProviderTransferSync401Response added in v0.2.5 

type RecordProviderTransferSync401Response struct {
}

func (RecordProviderTransferSync401Response) VisitRecordProviderTransferSyncResponse added in v0.2.5 

func (response RecordProviderTransferSync401Response) VisitRecordProviderTransferSyncResponse(ctx fiber.Ctx) error

type RecordProviderTransferSync403Response added in v0.2.5 

type RecordProviderTransferSync403Response struct {
}

func (RecordProviderTransferSync403Response) VisitRecordProviderTransferSyncResponse added in v0.2.5 

func (response RecordProviderTransferSync403Response) VisitRecordProviderTransferSyncResponse(ctx fiber.Ctx) error

type RecordProviderTransferSync500Response added in v0.2.5 

type RecordProviderTransferSync500Response struct {
}

func (RecordProviderTransferSync500Response) VisitRecordProviderTransferSyncResponse added in v0.2.5 

func (response RecordProviderTransferSync500Response) VisitRecordProviderTransferSyncResponse(ctx fiber.Ctx) error

type RecordProviderTransferSyncJSONRequestBody added in v0.2.5 

type RecordProviderTransferSyncJSONRequestBody = ProviderTransferSyncRequest

RecordProviderTransferSyncJSONRequestBody defines body for RecordProviderTransferSync for application/json ContentType.

type RecordProviderTransferSyncRequestObject added in v0.2.5 

type RecordProviderTransferSyncRequestObject struct {
	Body *RecordProviderTransferSyncJSONRequestBody
}

type RecordProviderTransferSyncResponseObject added in v0.2.5 

type RecordProviderTransferSyncResponseObject interface {
	VisitRecordProviderTransferSyncResponse(ctx fiber.Ctx) error
}

type SHA256 added in v0.2.5 

type SHA256 = string

SHA256 defines model for SHA256.

type ServerInterface 

type ServerInterface interface {

	// (GET /index/v1/metrics/files)
	ListMetricsFiles(c fiber.Ctx, params ListMetricsFilesParams) error

	// (GET /index/v1/metrics/files/{object_id})
	GetMetricsFile(c fiber.Ctx, objectId string, params GetMetricsFileParams) error
	// Record provider-observed transfer events
	// (POST /index/v1/metrics/provider-transfer-events)
	RecordProviderTransferEvents(c fiber.Ctx, params RecordProviderTransferEventsParams) error
	// List provider transfer log sync status
	// (GET /index/v1/metrics/provider-transfer-sync)
	ListProviderTransferSync(c fiber.Ctx, params ListProviderTransferSyncParams) error
	// Record provider transfer log sync status
	// (POST /index/v1/metrics/provider-transfer-sync)
	RecordProviderTransferSync(c fiber.Ctx) error

	// (GET /index/v1/metrics/summary)
	GetMetricsSummary(c fiber.Ctx, params GetMetricsSummaryParams) error
	// Group transfer attribution events
	// (GET /index/v1/metrics/transfers/breakdown)
	GetTransferBreakdown(c fiber.Ctx, params GetTransferBreakdownParams) error
	// Summarize transfer attribution events
	// (GET /index/v1/metrics/transfers/summary)
	GetTransferSummary(c fiber.Ctx, params GetTransferSummaryParams) error
}

ServerInterface represents all server handlers.

func NewStrictHandler 

func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) GetMetricsFile 

func (siw *ServerInterfaceWrapper) GetMetricsFile(c fiber.Ctx) error

GetMetricsFile operation middleware

func (*ServerInterfaceWrapper) GetMetricsSummary 

func (siw *ServerInterfaceWrapper) GetMetricsSummary(c fiber.Ctx) error

GetMetricsSummary operation middleware

func (*ServerInterfaceWrapper) GetTransferBreakdown added in v0.2.5 

func (siw *ServerInterfaceWrapper) GetTransferBreakdown(c fiber.Ctx) error

GetTransferBreakdown operation middleware

func (*ServerInterfaceWrapper) GetTransferSummary added in v0.2.5 

func (siw *ServerInterfaceWrapper) GetTransferSummary(c fiber.Ctx) error

GetTransferSummary operation middleware

func (*ServerInterfaceWrapper) ListMetricsFiles 

func (siw *ServerInterfaceWrapper) ListMetricsFiles(c fiber.Ctx) error

ListMetricsFiles operation middleware

func (*ServerInterfaceWrapper) ListProviderTransferSync added in v0.2.5 

func (siw *ServerInterfaceWrapper) ListProviderTransferSync(c fiber.Ctx) error

ListProviderTransferSync operation middleware

func (*ServerInterfaceWrapper) RecordProviderTransferEvents added in v0.2.5 

func (siw *ServerInterfaceWrapper) RecordProviderTransferEvents(c fiber.Ctx) error

RecordProviderTransferEvents operation middleware

func (*ServerInterfaceWrapper) RecordProviderTransferSync added in v0.2.5 

func (siw *ServerInterfaceWrapper) RecordProviderTransferSync(c fiber.Ctx) error

RecordProviderTransferSync operation middleware

type StrictHandlerFunc 

type StrictHandlerFunc func(ctx fiber.Ctx, args interface{}) (interface{}, error)

type StrictMiddlewareFunc 

type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

type StrictServerInterface 

type StrictServerInterface interface {

	// (GET /index/v1/metrics/files)
	ListMetricsFiles(ctx context.Context, request ListMetricsFilesRequestObject) (ListMetricsFilesResponseObject, error)

	// (GET /index/v1/metrics/files/{object_id})
	GetMetricsFile(ctx context.Context, request GetMetricsFileRequestObject) (GetMetricsFileResponseObject, error)
	// Record provider-observed transfer events
	// (POST /index/v1/metrics/provider-transfer-events)
	RecordProviderTransferEvents(ctx context.Context, request RecordProviderTransferEventsRequestObject) (RecordProviderTransferEventsResponseObject, error)
	// List provider transfer log sync status
	// (GET /index/v1/metrics/provider-transfer-sync)
	ListProviderTransferSync(ctx context.Context, request ListProviderTransferSyncRequestObject) (ListProviderTransferSyncResponseObject, error)
	// Record provider transfer log sync status
	// (POST /index/v1/metrics/provider-transfer-sync)
	RecordProviderTransferSync(ctx context.Context, request RecordProviderTransferSyncRequestObject) (RecordProviderTransferSyncResponseObject, error)

	// (GET /index/v1/metrics/summary)
	GetMetricsSummary(ctx context.Context, request GetMetricsSummaryRequestObject) (GetMetricsSummaryResponseObject, error)
	// Group transfer attribution events
	// (GET /index/v1/metrics/transfers/breakdown)
	GetTransferBreakdown(ctx context.Context, request GetTransferBreakdownRequestObject) (GetTransferBreakdownResponseObject, error)
	// Summarize transfer attribution events
	// (GET /index/v1/metrics/transfers/summary)
	GetTransferSummary(ctx context.Context, request GetTransferSummaryRequestObject) (GetTransferSummaryResponseObject, error)
}

StrictServerInterface represents all server handlers.

type To added in v0.2.5 

type To = time.Time

To defines model for To.

type TransferAttributionBreakdown added in v0.2.5 

type TransferAttributionBreakdown struct {
	ActorEmail       *string    `json:"actor_email,omitempty"`
	ActorSubject     *string    `json:"actor_subject,omitempty"`
	Bucket           *string    `json:"bucket,omitempty"`
	BytesDownloaded  *int64     `json:"bytes_downloaded,omitempty"`
	BytesRequested   *int64     `json:"bytes_requested,omitempty"`
	BytesUploaded    *int64     `json:"bytes_uploaded,omitempty"`
	EventCount       *int64     `json:"event_count,omitempty"`
	Key              *string    `json:"key,omitempty"`
	LastTransferTime *time.Time `json:"last_transfer_time"`
	Organization     *string    `json:"organization,omitempty"`
	Project          *string    `json:"project,omitempty"`
	Provider         *string    `json:"provider,omitempty"`
	Sha256           *string    `json:"sha256,omitempty"`
}

TransferAttributionBreakdown defines model for TransferAttributionBreakdown.

type TransferAttributionSummary added in v0.2.5 

type TransferAttributionSummary struct {
	AccessIssuedCount  *int64                    `json:"access_issued_count,omitempty"`
	BytesDownloaded    *int64                    `json:"bytes_downloaded,omitempty"`
	BytesRequested     *int64                    `json:"bytes_requested,omitempty"`
	BytesUploaded      *int64                    `json:"bytes_uploaded,omitempty"`
	DownloadEventCount *int64                    `json:"download_event_count,omitempty"`
	EventCount         *int64                    `json:"event_count,omitempty"`
	Freshness          *TransferMetricsFreshness `json:"freshness,omitempty"`
	UploadEventCount   *int64                    `json:"upload_event_count,omitempty"`
}

TransferAttributionSummary defines model for TransferAttributionSummary.

type TransferBreakdownResponse added in v0.2.5 

type TransferBreakdownResponse struct {
	Data      *[]TransferAttributionBreakdown   `json:"data,omitempty"`
	Freshness *TransferMetricsFreshness         `json:"freshness,omitempty"`
	GroupBy   *TransferBreakdownResponseGroupBy `json:"group_by,omitempty"`
}

TransferBreakdownResponse defines model for TransferBreakdownResponse.

type TransferBreakdownResponseGroupBy added in v0.2.5 

type TransferBreakdownResponseGroupBy string

TransferBreakdownResponseGroupBy defines model for TransferBreakdownResponse.GroupBy. 

const (
	TransferBreakdownResponseGroupByObject   TransferBreakdownResponseGroupBy = "object"
	TransferBreakdownResponseGroupByProvider TransferBreakdownResponseGroupBy = "provider"
	TransferBreakdownResponseGroupByScope    TransferBreakdownResponseGroupBy = "scope"
	TransferBreakdownResponseGroupByUser     TransferBreakdownResponseGroupBy = "user"
)

Defines values for TransferBreakdownResponseGroupBy.

type TransferEventsRecordedResponse added in v0.2.5 

type TransferEventsRecordedResponse struct {
	Recorded *int `json:"recorded,omitempty"`
}

TransferEventsRecordedResponse defines model for TransferEventsRecordedResponse.

type TransferMetricsFreshness added in v0.2.5 

type TransferMetricsFreshness struct {
	IsStale             *bool      `json:"is_stale,omitempty"`
	LatestCompletedSync *time.Time `json:"latest_completed_sync"`
	MissingBuckets      *[]string  `json:"missing_buckets,omitempty"`
	RequiredFrom        *time.Time `json:"required_from"`
	RequiredTo          *time.Time `json:"required_to"`
}

TransferMetricsFreshness defines model for TransferMetricsFreshness.

type User added in v0.2.5 

type User = string

User defines model for User.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.