connector

Documentation

Index

• type Segment
  • func New(ctx context.Context, token string) (*Segment, error)
  • func (s *Segment) Metadata(ctx context.Context) (*v2.ConnectorMetadata, error)
  • func (s *Segment) ResourceSyncers(ctx context.Context) []connectorbuilder.ResourceSyncer
  • func (s *Segment) Validate(ctx context.Context) (annotations.Annotations, error)

Types

type Segment

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

func New

func New(ctx context.Context, token string) (*Segment, error)

New returns a new instance of the connector.

func (*Segment) Metadata

func (s *Segment) Metadata(ctx context.Context) (*v2.ConnectorMetadata, error)

Metadata returns metadata about the connector.

func (*Segment) ResourceSyncers

func (s *Segment) ResourceSyncers(ctx context.Context) []connectorbuilder.ResourceSyncer

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

func (*Segment) Validate

func (s *Segment) 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.