csm

Documentation

Index

• type CSMConnection
  • func NewCSMFileConnection(filePath string, logger lager.Logger) CSMConnection
• type CSMRequest
  • func GetCSMRequest(args []string) (*CSMRequest, error)
• type CSMResponse
  • func CreateCSMErrorResponse(errorCode int, errorMessage string) CSMResponse
  • func CreateCSMResponse(details interface{}) CSMResponse
• type StatusDiagnostic

Types

type CSMConnection

type CSMConnection interface {
	Write(response CSMResponse) error
	WriteError(err error) error
}

func NewCSMFileConnection

func NewCSMFileConnection(filePath string, logger lager.Logger) CSMConnection

type CSMRequest

type CSMRequest struct {
	WorkspaceID  string
	ConnectionID string
	OutputPath   string
}

func GetCSMRequest

func GetCSMRequest(args []string) (*CSMRequest, error)

This assumes that that the args are passed in a specific order as follows: 1. the filepath of the output file 2. the workspace ID 3. the connection ID if present 4. the details JSON

type CSMResponse

type CSMResponse struct {
	ErrorCode    int                 `json:"error_code,omitempty"`
	ErrorMessage string              `json:"error_message,omitempty"`
	Details      interface{}         `json:"details,omitempty"`
	Status       string              `json:"status"`
	ServiceType  string              `json:"service_type"`
	Diagnostics  []*StatusDiagnostic `json:"diagnostics,omitempty"`
}

func CreateCSMErrorResponse

func CreateCSMErrorResponse(errorCode int, errorMessage string) CSMResponse

func CreateCSMResponse

func CreateCSMResponse(details interface{}) CSMResponse

type StatusDiagnostic

type StatusDiagnostic struct {
	Description string `json:"description"`
	Message     string `json:"message"`
	Name        string `json:"name"`
	Status      string `json:"status"`
}