sync

Documentation

Index

• Variables
• type Action
• type ActionOp
  • func (s *ActionOp) MarshalJSON() ([]byte, error)
  • func (s ActionOp) String() string
  • func (s *ActionOp) UnmarshalJSON(data []byte) error
• type Progress
  • func NewProgress(a *Action, c uint32) *Progress
• type State
• type SyncOpt
  • func WithC1ZPath(path string) SyncOpt
  • func WithConnectorStore(store connectorstore.Writer) SyncOpt
  • func WithProgressHandler(f func(s *Progress)) SyncOpt
  • func WithRunDuration(d time.Duration) SyncOpt
  • func WithSkipFullSync() SyncOpt
  • func WithTmpDir(path string) SyncOpt
  • func WithTransitionHandler(f func(s Action)) SyncOpt
• type Syncer
  • func NewSyncer(ctx context.Context, c types.ConnectorClient, opts ...SyncOpt) (Syncer, error)

Variables

var (
	ErrSyncNotComplete = fmt.Errorf("sync exited without finishing")
)

Types

type Action

type Action struct {
	Op                   ActionOp `json:"operation,omitempty"`
	PageToken            string   `json:"page_token,omitempty"`
	ResourceTypeID       string   `json:"resource_type_id,omitempty"`
	ResourceID           string   `json:"resource_id,omitempty"`
	ParentResourceTypeID string   `json:"parent_resource_type_id,omitempty"`
	ParentResourceID     string   `json:"parent_resource_id,omitempty"`
}

Action stores the current operation, page token, and optional fields for which resource is being worked with.

type ActionOp

type ActionOp uint8

ActionOp represents a sync operation.

const (
	UnknownOp ActionOp = iota
	InitOp
	SyncResourceTypesOp
	SyncResourcesOp
	SyncEntitlementsOp
	ListResourcesForEntitlementsOp
	SyncGrantsOp
	SyncAssetsOp
	SyncGrantExpansionOp
)

func (*ActionOp) MarshalJSON

func (s *ActionOp) MarshalJSON() ([]byte, error)

MarshalJSON marshals the ActionOp into a json string.

func (ActionOp) String

func (s ActionOp) String() string

String() returns the string representation for an ActionOp. This is used for marshalling the op.

func (*ActionOp) UnmarshalJSON

func (s *ActionOp) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals the input byte slice and updates this action op.

type Progress

type Progress struct {
	Action               string
	ResourceTypeID       string
	ResourceID           string
	ParentResourceTypeID string
	ParentResourceID     string
	Count                uint32
}

func NewProgress

func NewProgress(a *Action, c uint32) *Progress

type State

type State interface {
	PushAction(ctx context.Context, action Action)
	FinishAction(ctx context.Context)
	NextPage(ctx context.Context, pageToken string) error
	ResourceTypeID(ctx context.Context) string
	ResourceID(ctx context.Context) string
	EntitlementGraph(ctx context.Context) *expand.EntitlementGraph
	ParentResourceID(ctx context.Context) string
	ParentResourceTypeID(ctx context.Context) string
	PageToken(ctx context.Context) string
	Current() *Action
	Marshal() (string, error)
	Unmarshal(input string) error
	NeedsExpansion() bool
	SetNeedsExpansion()
}

type SyncOpt

type SyncOpt func(s *syncer)

func WithC1ZPath

func WithC1ZPath(path string) SyncOpt

func WithConnectorStore

func WithConnectorStore(store connectorstore.Writer) SyncOpt

func WithProgressHandler

func WithProgressHandler(f func(s *Progress)) SyncOpt

WithProgress sets a `progressHandler` for `NewSyncer` Options.

func WithRunDuration

func WithRunDuration(d time.Duration) SyncOpt

WithRunDuration sets a `time.Duration` for `NewSyncer` Options. `d` represents a duration. The elapsed time between two instants as an int64 nanosecond count.

func WithSkipFullSync

func WithSkipFullSync() SyncOpt

func WithTmpDir

func WithTmpDir(path string) SyncOpt

func WithTransitionHandler

func WithTransitionHandler(f func(s Action)) SyncOpt

WithTransitionHandler sets a `transitionHandler` for `NewSyncer` Options.

type Syncer

type Syncer interface {
	Sync(context.Context) error
	Close(context.Context) error
}

func NewSyncer

func NewSyncer(ctx context.Context, c types.ConnectorClient, opts ...SyncOpt) (Syncer, error)

NewSyncer returns a new syncer object.