common

Documentation

Index

• func NewCleanupWorker(w worker.Worker, cleanup func()) worker.Worker
• func NewCloudCallContext(c CredentialAPI, dying context.Dying) context.ProviderCallContext
• type CleanupWorker
  • func (w *CleanupWorker) Report() map[string]interface{}
  • func (w *CleanupWorker) Wait() error
• type CredentialAPI
  • func NewCredentialInvalidatorFacade(apiCaller base.APICaller) (CredentialAPI, error)

Functions

func NewCleanupWorker

func NewCleanupWorker(w worker.Worker, cleanup func()) worker.Worker

NewCleanupWorker returns a worker that ensures a cleanup function is run after the underlying worker is finished.

func NewCloudCallContext

func NewCloudCallContext(c CredentialAPI, dying context.Dying) context.ProviderCallContext

NewCloudCallContext creates a cloud call context to be used by workers.

Types

type CleanupWorker

type CleanupWorker struct {
	worker.Worker
	// contains filtered or unexported fields
}

CleanupWorker wraps another worker to ensure a func is run when it is finished. (Public for manifolds that need access to the wrapped worker for output.)

func (*CleanupWorker) Report

func (w *CleanupWorker) Report() map[string]interface{}

Report implements dependency.Reporter.

func (*CleanupWorker) Wait

func (w *CleanupWorker) Wait() error

Wait ensures the cleanup func is run after the worker finishes.

type CredentialAPI

type CredentialAPI interface {
	InvalidateModelCredential(reason string) error
}

CredentialAPI exposes functionality of the credential validator API facade to a worker.

func NewCredentialInvalidatorFacade

func NewCredentialInvalidatorFacade(apiCaller base.APICaller) (CredentialAPI, error)

NewCredentialInvalidatorFacade creates an API facade capable of invalidating credential.