connector

Documentation

Index

• func Map[T, V any](ts []T, fn func(T) V) []V
• type SnipeIt
  • func New(ctx context.Context, baseUrl string, accessToken string) (*SnipeIt, error)
  • func (d *SnipeIt) Asset(ctx context.Context, asset *v2.AssetRef) (string, io.ReadCloser, error)
  • func (d *SnipeIt) Metadata(ctx context.Context) (*v2.ConnectorMetadata, error)
  • func (d *SnipeIt) ResourceSyncers(ctx context.Context) []connectorbuilder.ResourceSyncer
  • func (d *SnipeIt) Validate(ctx context.Context) (annotations.Annotations, error)

Functions

func Map

func Map[T, V any](ts []T, fn func(T) V) []V

Types

type SnipeIt

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

func New

func New(ctx context.Context, baseUrl string, accessToken string) (*SnipeIt, error)

New returns a new instance of the connector.

func (*SnipeIt) Asset

func (d *SnipeIt) Asset(ctx context.Context, asset *v2.AssetRef) (string, io.ReadCloser, error)

Asset takes an input AssetRef and attempts to fetch it using the connector's authenticated http client It streams a response, always starting with a metadata object, following by chunked payloads for the asset.

func (*SnipeIt) Metadata

func (d *SnipeIt) Metadata(ctx context.Context) (*v2.ConnectorMetadata, error)

Metadata returns metadata about the connector.

func (*SnipeIt) ResourceSyncers

func (d *SnipeIt) ResourceSyncers(ctx context.Context) []connectorbuilder.ResourceSyncer

ResourceSyncers returns a ResourceSyncer for each resource type that should be synced from the upstream service.

func (*SnipeIt) Validate

func (d *SnipeIt) Validate(ctx context.Context) (annotations.Annotations, error)

Validate is called to ensure that the connector is properly configured. It should exercise any API credentials to be sure that they are valid.