objectstore

Documentation

Overview

Package objectstore provides access to Infrahub object and file storage.

Index

• type Client
• type Service
  • func NewService(client Client) *Service
  • func (s *Service) Get(ctx context.Context, identifier string) (string, error)
  • func (s *Service) GetFileByHFID(ctx context.Context, kind string, hfid []string) (string, error)
  • func (s *Service) GetFileByID(ctx context.Context, nodeID string) (string, error)
  • func (s *Service) GetFileByStorageID(ctx context.Context, storageID string) (string, error)
  • func (s *Service) Upload(ctx context.Context, content string) (*UploadResult, error)
• type UnsupportedContentTypeError
  • func (e *UnsupportedContentTypeError) Error() string
• type UploadResult

Types

type Client

type Client interface {
	EndpointSegments([]string, url.Values) *url.URL
	DoResponse(context.Context, string, *url.URL, io.Reader, http.Header, string) (*api.HTTPResponse, error)
}

Client is the minimal REST behavior required by Service.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service manages Infrahub object and file storage.

func NewService

func NewService(client Client) *Service

NewService creates an object-store service backed by client.

func (*Service) Get

func (s *Service) Get(ctx context.Context, identifier string) (string, error)

Get returns object-store content by identifier without MIME restrictions.

func (*Service) GetFileByHFID

func (s *Service) GetFileByHFID(ctx context.Context, kind string, hfid []string) (string, error)

GetFileByHFID returns text file content by kind and human-friendly ID.

func (*Service) GetFileByID

func (s *Service) GetFileByID(ctx context.Context, nodeID string) (string, error)

GetFileByID returns text file content by Infrahub node ID.

func (*Service) GetFileByStorageID

func (s *Service) GetFileByStorageID(ctx context.Context, storageID string) (string, error)

GetFileByStorageID returns text file content by storage identifier.

func (*Service) Upload

func (s *Service) Upload(ctx context.Context, content string) (*UploadResult, error)

Upload stores textual content and returns its identifier and checksum.

type UnsupportedContentTypeError

type UnsupportedContentTypeError struct {
	Identifier  string
	ContentType string
}

UnsupportedContentTypeError reports binary content returned by a text-only file method.

func (*UnsupportedContentTypeError) Error

func (e *UnsupportedContentTypeError) Error() string

type UploadResult

type UploadResult struct {
	Identifier string `json:"identifier"`
	Checksum   string `json:"checksum"`
}

UploadResult identifies content stored by Infrahub.