adminConfig

Documentation

Index

• Constants
• type AddReplicaAdminCommandInput
• type AdminConfigAPI
• type AdminConfigService
  • func New(cfg *config.Config) *AdminConfigService
  • func (s *AdminConfigService) AddReplicaAdminCommand(input *AddReplicaAdminCommandInput) (output *models.ReplicaAdminView, resp *http.Response, err error)
  • func (s *AdminConfigService) DeleteAdminConfigurationCommand() (resp *http.Response, err error)
  • func (s *AdminConfigService) DeleteReplicaAdminCommand(input *DeleteReplicaAdminCommandInput) (resp *http.Response, err error)
  • func (s *AdminConfigService) GetAdminConfigurationCommand() (output *models.AdminConfigurationView, resp *http.Response, err error)
  • func (s *AdminConfigService) GetAdminReplicaFileCommand(input *GetAdminReplicaFileCommandInput) (resp *http.Response, err error)
  • func (s *AdminConfigService) GetReplicaAdminCommand(input *GetReplicaAdminCommandInput) (output *models.ReplicaAdminView, resp *http.Response, err error)
  • func (s *AdminConfigService) GetReplicaAdminsCommand() (output *models.ReplicaAdminsView, resp *http.Response, err error)
  • func (s *AdminConfigService) UpdateAdminConfigurationCommand(input *UpdateAdminConfigurationCommandInput) (output *models.AdminConfigurationView, resp *http.Response, err error)
  • func (s *AdminConfigService) UpdateAdminReplicaCommand(input *UpdateAdminReplicaCommandInput) (output *models.ReplicaAdminView, resp *http.Response, err error)
• type DeleteReplicaAdminCommandInput
• type GetAdminReplicaFileCommandInput
• type GetReplicaAdminCommandInput
• type UpdateAdminConfigurationCommandInput
• type UpdateAdminReplicaCommandInput

Constants

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

Types

type AddReplicaAdminCommandInput

type AddReplicaAdminCommandInput struct {
	Body models.ReplicaAdminView
}

AddReplicaAdminCommandInput - Inputs for AddReplicaAdminCommand

type AdminConfigAPI

type AdminConfigAPI interface {
	DeleteAdminConfigurationCommand() (resp *http.Response, err error)
	GetAdminConfigurationCommand() (output *models.AdminConfigurationView, resp *http.Response, err error)
	UpdateAdminConfigurationCommand(input *UpdateAdminConfigurationCommandInput) (output *models.AdminConfigurationView, resp *http.Response, err error)
	GetReplicaAdminsCommand() (output *models.ReplicaAdminsView, resp *http.Response, err error)
	AddReplicaAdminCommand(input *AddReplicaAdminCommandInput) (output *models.ReplicaAdminView, resp *http.Response, err error)
	DeleteReplicaAdminCommand(input *DeleteReplicaAdminCommandInput) (resp *http.Response, err error)
	GetReplicaAdminCommand(input *GetReplicaAdminCommandInput) (output *models.ReplicaAdminView, resp *http.Response, err error)
	UpdateAdminReplicaCommand(input *UpdateAdminReplicaCommandInput) (output *models.ReplicaAdminView, resp *http.Response, err error)
	GetAdminReplicaFileCommand(input *GetAdminReplicaFileCommandInput) (resp *http.Response, err error)
}

type AdminConfigService

type AdminConfigService struct {
	*client.Client
}

AdminConfigService provides the API operations for making requests to AdminConfig endpoint.

func New

func New(cfg *config.Config) *AdminConfigService

New createa a new instance of the AdminConfigService client.

Example:

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

//Create a AdminConfigService from the configuration
svc := adminConfig.New(cfg)

func (*AdminConfigService) AddReplicaAdminCommand

func (s *AdminConfigService) AddReplicaAdminCommand(input *AddReplicaAdminCommandInput) (output *models.ReplicaAdminView, resp *http.Response, err error)

