config

Documentation

Index

• Constants
• type AddConfigImportWorkflowCommandInput
• type ConfigAPI
• type ConfigImportCommandInput
• type ConfigService
  • func New(cfg *config.Config) *ConfigService
  • func (s *ConfigService) AddConfigExportWorkflowCommand() (output *models.ConfigStatusView, resp *http.Response, err error)
  • func (s *ConfigService) AddConfigImportWorkflowCommand(input *AddConfigImportWorkflowCommandInput) (resp *http.Response, err error)
  • func (s *ConfigService) ConfigExportCommand() (output *models.ExportData, resp *http.Response, err error)
  • func (s *ConfigService) ConfigImportCommand(input *ConfigImportCommandInput) (resp *http.Response, err error)
  • func (s *ConfigService) GetConfigExportWorkflowCommand(input *GetConfigExportWorkflowCommandInput) (output *models.ConfigStatusView, resp *http.Response, err error)
  • func (s *ConfigService) GetConfigExportWorkflowDataCommand(input *GetConfigExportWorkflowDataCommandInput) (output *models.ExportData, resp *http.Response, err error)
  • func (s *ConfigService) GetConfigExportWorkflowsCommand() (output *models.ConfigStatusesView, resp *http.Response, err error)
  • func (s *ConfigService) GetConfigImportWorkflowCommand(input *GetConfigImportWorkflowCommandInput) (output *models.ConfigStatusView, resp *http.Response, err error)
  • func (s *ConfigService) GetConfigImportWorkflowsCommand() (output *models.ConfigStatusesView, resp *http.Response, err error)
• type GetConfigExportWorkflowCommandInput
• type GetConfigExportWorkflowDataCommandInput
• type GetConfigImportWorkflowCommandInput

Constants

const (
	// ServiceName - The name of service.
	ServiceName = "Config"
)

Types

type AddConfigImportWorkflowCommandInput

type AddConfigImportWorkflowCommandInput struct {
	Body models.ExportData
}

AddConfigImportWorkflowCommandInput - Inputs for AddConfigImportWorkflowCommand

type ConfigAPI

type ConfigAPI interface {
	ConfigExportCommand() (output *models.ExportData, resp *http.Response, err error)
	GetConfigExportWorkflowsCommand() (output *models.ConfigStatusesView, resp *http.Response, err error)
	AddConfigExportWorkflowCommand() (output *models.ConfigStatusView, resp *http.Response, err error)
	GetConfigExportWorkflowCommand(input *GetConfigExportWorkflowCommandInput) (output *models.ConfigStatusView, resp *http.Response, err error)
	GetConfigExportWorkflowDataCommand(input *GetConfigExportWorkflowDataCommandInput) (output *models.ExportData, resp *http.Response, err error)
	ConfigImportCommand(input *ConfigImportCommandInput) (resp *http.Response, err error)
	GetConfigImportWorkflowsCommand() (output *models.ConfigStatusesView, resp *http.Response, err error)
	AddConfigImportWorkflowCommand(input *AddConfigImportWorkflowCommandInput) (resp *http.Response, err error)
	GetConfigImportWorkflowCommand(input *GetConfigImportWorkflowCommandInput) (output *models.ConfigStatusView, resp *http.Response, err error)
}

type ConfigImportCommandInput

type ConfigImportCommandInput struct {
	Body string
}

ConfigImportCommandInput - Inputs for ConfigImportCommand

type ConfigService

type ConfigService struct {
	*client.Client
}

ConfigService provides the API operations for making requests to Config endpoint.

func New

func New(cfg *config.Config) *ConfigService

New createa a new instance of the ConfigService client.

Example:

cfg := config.NewConfig().WithUsername("Administrator").WithPassword("2FederateM0re").WithEndpoint(paURL.String())

//Create a ConfigService from the configuration
svc := config.New(cfg)

func (*ConfigService) AddConfigExportWorkflowCommand

func (s *ConfigService) AddConfigExportWorkflowCommand() (output *models.ConfigStatusView, resp *http.Response, err error)

AddConfigExportWorkflowCommand - Start a JSON backup of the entire system for export RequestType: POST Input:

func (*ConfigService) AddConfigImportWorkflowCommand

func (s *ConfigService) AddConfigImportWorkflowCommand(input *AddConfigImportWorkflowCommandInput) (resp *http.Response, err error)

AddConfigImportWorkflowCommand - Start an Import of a JSON backup RequestType: POST Input: input *AddConfigImportWorkflowCommandInput

func (*ConfigService) ConfigExportCommand

func (s *ConfigService) ConfigExportCommand() (output *models.ExportData, resp *http.Response, err error)

ConfigExportCommand - [Attention: The endpoint "/config/export" is deprecated. The "config/export/workflows" endpoint should be used instead.] Export a JSON backup of the entire system RequestType: GET Input:

func (*ConfigService) ConfigImportCommand

func (s *ConfigService) ConfigImportCommand(input *ConfigImportCommandInput) (resp *http.Response, err error)

ConfigImportCommand - [Attention: The endpoint "/config/import" is deprecated. The "config/import/workflows" endpoint should be used instead.] Import JSON backup. RequestType: POST Input: input *ConfigImportCommandInput

func (*ConfigService) GetConfigExportWorkflowCommand

func (s *ConfigService) GetConfigExportWorkflowCommand(input *GetConfigExportWorkflowCommandInput) (output *models.ConfigStatusView, resp *http.Response, err error)

GetConfigExportWorkflowCommand - Check the status of an Export RequestType: GET Input: input *GetConfigExportWorkflowCommandInput

func (*ConfigService) GetConfigExportWorkflowDataCommand

func (s *ConfigService) GetConfigExportWorkflowDataCommand(input *GetConfigExportWorkflowDataCommandInput) (output *models.ExportData, resp *http.Response, err error)

GetConfigExportWorkflowDataCommand - Export a JSON backup of the entire system RequestType: GET Input: input *GetConfigExportWorkflowDataCommandInput

func (*ConfigService) GetConfigExportWorkflowsCommand

func (s *ConfigService) GetConfigExportWorkflowsCommand() (output *models.ConfigStatusesView, resp *http.Response, err error)

GetConfigExportWorkflowsCommand - Get the status of pending Exports RequestType: GET Input:

func (*ConfigService) GetConfigImportWorkflowCommand

func (s *ConfigService) GetConfigImportWorkflowCommand(input *GetConfigImportWorkflowCommandInput) (output *models.ConfigStatusView, resp *http.Response, err error)

GetConfigImportWorkflowCommand - Check the status of an Export RequestType: GET Input: input *GetConfigImportWorkflowCommandInput

func (*ConfigService) GetConfigImportWorkflowsCommand

func (s *ConfigService) GetConfigImportWorkflowsCommand() (output *models.ConfigStatusesView, resp *http.Response, err error)

GetConfigImportWorkflowsCommand - Get the status of pending imports RequestType: GET Input:

type GetConfigExportWorkflowCommandInput

type GetConfigExportWorkflowCommandInput struct {
	Id string
}

GetConfigExportWorkflowCommandInput - Inputs for GetConfigExportWorkflowCommand

type GetConfigExportWorkflowDataCommandInput

type GetConfigExportWorkflowDataCommandInput struct {
	Id string
}

GetConfigExportWorkflowDataCommandInput - Inputs for GetConfigExportWorkflowDataCommand

type GetConfigImportWorkflowCommandInput

type GetConfigImportWorkflowCommandInput struct {
	Id string
}

GetConfigImportWorkflowCommandInput - Inputs for GetConfigImportWorkflowCommand