report

Documentation

Index

• type Result
• type Summary
  • func NewSummary(w io.Writer) *Summary
  • func (s *Summary) AddFailedService(org, space, serviceName, serviceType string, err error)
  • func (s *Summary) AddSkippedService(org, space, serviceName, serviceType string, err error)
  • func (s *Summary) AddSuccessfulService(org, space, serviceName, serviceType string)
  • func (s *Summary) Display()
  • func (s *Summary) Results() []Result
  • func (s *Summary) ServiceFailureCount() int
  • func (s *Summary) ServiceSkippedCount() int
  • func (s *Summary) ServiceSuccessCount() int

Types

type Result

type Result struct {
	OrgName     string
	SpaceName   string
	ServiceName string
	Service     string
	Message     string
}

Result is a specific service migration result: success or failure

type Summary

type Summary struct {
	TableWriter io.Writer
	// contains filtered or unexported fields
}

Summary is a thread safe sink of execution results for service migrations

func NewSummary

func NewSummary(w io.Writer) *Summary

NewSummary creates a new initialized summary instance

func (*Summary) AddFailedService

func (s *Summary) AddFailedService(org, space, serviceName, serviceType string, err error)

AddFailedService adds a failed service along with its error to the summary result

func (*Summary) AddSkippedService

func (s *Summary) AddSkippedService(org, space, serviceName, serviceType string, err error)

AddSkippedService adds a skipped service along with its error to the summary result

func (*Summary) AddSuccessfulService

func (s *Summary) AddSuccessfulService(org, space, serviceName, serviceType string)

AddSuccessfulService adds a successful service and increments the count of successful services

func (*Summary) Display

func (s *Summary) Display()

func (*Summary) Results

func (s *Summary) Results() []Result

Results returns a copy of all the service migrations that have occurred

func (*Summary) ServiceFailureCount

func (s *Summary) ServiceFailureCount() int

ServiceFailureCount is the number of total service failures that have occurred

func (*Summary) ServiceSkippedCount

func (s *Summary) ServiceSkippedCount() int

ServiceSkippedCount is the number of total service skipped that have occurred

func (*Summary) ServiceSuccessCount

func (s *Summary) ServiceSuccessCount() int

ServiceSuccessCount is the number of total service successes that have occurred