AddReplicaAdminCommand - Add a ReplicaAdmin RequestType: POST Input: input *AddReplicaAdminCommandInput

func (*AdminConfigService) DeleteAdminConfigurationCommand

func (s *AdminConfigService) DeleteAdminConfigurationCommand() (resp *http.Response, err error)

DeleteAdminConfigurationCommand - Resets the Admin Config to default values RequestType: DELETE Input:

func (*AdminConfigService) DeleteReplicaAdminCommand

func (s *AdminConfigService) DeleteReplicaAdminCommand(input *DeleteReplicaAdminCommandInput) (resp *http.Response, err error)

DeleteReplicaAdminCommand - Delete a ReplicaAdmin RequestType: DELETE Input: input *DeleteReplicaAdminCommandInput

func (*AdminConfigService) GetAdminConfigurationCommand

func (s *AdminConfigService) GetAdminConfigurationCommand() (output *models.AdminConfigurationView, resp *http.Response, err error)

GetAdminConfigurationCommand - Get the Admin Config RequestType: GET Input:

func (*AdminConfigService) GetAdminReplicaFileCommand

func (s *AdminConfigService) GetAdminReplicaFileCommand(input *GetAdminReplicaFileCommandInput) (resp *http.Response, err error)

GetAdminReplicaFileCommand - Get configuration file for a given ReplicaAdmin RequestType: POST Input: input *GetAdminReplicaFileCommandInput

func (*AdminConfigService) GetReplicaAdminCommand

func (s *AdminConfigService) GetReplicaAdminCommand(input *GetReplicaAdminCommandInput) (output *models.ReplicaAdminView, resp *http.Response, err error)

GetReplicaAdminCommand - Get a ReplicaAdmin RequestType: GET Input: input *GetReplicaAdminCommandInput

func (*AdminConfigService) GetReplicaAdminsCommand

func (s *AdminConfigService) GetReplicaAdminsCommand() (output *models.ReplicaAdminsView, resp *http.Response, err error)

GetReplicaAdminsCommand - Get list of ReplicaAdmins RequestType: GET Input:

func (*AdminConfigService) UpdateAdminConfigurationCommand

func (s *AdminConfigService) UpdateAdminConfigurationCommand(input *UpdateAdminConfigurationCommandInput) (output *models.AdminConfigurationView, resp *http.Response, err error)

UpdateAdminConfigurationCommand - Update the Admin Config RequestType: PUT Input: input *UpdateAdminConfigurationCommandInput

func (*AdminConfigService) UpdateAdminReplicaCommand

func (s *AdminConfigService) UpdateAdminReplicaCommand(input *UpdateAdminReplicaCommandInput) (output *models.ReplicaAdminView, resp *http.Response, err error)

UpdateAdminReplicaCommand - Update a ReplicaAdmin RequestType: PUT Input: input *UpdateAdminReplicaCommandInput

type DeleteReplicaAdminCommandInput

type DeleteReplicaAdminCommandInput struct {
	Id string
}

DeleteReplicaAdminCommandInput - Inputs for DeleteReplicaAdminCommand

type GetAdminReplicaFileCommandInput

type GetAdminReplicaFileCommandInput struct {
	Id string
}

GetAdminReplicaFileCommandInput - Inputs for GetAdminReplicaFileCommand

type GetReplicaAdminCommandInput

type GetReplicaAdminCommandInput struct {
	Id string
}

GetReplicaAdminCommandInput - Inputs for GetReplicaAdminCommand

type UpdateAdminConfigurationCommandInput

type UpdateAdminConfigurationCommandInput struct {
	Body models.AdminConfigurationView
}

UpdateAdminConfigurationCommandInput - Inputs for UpdateAdminConfigurationCommand

type UpdateAdminReplicaCommandInput

type UpdateAdminReplicaCommandInput struct {
	Body models.ReplicaAdminView
	Id   string
}

UpdateAdminReplicaCommandInput - Inputs for UpdateAdminReplicaCommand