webSessions

Documentation

Index

• Constants
• type AddWebSessionCommandInput
• type DeleteWebSessionCommandInput
• type GetWebSessionCommandInput
• type GetWebSessionsCommandInput
• type UpdateWebSessionCommandInput
• type WebSessionsAPI
• type WebSessionsService
  • func New(cfg *config.Config) *WebSessionsService
  • func (s *WebSessionsService) AddWebSessionCommand(input *AddWebSessionCommandInput) (output *models.WebSessionView, resp *http.Response, err error)
  • func (s *WebSessionsService) DeleteWebSessionCommand(input *DeleteWebSessionCommandInput) (resp *http.Response, err error)
  • func (s *WebSessionsService) GetWebSessionCommand(input *GetWebSessionCommandInput) (output *models.WebSessionView, resp *http.Response, err error)
  • func (s *WebSessionsService) GetWebSessionsCommand(input *GetWebSessionsCommandInput) (output *models.WebSessionsView, resp *http.Response, err error)
  • func (s *WebSessionsService) UpdateWebSessionCommand(input *UpdateWebSessionCommandInput) (output *models.WebSessionView, resp *http.Response, err error)

Constants

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

Types

type AddWebSessionCommandInput

type AddWebSessionCommandInput struct {
	Body models.WebSessionView
}

AddWebSessionCommandInput - Inputs for AddWebSessionCommand

type DeleteWebSessionCommandInput

type DeleteWebSessionCommandInput struct {
	Id string
}

DeleteWebSessionCommandInput - Inputs for DeleteWebSessionCommand

type GetWebSessionCommandInput

type GetWebSessionCommandInput struct {
	Id string
}

GetWebSessionCommandInput - Inputs for GetWebSessionCommand

type GetWebSessionsCommandInput

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

GetWebSessionsCommandInput - Inputs for GetWebSessionsCommand

type UpdateWebSessionCommandInput

type UpdateWebSessionCommandInput struct {
	Body models.WebSessionView
	Id   string
}

UpdateWebSessionCommandInput - Inputs for UpdateWebSessionCommand

type WebSessionsAPI

type WebSessionsAPI interface {
	GetWebSessionsCommand(input *GetWebSessionsCommandInput) (output *models.WebSessionsView, resp *http.Response, err error)
	AddWebSessionCommand(input *AddWebSessionCommandInput) (output *models.WebSessionView, resp *http.Response, err error)
	DeleteWebSessionCommand(input *DeleteWebSessionCommandInput) (resp *http.Response, err error)
	GetWebSessionCommand(input *GetWebSessionCommandInput) (output *models.WebSessionView, resp *http.Response, err error)
	UpdateWebSessionCommand(input *UpdateWebSessionCommandInput) (output *models.WebSessionView, resp *http.Response, err error)
}

type WebSessionsService

type WebSessionsService struct {
	*client.Client
}

WebSessionsService provides the API operations for making requests to WebSessions endpoint.

func New

func New(cfg *config.Config) *WebSessionsService

New createa a new instance of the WebSessionsService client.

Example:

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

//Create a WebSessionsService from the configuration
svc := webSessions.New(cfg)

func (*WebSessionsService) AddWebSessionCommand

func (s *WebSessionsService) AddWebSessionCommand(input *AddWebSessionCommandInput) (output *models.WebSessionView, resp *http.Response, err error)

AddWebSessionCommand - Create a WebSession RequestType: POST Input: input *AddWebSessionCommandInput

func (*WebSessionsService) DeleteWebSessionCommand

func (s *WebSessionsService) DeleteWebSessionCommand(input *DeleteWebSessionCommandInput) (resp *http.Response, err error)

DeleteWebSessionCommand - Delete a WebSession RequestType: DELETE Input: input *DeleteWebSessionCommandInput

func (*WebSessionsService) GetWebSessionCommand

func (s *WebSessionsService) GetWebSessionCommand(input *GetWebSessionCommandInput) (output *models.WebSessionView, resp *http.Response, err error)

GetWebSessionCommand - Get a WebSession RequestType: GET Input: input *GetWebSessionCommandInput

func (*WebSessionsService) GetWebSessionsCommand

func (s *WebSessionsService) GetWebSessionsCommand(input *GetWebSessionsCommandInput) (output *models.WebSessionsView, resp *http.Response, err error)

GetWebSessionsCommand - Get all WebSessions RequestType: GET Input: input *GetWebSessionsCommandInput

func (*WebSessionsService) UpdateWebSessionCommand

func (s *WebSessionsService) UpdateWebSessionCommand(input *UpdateWebSessionCommandInput) (output *models.WebSessionView, resp *http.Response, err error)

UpdateWebSessionCommand - Update a WebSession RequestType: PUT Input: input *UpdateWebSessionCommandInput