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 ¶
- func NewBulkMetricsFilesRequest(server string, params *BulkMetricsFilesParams, ...) (*http.Request, error)
- func NewBulkMetricsFilesRequestWithBody(server string, params *BulkMetricsFilesParams, contentType string, ...) (*http.Request, error)
- func NewGetMetricsFileRequest(server string, objectId string, params *GetMetricsFileParams) (*http.Request, error)
- func NewGetMetricsSummaryRequest(server string, params *GetMetricsSummaryParams) (*http.Request, error)
- func NewGetTransferBreakdownRequest(server string, params *GetTransferBreakdownParams) (*http.Request, error)
- func NewGetTransferSummaryRequest(server string, params *GetTransferSummaryParams) (*http.Request, error)
- func NewListMetricsFilesRequest(server string, params *ListMetricsFilesParams) (*http.Request, error)
- func NewRecordProviderTransferEventsRequest(server string, params *RecordProviderTransferEventsParams, ...) (*http.Request, error)
- func NewRecordProviderTransferEventsRequestWithBody(server string, params *RecordProviderTransferEventsParams, contentType string, ...) (*http.Request, error)
- func RegisterHandlers(router fiber.Router, si ServerInterface)
- func RegisterHandlersWithOptions(router fiber.Router, si ServerInterface, options FiberServerOptions)
- type APIError
- type AllowStale
- type Bucket
- type BulkMetricsFiles200JSONResponse
- type BulkMetricsFiles400JSONResponse
- type BulkMetricsFiles401JSONResponse
- type BulkMetricsFiles403JSONResponse
- type BulkMetricsFiles500JSONResponse
- type BulkMetricsFilesJSONRequestBody
- type BulkMetricsFilesParams
- type BulkMetricsFilesRequestObject
- type BulkMetricsFilesResponse
- type BulkMetricsFilesResponseObject
- type Client
- func (c *Client) BulkMetricsFiles(ctx context.Context, params *BulkMetricsFilesParams, ...) (*http.Response, error)
- func (c *Client) BulkMetricsFilesWithBody(ctx context.Context, params *BulkMetricsFilesParams, contentType string, ...) (*http.Response, error)
- func (c *Client) GetMetricsFile(ctx context.Context, objectId string, params *GetMetricsFileParams, ...) (*http.Response, error)
- func (c *Client) GetMetricsSummary(ctx context.Context, params *GetMetricsSummaryParams, ...) (*http.Response, error)
- func (c *Client) GetTransferBreakdown(ctx context.Context, params *GetTransferBreakdownParams, ...) (*http.Response, error)
- func (c *Client) GetTransferSummary(ctx context.Context, params *GetTransferSummaryParams, ...) (*http.Response, error)
- func (c *Client) ListMetricsFiles(ctx context.Context, params *ListMetricsFilesParams, ...) (*http.Response, error)
- func (c *Client) RecordProviderTransferEvents(ctx context.Context, params *RecordProviderTransferEventsParams, ...) (*http.Response, error)
- func (c *Client) RecordProviderTransferEventsWithBody(ctx context.Context, params *RecordProviderTransferEventsParams, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) BulkMetricsFilesWithBodyWithResponse(ctx context.Context, params *BulkMetricsFilesParams, contentType string, ...) (*BulkMetricsFilesResponse, error)
- func (c *ClientWithResponses) BulkMetricsFilesWithResponse(ctx context.Context, params *BulkMetricsFilesParams, ...) (*BulkMetricsFilesResponse, error)
- func (c *ClientWithResponses) GetMetricsFileWithResponse(ctx context.Context, objectId string, params *GetMetricsFileParams, ...) (*GetMetricsFileResponse, error)
- func (c *ClientWithResponses) GetMetricsSummaryWithResponse(ctx context.Context, params *GetMetricsSummaryParams, ...) (*GetMetricsSummaryResponse, error)
- func (c *ClientWithResponses) GetTransferBreakdownWithResponse(ctx context.Context, params *GetTransferBreakdownParams, ...) (*GetTransferBreakdownResponse, error)
- func (c *ClientWithResponses) GetTransferSummaryWithResponse(ctx context.Context, params *GetTransferSummaryParams, ...) (*GetTransferSummaryResponse, error)
- func (c *ClientWithResponses) ListMetricsFilesWithResponse(ctx context.Context, params *ListMetricsFilesParams, ...) (*ListMetricsFilesResponse, error)
- func (c *ClientWithResponses) RecordProviderTransferEventsWithBodyWithResponse(ctx context.Context, params *RecordProviderTransferEventsParams, ...) (*RecordProviderTransferEventsResponse, error)
- func (c *ClientWithResponses) RecordProviderTransferEventsWithResponse(ctx context.Context, params *RecordProviderTransferEventsParams, ...) (*RecordProviderTransferEventsResponse, error)
- type ClientWithResponsesInterface
- type Direction
- type FiberServerOptions
- type FileUsage
- type FileUsageBulkRequest
- type FileUsageSummary
- type From
- type GetMetricsFile200JSONResponse
- type GetMetricsFile400JSONResponse
- type GetMetricsFile401JSONResponse
- type GetMetricsFile403JSONResponse
- type GetMetricsFile404JSONResponse
- type GetMetricsFile500JSONResponse
- type GetMetricsFileParams
- type GetMetricsFileRequestObject
- type GetMetricsFileResponse
- type GetMetricsFileResponseObject
- type GetMetricsSummary200JSONResponse
- type GetMetricsSummary400JSONResponse
- type GetMetricsSummary401JSONResponse
- type GetMetricsSummary403JSONResponse
- type GetMetricsSummary500JSONResponse
- type GetMetricsSummaryParams
- type GetMetricsSummaryRequestObject
- type GetMetricsSummaryResponse
- type GetMetricsSummaryResponseObject
- type GetTransferBreakdown200JSONResponse
- type GetTransferBreakdown400JSONResponse
- type GetTransferBreakdown401JSONResponse
- type GetTransferBreakdown403JSONResponse
- type GetTransferBreakdown500JSONResponse
- type GetTransferBreakdownParams
- type GetTransferBreakdownParamsGroupBy
- type GetTransferBreakdownRequestObject
- type GetTransferBreakdownResponse
- type GetTransferBreakdownResponseObject
- type GetTransferSummary200JSONResponse
- type GetTransferSummary400JSONResponse
- type GetTransferSummary401JSONResponse
- type GetTransferSummary403JSONResponse
- type GetTransferSummary500JSONResponse
- type GetTransferSummaryParams
- type GetTransferSummaryRequestObject
- type GetTransferSummaryResponse
- type GetTransferSummaryResponseObject
- type HttpRequestDoer
- type ListMetricsFiles200JSONResponse
- type ListMetricsFiles400JSONResponse
- type ListMetricsFiles401JSONResponse
- type ListMetricsFiles403JSONResponse
- type ListMetricsFiles500JSONResponse
- type ListMetricsFilesParams
- type ListMetricsFilesRequestObject
- type ListMetricsFilesResponse
- type ListMetricsFilesResponseObject
- type MetricsListResponse
- type MiddlewareFunc
- type Organization
- type Project
- type Provider
- type ProviderTransferDirection
- type ProviderTransferEvent
- type ProviderTransferEventsRequest
- type ProviderTransferReconciliationStatus
- type ReconciliationStatus
- type RecordProviderTransferEvents201JSONResponse
- type RecordProviderTransferEvents400JSONResponse
- type RecordProviderTransferEvents401JSONResponse
- type RecordProviderTransferEvents403JSONResponse
- type RecordProviderTransferEvents500JSONResponse
- type RecordProviderTransferEventsJSONRequestBody
- type RecordProviderTransferEventsParams
- type RecordProviderTransferEventsRequestObject
- type RecordProviderTransferEventsResponse
- type RecordProviderTransferEventsResponseObject
- type RequestEditorFn
- type SHA256
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) BulkMetricsFiles(c fiber.Ctx) error
- func (siw *ServerInterfaceWrapper) GetMetricsFile(c fiber.Ctx) error
- func (siw *ServerInterfaceWrapper) GetMetricsSummary(c fiber.Ctx) error
- func (siw *ServerInterfaceWrapper) GetTransferBreakdown(c fiber.Ctx) error
- func (siw *ServerInterfaceWrapper) GetTransferSummary(c fiber.Ctx) error
- func (siw *ServerInterfaceWrapper) ListMetricsFiles(c fiber.Ctx) error
- func (siw *ServerInterfaceWrapper) RecordProviderTransferEvents(c fiber.Ctx) error
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type To
- type TransferAttributionBreakdown
- type TransferAttributionSummary
- type TransferBreakdownResponse
- type TransferBreakdownResponseGroupBy
- type TransferEventsRecordedResponse
- type TransferMetricsFreshness
- type User
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewBulkMetricsFilesRequest ¶
func NewBulkMetricsFilesRequest(server string, params *BulkMetricsFilesParams, body BulkMetricsFilesJSONRequestBody) (*http.Request, error)
NewBulkMetricsFilesRequest calls the generic BulkMetricsFiles builder with application/json body
func NewBulkMetricsFilesRequestWithBody ¶
func NewBulkMetricsFilesRequestWithBody(server string, params *BulkMetricsFilesParams, contentType string, body io.Reader) (*http.Request, error)
NewBulkMetricsFilesRequestWithBody generates requests for BulkMetricsFiles with any type of body
func NewGetMetricsFileRequest ¶
func NewGetMetricsFileRequest(server string, objectId string, params *GetMetricsFileParams) (*http.Request, error)
NewGetMetricsFileRequest generates requests for GetMetricsFile
func NewGetMetricsSummaryRequest ¶
func NewGetMetricsSummaryRequest(server string, params *GetMetricsSummaryParams) (*http.Request, error)
NewGetMetricsSummaryRequest generates requests for GetMetricsSummary
func NewGetTransferBreakdownRequest ¶
func NewGetTransferBreakdownRequest(server string, params *GetTransferBreakdownParams) (*http.Request, error)
NewGetTransferBreakdownRequest generates requests for GetTransferBreakdown
func NewGetTransferSummaryRequest ¶
func NewGetTransferSummaryRequest(server string, params *GetTransferSummaryParams) (*http.Request, error)
NewGetTransferSummaryRequest generates requests for GetTransferSummary
func NewListMetricsFilesRequest ¶
func NewListMetricsFilesRequest(server string, params *ListMetricsFilesParams) (*http.Request, error)
NewListMetricsFilesRequest generates requests for ListMetricsFiles
func NewRecordProviderTransferEventsRequest ¶
func NewRecordProviderTransferEventsRequest(server string, params *RecordProviderTransferEventsParams, body RecordProviderTransferEventsJSONRequestBody) (*http.Request, error)
NewRecordProviderTransferEventsRequest calls the generic RecordProviderTransferEvents builder with application/json body
func NewRecordProviderTransferEventsRequestWithBody ¶
func NewRecordProviderTransferEventsRequestWithBody(server string, params *RecordProviderTransferEventsParams, contentType string, body io.Reader) (*http.Request, error)
NewRecordProviderTransferEventsRequestWithBody generates requests for RecordProviderTransferEvents with any type of body
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 BulkMetricsFiles200JSONResponse ¶
type BulkMetricsFiles200JSONResponse MetricsListResponse
func (BulkMetricsFiles200JSONResponse) VisitBulkMetricsFilesResponse ¶
func (response BulkMetricsFiles200JSONResponse) VisitBulkMetricsFilesResponse(ctx fiber.Ctx) error
type BulkMetricsFiles400JSONResponse ¶
type BulkMetricsFiles400JSONResponse APIError
func (BulkMetricsFiles400JSONResponse) VisitBulkMetricsFilesResponse ¶
func (response BulkMetricsFiles400JSONResponse) VisitBulkMetricsFilesResponse(ctx fiber.Ctx) error
type BulkMetricsFiles401JSONResponse ¶
type BulkMetricsFiles401JSONResponse APIError
func (BulkMetricsFiles401JSONResponse) VisitBulkMetricsFilesResponse ¶
func (response BulkMetricsFiles401JSONResponse) VisitBulkMetricsFilesResponse(ctx fiber.Ctx) error
type BulkMetricsFiles403JSONResponse ¶
type BulkMetricsFiles403JSONResponse APIError
func (BulkMetricsFiles403JSONResponse) VisitBulkMetricsFilesResponse ¶
func (response BulkMetricsFiles403JSONResponse) VisitBulkMetricsFilesResponse(ctx fiber.Ctx) error
type BulkMetricsFiles500JSONResponse ¶
type BulkMetricsFiles500JSONResponse APIError
func (BulkMetricsFiles500JSONResponse) VisitBulkMetricsFilesResponse ¶
func (response BulkMetricsFiles500JSONResponse) VisitBulkMetricsFilesResponse(ctx fiber.Ctx) error
type BulkMetricsFilesJSONRequestBody ¶
type BulkMetricsFilesJSONRequestBody = FileUsageBulkRequest
BulkMetricsFilesJSONRequestBody defines body for BulkMetricsFiles for application/json ContentType.
type BulkMetricsFilesParams ¶
type BulkMetricsFilesParams 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"`
}
BulkMetricsFilesParams defines parameters for BulkMetricsFiles.
type BulkMetricsFilesRequestObject ¶
type BulkMetricsFilesRequestObject struct {
Params BulkMetricsFilesParams
Body *BulkMetricsFilesJSONRequestBody
}
type BulkMetricsFilesResponse ¶
type BulkMetricsFilesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *MetricsListResponse
JSON400 *APIError
JSON401 *APIError
JSON403 *APIError
JSON500 *APIError
}
func ParseBulkMetricsFilesResponse ¶
func ParseBulkMetricsFilesResponse(rsp *http.Response) (*BulkMetricsFilesResponse, error)
ParseBulkMetricsFilesResponse parses an HTTP response from a BulkMetricsFilesWithResponse call
func (BulkMetricsFilesResponse) Status ¶
func (r BulkMetricsFilesResponse) Status() string
Status returns HTTPResponse.Status
func (BulkMetricsFilesResponse) StatusCode ¶
func (r BulkMetricsFilesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) BulkMetricsFiles ¶
func (c *Client) BulkMetricsFiles(ctx context.Context, params *BulkMetricsFilesParams, body BulkMetricsFilesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) BulkMetricsFilesWithBody ¶
func (*Client) GetMetricsFile ¶
func (c *Client) GetMetricsFile(ctx context.Context, objectId string, params *GetMetricsFileParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetMetricsSummary ¶
func (c *Client) GetMetricsSummary(ctx context.Context, params *GetMetricsSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetTransferBreakdown ¶
func (c *Client) GetTransferBreakdown(ctx context.Context, params *GetTransferBreakdownParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetTransferSummary ¶
func (c *Client) GetTransferSummary(ctx context.Context, params *GetTransferSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListMetricsFiles ¶
func (c *Client) ListMetricsFiles(ctx context.Context, params *ListMetricsFilesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) RecordProviderTransferEvents ¶
func (c *Client) RecordProviderTransferEvents(ctx context.Context, params *RecordProviderTransferEventsParams, body RecordProviderTransferEventsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) RecordProviderTransferEventsWithBody ¶
type ClientInterface ¶
type ClientInterface interface {
// ListMetricsFiles request
ListMetricsFiles(ctx context.Context, params *ListMetricsFilesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// BulkMetricsFilesWithBody request with any body
BulkMetricsFilesWithBody(ctx context.Context, params *BulkMetricsFilesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
BulkMetricsFiles(ctx context.Context, params *BulkMetricsFilesParams, body BulkMetricsFilesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetMetricsFile request
GetMetricsFile(ctx context.Context, objectId string, params *GetMetricsFileParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// RecordProviderTransferEventsWithBody request with any body
RecordProviderTransferEventsWithBody(ctx context.Context, params *RecordProviderTransferEventsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
RecordProviderTransferEvents(ctx context.Context, params *RecordProviderTransferEventsParams, body RecordProviderTransferEventsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetMetricsSummary request
GetMetricsSummary(ctx context.Context, params *GetMetricsSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetTransferBreakdown request
GetTransferBreakdown(ctx context.Context, params *GetTransferBreakdownParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetTransferSummary request
GetTransferSummary(ctx context.Context, params *GetTransferSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) BulkMetricsFilesWithBodyWithResponse ¶
func (c *ClientWithResponses) BulkMetricsFilesWithBodyWithResponse(ctx context.Context, params *BulkMetricsFilesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkMetricsFilesResponse, error)
BulkMetricsFilesWithBodyWithResponse request with arbitrary body returning *BulkMetricsFilesResponse
func (*ClientWithResponses) BulkMetricsFilesWithResponse ¶
func (c *ClientWithResponses) BulkMetricsFilesWithResponse(ctx context.Context, params *BulkMetricsFilesParams, body BulkMetricsFilesJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkMetricsFilesResponse, error)
func (*ClientWithResponses) GetMetricsFileWithResponse ¶
func (c *ClientWithResponses) GetMetricsFileWithResponse(ctx context.Context, objectId string, params *GetMetricsFileParams, reqEditors ...RequestEditorFn) (*GetMetricsFileResponse, error)
GetMetricsFileWithResponse request returning *GetMetricsFileResponse
func (*ClientWithResponses) GetMetricsSummaryWithResponse ¶
func (c *ClientWithResponses) GetMetricsSummaryWithResponse(ctx context.Context, params *GetMetricsSummaryParams, reqEditors ...RequestEditorFn) (*GetMetricsSummaryResponse, error)
GetMetricsSummaryWithResponse request returning *GetMetricsSummaryResponse
func (*ClientWithResponses) GetTransferBreakdownWithResponse ¶
func (c *ClientWithResponses) GetTransferBreakdownWithResponse(ctx context.Context, params *GetTransferBreakdownParams, reqEditors ...RequestEditorFn) (*GetTransferBreakdownResponse, error)
GetTransferBreakdownWithResponse request returning *GetTransferBreakdownResponse
func (*ClientWithResponses) GetTransferSummaryWithResponse ¶
func (c *ClientWithResponses) GetTransferSummaryWithResponse(ctx context.Context, params *GetTransferSummaryParams, reqEditors ...RequestEditorFn) (*GetTransferSummaryResponse, error)
GetTransferSummaryWithResponse request returning *GetTransferSummaryResponse
func (*ClientWithResponses) ListMetricsFilesWithResponse ¶
func (c *ClientWithResponses) ListMetricsFilesWithResponse(ctx context.Context, params *ListMetricsFilesParams, reqEditors ...RequestEditorFn) (*ListMetricsFilesResponse, error)
ListMetricsFilesWithResponse request returning *ListMetricsFilesResponse
func (*ClientWithResponses) RecordProviderTransferEventsWithBodyWithResponse ¶
func (c *ClientWithResponses) RecordProviderTransferEventsWithBodyWithResponse(ctx context.Context, params *RecordProviderTransferEventsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RecordProviderTransferEventsResponse, error)
RecordProviderTransferEventsWithBodyWithResponse request with arbitrary body returning *RecordProviderTransferEventsResponse
func (*ClientWithResponses) RecordProviderTransferEventsWithResponse ¶
func (c *ClientWithResponses) RecordProviderTransferEventsWithResponse(ctx context.Context, params *RecordProviderTransferEventsParams, body RecordProviderTransferEventsJSONRequestBody, reqEditors ...RequestEditorFn) (*RecordProviderTransferEventsResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// ListMetricsFilesWithResponse request
ListMetricsFilesWithResponse(ctx context.Context, params *ListMetricsFilesParams, reqEditors ...RequestEditorFn) (*ListMetricsFilesResponse, error)
// BulkMetricsFilesWithBodyWithResponse request with any body
BulkMetricsFilesWithBodyWithResponse(ctx context.Context, params *BulkMetricsFilesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkMetricsFilesResponse, error)
BulkMetricsFilesWithResponse(ctx context.Context, params *BulkMetricsFilesParams, body BulkMetricsFilesJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkMetricsFilesResponse, error)
// GetMetricsFileWithResponse request
GetMetricsFileWithResponse(ctx context.Context, objectId string, params *GetMetricsFileParams, reqEditors ...RequestEditorFn) (*GetMetricsFileResponse, error)
// RecordProviderTransferEventsWithBodyWithResponse request with any body
RecordProviderTransferEventsWithBodyWithResponse(ctx context.Context, params *RecordProviderTransferEventsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RecordProviderTransferEventsResponse, error)
RecordProviderTransferEventsWithResponse(ctx context.Context, params *RecordProviderTransferEventsParams, body RecordProviderTransferEventsJSONRequestBody, reqEditors ...RequestEditorFn) (*RecordProviderTransferEventsResponse, error)
// GetMetricsSummaryWithResponse request
GetMetricsSummaryWithResponse(ctx context.Context, params *GetMetricsSummaryParams, reqEditors ...RequestEditorFn) (*GetMetricsSummaryResponse, error)
// GetTransferBreakdownWithResponse request
GetTransferBreakdownWithResponse(ctx context.Context, params *GetTransferBreakdownParams, reqEditors ...RequestEditorFn) (*GetTransferBreakdownResponse, error)
// GetTransferSummaryWithResponse request
GetTransferSummaryWithResponse(ctx context.Context, params *GetTransferSummaryParams, reqEditors ...RequestEditorFn) (*GetTransferSummaryResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
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 FileUsageBulkRequest ¶
type FileUsageBulkRequest struct {
InactiveDays *int `json:"inactive_days,omitempty"`
ObjectIds []string `json:"object_ids"`
}
FileUsageBulkRequest defines model for FileUsageBulkRequest.
type FileUsageSummary ¶
type FileUsageSummary struct {
InactiveFileCount *int64 `json:"inactive_file_count,omitempty"`
RecordCount *int64 `json:"record_count,omitempty"`
RecordLatestUpdatedTime *time.Time `json:"record_latest_updated_time"`
TotalDownloads *int64 `json:"total_downloads,omitempty"`
TotalFiles *int64 `json:"total_files,omitempty"`
TotalUploads *int64 `json:"total_uploads,omitempty"`
}
FileUsageSummary defines model for FileUsageSummary.
type GetMetricsFile200JSONResponse ¶
type GetMetricsFile200JSONResponse FileUsage
func (GetMetricsFile200JSONResponse) VisitGetMetricsFileResponse ¶
func (response GetMetricsFile200JSONResponse) VisitGetMetricsFileResponse(ctx fiber.Ctx) error
type GetMetricsFile400JSONResponse ¶
type GetMetricsFile400JSONResponse APIError
func (GetMetricsFile400JSONResponse) VisitGetMetricsFileResponse ¶
func (response GetMetricsFile400JSONResponse) VisitGetMetricsFileResponse(ctx fiber.Ctx) error
type GetMetricsFile401JSONResponse ¶
type GetMetricsFile401JSONResponse APIError
func (GetMetricsFile401JSONResponse) VisitGetMetricsFileResponse ¶
func (response GetMetricsFile401JSONResponse) VisitGetMetricsFileResponse(ctx fiber.Ctx) error
type GetMetricsFile403JSONResponse ¶
type GetMetricsFile403JSONResponse APIError
func (GetMetricsFile403JSONResponse) VisitGetMetricsFileResponse ¶
func (response GetMetricsFile403JSONResponse) VisitGetMetricsFileResponse(ctx fiber.Ctx) error
type GetMetricsFile404JSONResponse ¶
type GetMetricsFile404JSONResponse APIError
func (GetMetricsFile404JSONResponse) VisitGetMetricsFileResponse ¶
func (response GetMetricsFile404JSONResponse) VisitGetMetricsFileResponse(ctx fiber.Ctx) error
type GetMetricsFile500JSONResponse ¶
type GetMetricsFile500JSONResponse APIError
func (GetMetricsFile500JSONResponse) VisitGetMetricsFileResponse ¶
func (response GetMetricsFile500JSONResponse) VisitGetMetricsFileResponse(ctx fiber.Ctx) error
type GetMetricsFileParams ¶
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 GetMetricsFileResponse ¶
type GetMetricsFileResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FileUsage
JSON400 *APIError
JSON401 *APIError
JSON403 *APIError
JSON404 *APIError
JSON500 *APIError
}
func ParseGetMetricsFileResponse ¶
func ParseGetMetricsFileResponse(rsp *http.Response) (*GetMetricsFileResponse, error)
ParseGetMetricsFileResponse parses an HTTP response from a GetMetricsFileWithResponse call
func (GetMetricsFileResponse) Status ¶
func (r GetMetricsFileResponse) Status() string
Status returns HTTPResponse.Status
func (GetMetricsFileResponse) StatusCode ¶
func (r GetMetricsFileResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetMetricsSummary200JSONResponse ¶
type GetMetricsSummary200JSONResponse FileUsageSummary
func (GetMetricsSummary200JSONResponse) VisitGetMetricsSummaryResponse ¶
func (response GetMetricsSummary200JSONResponse) VisitGetMetricsSummaryResponse(ctx fiber.Ctx) error
type GetMetricsSummary400JSONResponse ¶
type GetMetricsSummary400JSONResponse APIError
func (GetMetricsSummary400JSONResponse) VisitGetMetricsSummaryResponse ¶
func (response GetMetricsSummary400JSONResponse) VisitGetMetricsSummaryResponse(ctx fiber.Ctx) error
type GetMetricsSummary401JSONResponse ¶
type GetMetricsSummary401JSONResponse APIError
func (GetMetricsSummary401JSONResponse) VisitGetMetricsSummaryResponse ¶
func (response GetMetricsSummary401JSONResponse) VisitGetMetricsSummaryResponse(ctx fiber.Ctx) error
type GetMetricsSummary403JSONResponse ¶
type GetMetricsSummary403JSONResponse APIError
func (GetMetricsSummary403JSONResponse) VisitGetMetricsSummaryResponse ¶
func (response GetMetricsSummary403JSONResponse) VisitGetMetricsSummaryResponse(ctx fiber.Ctx) error
type GetMetricsSummary500JSONResponse ¶
type GetMetricsSummary500JSONResponse APIError
func (GetMetricsSummary500JSONResponse) VisitGetMetricsSummaryResponse ¶
func (response GetMetricsSummary500JSONResponse) 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 GetMetricsSummaryResponse ¶
type GetMetricsSummaryResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FileUsageSummary
JSON400 *APIError
JSON401 *APIError
JSON403 *APIError
JSON500 *APIError
}
func ParseGetMetricsSummaryResponse ¶
func ParseGetMetricsSummaryResponse(rsp *http.Response) (*GetMetricsSummaryResponse, error)
ParseGetMetricsSummaryResponse parses an HTTP response from a GetMetricsSummaryWithResponse call
func (GetMetricsSummaryResponse) Status ¶
func (r GetMetricsSummaryResponse) Status() string
Status returns HTTPResponse.Status
func (GetMetricsSummaryResponse) StatusCode ¶
func (r GetMetricsSummaryResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetTransferBreakdown200JSONResponse ¶
type GetTransferBreakdown200JSONResponse TransferBreakdownResponse
func (GetTransferBreakdown200JSONResponse) VisitGetTransferBreakdownResponse ¶
func (response GetTransferBreakdown200JSONResponse) VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error
type GetTransferBreakdown400JSONResponse ¶
type GetTransferBreakdown400JSONResponse APIError
func (GetTransferBreakdown400JSONResponse) VisitGetTransferBreakdownResponse ¶
func (response GetTransferBreakdown400JSONResponse) VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error
type GetTransferBreakdown401JSONResponse ¶
type GetTransferBreakdown401JSONResponse APIError
func (GetTransferBreakdown401JSONResponse) VisitGetTransferBreakdownResponse ¶
func (response GetTransferBreakdown401JSONResponse) VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error
type GetTransferBreakdown403JSONResponse ¶
type GetTransferBreakdown403JSONResponse APIError
func (GetTransferBreakdown403JSONResponse) VisitGetTransferBreakdownResponse ¶
func (response GetTransferBreakdown403JSONResponse) VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error
type GetTransferBreakdown500JSONResponse ¶
type GetTransferBreakdown500JSONResponse APIError
func (GetTransferBreakdown500JSONResponse) VisitGetTransferBreakdownResponse ¶
func (response GetTransferBreakdown500JSONResponse) VisitGetTransferBreakdownResponse(ctx fiber.Ctx) error
type GetTransferBreakdownParams ¶
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 ¶
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 ¶
type GetTransferBreakdownRequestObject struct {
Params GetTransferBreakdownParams
}
type GetTransferBreakdownResponse ¶
type GetTransferBreakdownResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *TransferBreakdownResponse
JSON400 *APIError
JSON401 *APIError
JSON403 *APIError
JSON500 *APIError
}
func ParseGetTransferBreakdownResponse ¶
func ParseGetTransferBreakdownResponse(rsp *http.Response) (*GetTransferBreakdownResponse, error)
ParseGetTransferBreakdownResponse parses an HTTP response from a GetTransferBreakdownWithResponse call
func (GetTransferBreakdownResponse) Status ¶
func (r GetTransferBreakdownResponse) Status() string
Status returns HTTPResponse.Status
func (GetTransferBreakdownResponse) StatusCode ¶
func (r GetTransferBreakdownResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetTransferSummary200JSONResponse ¶
type GetTransferSummary200JSONResponse TransferAttributionSummary
func (GetTransferSummary200JSONResponse) VisitGetTransferSummaryResponse ¶
func (response GetTransferSummary200JSONResponse) VisitGetTransferSummaryResponse(ctx fiber.Ctx) error
type GetTransferSummary400JSONResponse ¶
type GetTransferSummary400JSONResponse APIError
func (GetTransferSummary400JSONResponse) VisitGetTransferSummaryResponse ¶
func (response GetTransferSummary400JSONResponse) VisitGetTransferSummaryResponse(ctx fiber.Ctx) error
type GetTransferSummary401JSONResponse ¶
type GetTransferSummary401JSONResponse APIError
func (GetTransferSummary401JSONResponse) VisitGetTransferSummaryResponse ¶
func (response GetTransferSummary401JSONResponse) VisitGetTransferSummaryResponse(ctx fiber.Ctx) error
type GetTransferSummary403JSONResponse ¶
type GetTransferSummary403JSONResponse APIError
func (GetTransferSummary403JSONResponse) VisitGetTransferSummaryResponse ¶
func (response GetTransferSummary403JSONResponse) VisitGetTransferSummaryResponse(ctx fiber.Ctx) error
type GetTransferSummary500JSONResponse ¶
type GetTransferSummary500JSONResponse APIError
func (GetTransferSummary500JSONResponse) VisitGetTransferSummaryResponse ¶
func (response GetTransferSummary500JSONResponse) VisitGetTransferSummaryResponse(ctx fiber.Ctx) error
type GetTransferSummaryParams ¶
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 ¶
type GetTransferSummaryRequestObject struct {
Params GetTransferSummaryParams
}
type GetTransferSummaryResponse ¶
type GetTransferSummaryResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *TransferAttributionSummary
JSON400 *APIError
JSON401 *APIError
JSON403 *APIError
JSON500 *APIError
}
func ParseGetTransferSummaryResponse ¶
func ParseGetTransferSummaryResponse(rsp *http.Response) (*GetTransferSummaryResponse, error)
ParseGetTransferSummaryResponse parses an HTTP response from a GetTransferSummaryWithResponse call
func (GetTransferSummaryResponse) Status ¶
func (r GetTransferSummaryResponse) Status() string
Status returns HTTPResponse.Status
func (GetTransferSummaryResponse) StatusCode ¶
func (r GetTransferSummaryResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type ListMetricsFiles200JSONResponse ¶
type ListMetricsFiles200JSONResponse MetricsListResponse
func (ListMetricsFiles200JSONResponse) VisitListMetricsFilesResponse ¶
func (response ListMetricsFiles200JSONResponse) VisitListMetricsFilesResponse(ctx fiber.Ctx) error
type ListMetricsFiles400JSONResponse ¶
type ListMetricsFiles400JSONResponse APIError
func (ListMetricsFiles400JSONResponse) VisitListMetricsFilesResponse ¶
func (response ListMetricsFiles400JSONResponse) VisitListMetricsFilesResponse(ctx fiber.Ctx) error
type ListMetricsFiles401JSONResponse ¶
type ListMetricsFiles401JSONResponse APIError
func (ListMetricsFiles401JSONResponse) VisitListMetricsFilesResponse ¶
func (response ListMetricsFiles401JSONResponse) VisitListMetricsFilesResponse(ctx fiber.Ctx) error
type ListMetricsFiles403JSONResponse ¶
type ListMetricsFiles403JSONResponse APIError
func (ListMetricsFiles403JSONResponse) VisitListMetricsFilesResponse ¶
func (response ListMetricsFiles403JSONResponse) VisitListMetricsFilesResponse(ctx fiber.Ctx) error
type ListMetricsFiles500JSONResponse ¶
type ListMetricsFiles500JSONResponse APIError
func (ListMetricsFiles500JSONResponse) VisitListMetricsFilesResponse ¶
func (response ListMetricsFiles500JSONResponse) 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 ListMetricsFilesResponse ¶
type ListMetricsFilesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *MetricsListResponse
JSON400 *APIError
JSON401 *APIError
JSON403 *APIError
JSON500 *APIError
}
func ParseListMetricsFilesResponse ¶
func ParseListMetricsFilesResponse(rsp *http.Response) (*ListMetricsFilesResponse, error)
ParseListMetricsFilesResponse parses an HTTP response from a ListMetricsFilesWithResponse call
func (ListMetricsFilesResponse) Status ¶
func (r ListMetricsFilesResponse) Status() string
Status returns HTTPResponse.Status
func (ListMetricsFilesResponse) StatusCode ¶
func (r ListMetricsFilesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
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 ProviderTransferDirection ¶
type ProviderTransferDirection string
ProviderTransferDirection defines model for ProviderTransferDirection.
const ( Download ProviderTransferDirection = "download" Upload ProviderTransferDirection = "upload" )
Defines values for ProviderTransferDirection.
type ProviderTransferEvent ¶
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 ¶
type ProviderTransferEventsRequest struct {
Events []ProviderTransferEvent `json:"events"`
}
ProviderTransferEventsRequest defines model for ProviderTransferEventsRequest.
type ProviderTransferReconciliationStatus ¶
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 ReconciliationStatus ¶
type ReconciliationStatus = ProviderTransferReconciliationStatus
ReconciliationStatus defines model for ReconciliationStatus.
type RecordProviderTransferEvents201JSONResponse ¶
type RecordProviderTransferEvents201JSONResponse TransferEventsRecordedResponse
func (RecordProviderTransferEvents201JSONResponse) VisitRecordProviderTransferEventsResponse ¶
func (response RecordProviderTransferEvents201JSONResponse) VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error
type RecordProviderTransferEvents400JSONResponse ¶
type RecordProviderTransferEvents400JSONResponse APIError
func (RecordProviderTransferEvents400JSONResponse) VisitRecordProviderTransferEventsResponse ¶
func (response RecordProviderTransferEvents400JSONResponse) VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error
type RecordProviderTransferEvents401JSONResponse ¶
type RecordProviderTransferEvents401JSONResponse APIError
func (RecordProviderTransferEvents401JSONResponse) VisitRecordProviderTransferEventsResponse ¶
func (response RecordProviderTransferEvents401JSONResponse) VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error
type RecordProviderTransferEvents403JSONResponse ¶
type RecordProviderTransferEvents403JSONResponse APIError
func (RecordProviderTransferEvents403JSONResponse) VisitRecordProviderTransferEventsResponse ¶
func (response RecordProviderTransferEvents403JSONResponse) VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error
type RecordProviderTransferEvents500JSONResponse ¶
type RecordProviderTransferEvents500JSONResponse APIError
func (RecordProviderTransferEvents500JSONResponse) VisitRecordProviderTransferEventsResponse ¶
func (response RecordProviderTransferEvents500JSONResponse) VisitRecordProviderTransferEventsResponse(ctx fiber.Ctx) error
type RecordProviderTransferEventsJSONRequestBody ¶
type RecordProviderTransferEventsJSONRequestBody = ProviderTransferEventsRequest
RecordProviderTransferEventsJSONRequestBody defines body for RecordProviderTransferEvents for application/json ContentType.
type RecordProviderTransferEventsParams ¶
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 ¶
type RecordProviderTransferEventsRequestObject struct {
Params RecordProviderTransferEventsParams
Body *RecordProviderTransferEventsJSONRequestBody
}
type RecordProviderTransferEventsResponse ¶
type RecordProviderTransferEventsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *TransferEventsRecordedResponse
JSON400 *APIError
JSON401 *APIError
JSON403 *APIError
JSON500 *APIError
}
func ParseRecordProviderTransferEventsResponse ¶
func ParseRecordProviderTransferEventsResponse(rsp *http.Response) (*RecordProviderTransferEventsResponse, error)
ParseRecordProviderTransferEventsResponse parses an HTTP response from a RecordProviderTransferEventsWithResponse call
func (RecordProviderTransferEventsResponse) Status ¶
func (r RecordProviderTransferEventsResponse) Status() string
Status returns HTTPResponse.Status
func (RecordProviderTransferEventsResponse) StatusCode ¶
func (r RecordProviderTransferEventsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type ServerInterface ¶
type ServerInterface interface {
// (GET /index/v1/metrics/files)
ListMetricsFiles(c fiber.Ctx, params ListMetricsFilesParams) error
// (POST /index/v1/metrics/files/bulk)
BulkMetricsFiles(c fiber.Ctx, params BulkMetricsFilesParams) 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
// (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) BulkMetricsFiles ¶
func (siw *ServerInterfaceWrapper) BulkMetricsFiles(c fiber.Ctx) error
BulkMetricsFiles operation middleware
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 ¶
func (siw *ServerInterfaceWrapper) GetTransferBreakdown(c fiber.Ctx) error
GetTransferBreakdown operation middleware
func (*ServerInterfaceWrapper) GetTransferSummary ¶
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) RecordProviderTransferEvents ¶
func (siw *ServerInterfaceWrapper) RecordProviderTransferEvents(c fiber.Ctx) error
RecordProviderTransferEvents operation middleware
type StrictHandlerFunc ¶
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)
// (POST /index/v1/metrics/files/bulk)
BulkMetricsFiles(ctx context.Context, request BulkMetricsFilesRequestObject) (BulkMetricsFilesResponseObject, 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)
// (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 TransferAttributionBreakdown ¶
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 ¶
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 ¶
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 ¶
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 ¶
type TransferEventsRecordedResponse struct {
Recorded *int `json:"recorded,omitempty"`
}
TransferEventsRecordedResponse defines model for TransferEventsRecordedResponse.
type TransferMetricsFreshness ¶
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.