connector

Documentation

Index

• type Connector
  • func New(ctx context.Context, baseUrl string, clientId string, clientSecret string) (*Connector, error)
  • func (d *Connector) Asset(ctx context.Context, asset *v2.AssetRef) (string, io.ReadCloser, error)
  • func (d *Connector) Metadata(ctx context.Context) (*v2.ConnectorMetadata, error)
  • func (d *Connector) ResourceSyncers(ctx context.Context) []connectorbuilder.ResourceSyncer
  • func (d *Connector) Validate(ctx context.Context) (annotations.Annotations, error)

Types

type Connector

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

func New

func New(
	ctx context.Context,
	baseUrl string,
	clientId string,
	clientSecret string,
) (*Connector, error)

New returns a new instance of the connector.

func (*Connector) Asset

func (d *Connector) 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 (*Connector) Metadata

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

Metadata returns metadata about the connector.

func (*Connector) ResourceSyncers

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

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

func (*Connector) Validate

func (d *Connector) 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.