Documentation
¶
Index ¶
- Variables
- type Client
- func (c *Client) Checker(ctx context.Context, check *health.CheckState) error
- func (c *Client) GetFile(ctx context.Context, path string, authToken string) (FileMetaData, error)
- func (c *Client) MarkFileDecrypted(ctx context.Context, path string, etag string) error
- func (c *Client) MarkFileMoved(ctx context.Context, path string, etag string) error
- func (c *Client) MarkFilePublished(ctx context.Context, path string, etag string) error
- func (c *Client) MarkFileUploaded(ctx context.Context, path string, etag string) error
- func (c *Client) PatchFile(ctx context.Context, path string, patch FilePatch) error
- func (c *Client) PublishCollection(ctx context.Context, collectionID string) error
- func (c *Client) RegisterFile(ctx context.Context, metadata FileMetaData) error
- func (c *Client) SetCollectionID(ctx context.Context, filepath, collectionID string) error
- type FileMetaData
- type FilePatch
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrFileNotFound = errors.New("file not found on dp-files-api") ErrFileAlreadyInCollection = errors.New("file collection ID already set") ErrNoFilesInCollection = errors.New("no file in the collection") ErrInvalidState = errors.New("file is in an invalid state for this action") ErrNotPublishable = errors.New("file is not set as publishable") ErrNotAuthorized = errors.New("you are not authorized for this action") ErrServer = errors.New("internal server error") ErrUnexpectedStatus = errors.New("unexpected response status code") ErrBadRequest = errors.New("bad request") ErrConflict = errors.New("resource conflict") ErrFileAlreadyRegistered = fmt.Errorf("%w: file already registered", ErrConflict) ErrValidationError = fmt.Errorf("%w: validation error", ErrBadRequest) ErrUnknown = fmt.Errorf("%w: unknown error", ErrBadRequest) )
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
Version string
// contains filtered or unexported fields
}
Client is an files API client which can be used to make requests to the server. It extends the generic healthcheck Client structure.
func NewAPIClient ¶
NewAPIClient creates a new instance of files Client with a given image API URL
func NewWithHealthClient ¶ added in v2.132.0
func NewWithHealthClient(hcCli *healthcheck.Client) *Client
NewWithHealthClient creates a new instances of files Client using healthcheck client
func (*Client) Checker ¶
Checker calls image api health endpoint and returns a check object to the caller.
func (*Client) MarkFileDecrypted ¶ added in v2.162.0
func (*Client) MarkFileMoved ¶ added in v2.206.3
func (*Client) MarkFilePublished ¶ added in v2.162.0
func (*Client) MarkFileUploaded ¶ added in v2.162.0
func (*Client) PublishCollection ¶
func (*Client) RegisterFile ¶ added in v2.162.0
func (c *Client) RegisterFile(ctx context.Context, metadata FileMetaData) error
type FileMetaData ¶ added in v2.127.0
type FileMetaData struct {
Path string `json:"path"`
IsPublishable bool `json:"is_publishable"`
CollectionID *string `json:"collection_id,omitempty"`
BundleID *string `json:"bundle_id,omitempty"`
Title string `json:"title"`
SizeInBytes uint64 `json:"size_in_bytes"`
Type string `json:"type"`
Licence string `json:"licence"`
LicenceUrl string `json:"licence_url"`
State string `json:"state,omitempty"`
Etag string `json:"etag,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.