engineListeners

Documentation

Index

• Constants
• type AddEngineListenerCommandInput
• type DeleteEngineListenerCommandInput
• type EngineListenersAPI
• type EngineListenersService
  • func New(cfg *config.Config) *EngineListenersService
  • func (s *EngineListenersService) AddEngineListenerCommand(input *AddEngineListenerCommandInput) (output *models.EngineListenerView, resp *http.Response, err error)
  • func (s *EngineListenersService) DeleteEngineListenerCommand(input *DeleteEngineListenerCommandInput) (resp *http.Response, err error)
  • func (s *EngineListenersService) GetEngineListenerCommand(input *GetEngineListenerCommandInput) (output *models.EngineListenerView, resp *http.Response, err error)
  • func (s *EngineListenersService) GetEngineListenersCommand(input *GetEngineListenersCommandInput) (output *models.EngineListenersView, resp *http.Response, err error)
  • func (s *EngineListenersService) UpdateEngineListenerCommand(input *UpdateEngineListenerCommandInput) (output *models.EngineListenerView, resp *http.Response, err error)
• type GetEngineListenerCommandInput
• type GetEngineListenersCommandInput
• type UpdateEngineListenerCommandInput

Constants

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

Types

type AddEngineListenerCommandInput

type AddEngineListenerCommandInput struct {
	Body models.EngineListenerView
}

AddEngineListenerCommandInput - Inputs for AddEngineListenerCommand

type DeleteEngineListenerCommandInput

type DeleteEngineListenerCommandInput struct {
	Id string
}

DeleteEngineListenerCommandInput - Inputs for DeleteEngineListenerCommand

type EngineListenersAPI

type EngineListenersAPI interface {
	GetEngineListenersCommand(input *GetEngineListenersCommandInput) (output *models.EngineListenersView, resp *http.Response, err error)
	AddEngineListenerCommand(input *AddEngineListenerCommandInput) (output *models.EngineListenerView, resp *http.Response, err error)
	DeleteEngineListenerCommand(input *DeleteEngineListenerCommandInput) (resp *http.Response, err error)
	GetEngineListenerCommand(input *GetEngineListenerCommandInput) (output *models.EngineListenerView, resp *http.Response, err error)
	UpdateEngineListenerCommand(input *UpdateEngineListenerCommandInput) (output *models.EngineListenerView, resp *http.Response, err error)
}

type EngineListenersService

type EngineListenersService struct {
	*client.Client
}

EngineListenersService provides the API operations for making requests to EngineListeners endpoint.

func New

func New(cfg *config.Config) *EngineListenersService

New createa a new instance of the EngineListenersService client.

Example:

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

//Create a EngineListenersService from the configuration
svc := engineListeners.New(cfg)

func (*EngineListenersService) AddEngineListenerCommand

func (s *EngineListenersService) AddEngineListenerCommand(input *AddEngineListenerCommandInput) (output *models.EngineListenerView, resp *http.Response, err error)

AddEngineListenerCommand - Create an Engine Listener RequestType: POST Input: input *AddEngineListenerCommandInput

func (*EngineListenersService) DeleteEngineListenerCommand

func (s *EngineListenersService) DeleteEngineListenerCommand(input *DeleteEngineListenerCommandInput) (resp *http.Response, err error)

DeleteEngineListenerCommand - Delete an Engine Listener RequestType: DELETE Input: input *DeleteEngineListenerCommandInput

func (*EngineListenersService) GetEngineListenerCommand

func (s *EngineListenersService) GetEngineListenerCommand(input *GetEngineListenerCommandInput) (output *models.EngineListenerView, resp *http.Response, err error)

GetEngineListenerCommand - Get an Engine Listener RequestType: GET Input: input *GetEngineListenerCommandInput

func (*EngineListenersService) GetEngineListenersCommand

func (s *EngineListenersService) GetEngineListenersCommand(input *GetEngineListenersCommandInput) (output *models.EngineListenersView, resp *http.Response, err error)

GetEngineListenersCommand - Get all Engine Listeners RequestType: GET Input: input *GetEngineListenersCommandInput

func (*EngineListenersService) UpdateEngineListenerCommand

func (s *EngineListenersService) UpdateEngineListenerCommand(input *UpdateEngineListenerCommandInput) (output *models.EngineListenerView, resp *http.Response, err error)

UpdateEngineListenerCommand - Update an Engine Listener RequestType: PUT Input: input *UpdateEngineListenerCommandInput

type GetEngineListenerCommandInput

type GetEngineListenerCommandInput struct {
	Id string
}

GetEngineListenerCommandInput - Inputs for GetEngineListenerCommand

type GetEngineListenersCommandInput

type GetEngineListenersCommandInput struct {
	Page          string
	NumberPerPage string
	Filter        string
	Name          string
	SortKey       string
	Order         string
}

GetEngineListenersCommandInput - Inputs for GetEngineListenersCommand

type UpdateEngineListenerCommandInput

type UpdateEngineListenerCommandInput struct {
	Body models.EngineListenerView
	Id   string
}

UpdateEngineListenerCommandInput - Inputs for UpdateEngineListenerCommand