spAdapters

package
v0.0.0-...-367d749 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 28, 2021 License: MIT Imports: 9 Imported by: 1

Documentation

Index

Constants

View Source
const (
	// ServiceName - The name of service.
	ServiceName = "SpAdapters"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateSpAdapterInput

type CreateSpAdapterInput struct {
	Body models.SpAdapter
}

type DeleteSpAdapterInput

type DeleteSpAdapterInput struct {
	Id string
}

type GetActionInput

type GetActionInput struct {
	Id       string
	ActionId string
}

type GetActionsInput

type GetActionsInput struct {
	Id string
}

type GetSpAdapterDescriptorsByIdInput

type GetSpAdapterDescriptorsByIdInput struct {
	Id string
}

type GetSpAdapterInput

type GetSpAdapterInput struct {
	Id string
}

type GetSpAdaptersInput

type GetSpAdaptersInput struct {
	Page          string
	NumberPerPage string
	Filter        string
}

type InvokeActionInput

type InvokeActionInput struct {
	Id       string
	ActionId string
}

type SpAdaptersAPI

type SpAdaptersAPI interface {
	GetSpAdapterDescriptors() (output *models.SpAdapterDescriptors, resp *http.Response, err error)
	GetSpAdapterDescriptorsWithContext(ctx context.Context) (output *models.SpAdapterDescriptors, resp *http.Response, err error)

	GetSpAdapterDescriptorsById(input *GetSpAdapterDescriptorsByIdInput) (output *models.SpAdapterDescriptor, resp *http.Response, err error)
	GetSpAdapterDescriptorsByIdWithContext(ctx context.Context, input *GetSpAdapterDescriptorsByIdInput) (output *models.SpAdapterDescriptor, resp *http.Response, err error)

	GetSpAdapters(input *GetSpAdaptersInput) (output *models.SpAdapters, resp *http.Response, err error)
	GetSpAdaptersWithContext(ctx context.Context, input *GetSpAdaptersInput) (output *models.SpAdapters, resp *http.Response, err error)

	CreateSpAdapter(input *CreateSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)
	CreateSpAdapterWithContext(ctx context.Context, input *CreateSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)

	GetSpAdapter(input *GetSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)
	GetSpAdapterWithContext(ctx context.Context, input *GetSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)

	UpdateSpAdapter(input *UpdateSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)
	UpdateSpAdapterWithContext(ctx context.Context, input *UpdateSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)

	DeleteSpAdapter(input *DeleteSpAdapterInput) (output *models.ApiResult, resp *http.Response, err error)
	DeleteSpAdapterWithContext(ctx context.Context, input *DeleteSpAdapterInput) (output *models.ApiResult, resp *http.Response, err error)

	GetActions(input *GetActionsInput) (output *models.Actions, resp *http.Response, err error)
	GetActionsWithContext(ctx context.Context, input *GetActionsInput) (output *models.Actions, resp *http.Response, err error)

	GetAction(input *GetActionInput) (output *models.Action, resp *http.Response, err error)
	GetActionWithContext(ctx context.Context, input *GetActionInput) (output *models.Action, resp *http.Response, err error)

	InvokeAction(input *InvokeActionInput) (output *models.ActionResult, resp *http.Response, err error)
	InvokeActionWithContext(ctx context.Context, input *InvokeActionInput) (output *models.ActionResult, resp *http.Response, err error)

	GetUrlMappings() (output *models.SpAdapterUrlMappings, resp *http.Response, err error)
	GetUrlMappingsWithContext(ctx context.Context) (output *models.SpAdapterUrlMappings, resp *http.Response, err error)

	UpdateUrlMappings(input *UpdateUrlMappingsInput) (output *models.SpAdapterUrlMappings, resp *http.Response, err error)
	UpdateUrlMappingsWithContext(ctx context.Context, input *UpdateUrlMappingsInput) (output *models.SpAdapterUrlMappings, resp *http.Response, err error)
}

type SpAdaptersService

type SpAdaptersService struct {
	*client.PfClient
}

func New

func New(cfg *config.Config) *SpAdaptersService

New creates a new instance of the SpAdaptersService client.

func (*SpAdaptersService) CreateSpAdapter

func (s *SpAdaptersService) CreateSpAdapter(input *CreateSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)

CreateSpAdapter - Create a new SP adapter instance. RequestType: POST Input: input *CreateSpAdapterInput

func (*SpAdaptersService) CreateSpAdapterWithContext

func (s *SpAdaptersService) CreateSpAdapterWithContext(ctx context.Context, input *CreateSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)

CreateSpAdapterWithContext - Create a new SP adapter instance. RequestType: POST Input: ctx context.Context, input *CreateSpAdapterInput

func (*SpAdaptersService) DeleteSpAdapter

func (s *SpAdaptersService) DeleteSpAdapter(input *DeleteSpAdapterInput) (output *models.ApiResult, resp *http.Response, err error)

DeleteSpAdapter - Delete an SP adapter instance. RequestType: DELETE Input: input *DeleteSpAdapterInput

func (*SpAdaptersService) DeleteSpAdapterWithContext

func (s *SpAdaptersService) DeleteSpAdapterWithContext(ctx context.Context, input *DeleteSpAdapterInput) (output *models.ApiResult, resp *http.Response, err error)

DeleteSpAdapterWithContext - Delete an SP adapter instance. RequestType: DELETE Input: ctx context.Context, input *DeleteSpAdapterInput

func (*SpAdaptersService) GetAction

func (s *SpAdaptersService) GetAction(input *GetActionInput) (output *models.Action, resp *http.Response, err error)

GetAction - Find an SP adapter instance's action by ID. RequestType: GET Input: input *GetActionInput

func (*SpAdaptersService) GetActionWithContext

func (s *SpAdaptersService) GetActionWithContext(ctx context.Context, input *GetActionInput) (output *models.Action, resp *http.Response, err error)

GetActionWithContext - Find an SP adapter instance's action by ID. RequestType: GET Input: ctx context.Context, input *GetActionInput

func (*SpAdaptersService) GetActions

func (s *SpAdaptersService) GetActions(input *GetActionsInput) (output *models.Actions, resp *http.Response, err error)

GetActions - List the actions for an SP adapter instance. RequestType: GET Input: input *GetActionsInput

func (*SpAdaptersService) GetActionsWithContext

func (s *SpAdaptersService) GetActionsWithContext(ctx context.Context, input *GetActionsInput) (output *models.Actions, resp *http.Response, err error)

GetActionsWithContext - List the actions for an SP adapter instance. RequestType: GET Input: ctx context.Context, input *GetActionsInput

func (*SpAdaptersService) GetSpAdapter

func (s *SpAdaptersService) GetSpAdapter(input *GetSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)

GetSpAdapter - Find an SP adapter instance by ID. RequestType: GET Input: input *GetSpAdapterInput

func (*SpAdaptersService) GetSpAdapterDescriptors

func (s *SpAdaptersService) GetSpAdapterDescriptors() (output *models.SpAdapterDescriptors, resp *http.Response, err error)

GetSpAdapterDescriptors - Get the list of available SP adapter descriptors. RequestType: GET Input:

func (*SpAdaptersService) GetSpAdapterDescriptorsById

func (s *SpAdaptersService) GetSpAdapterDescriptorsById(input *GetSpAdapterDescriptorsByIdInput) (output *models.SpAdapterDescriptor, resp *http.Response, err error)

GetSpAdapterDescriptorsById - Get the description of an SP adapter plugin by ID. RequestType: GET Input: input *GetSpAdapterDescriptorsByIdInput

func (*SpAdaptersService) GetSpAdapterDescriptorsByIdWithContext

func (s *SpAdaptersService) GetSpAdapterDescriptorsByIdWithContext(ctx context.Context, input *GetSpAdapterDescriptorsByIdInput) (output *models.SpAdapterDescriptor, resp *http.Response, err error)

GetSpAdapterDescriptorsByIdWithContext - Get the description of an SP adapter plugin by ID. RequestType: GET Input: ctx context.Context, input *GetSpAdapterDescriptorsByIdInput

func (*SpAdaptersService) GetSpAdapterDescriptorsWithContext

func (s *SpAdaptersService) GetSpAdapterDescriptorsWithContext(ctx context.Context) (output *models.SpAdapterDescriptors, resp *http.Response, err error)

GetSpAdapterDescriptorsWithContext - Get the list of available SP adapter descriptors. RequestType: GET Input: ctx context.Context,

func (*SpAdaptersService) GetSpAdapterWithContext

func (s *SpAdaptersService) GetSpAdapterWithContext(ctx context.Context, input *GetSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)

GetSpAdapterWithContext - Find an SP adapter instance by ID. RequestType: GET Input: ctx context.Context, input *GetSpAdapterInput

func (*SpAdaptersService) GetSpAdapters

func (s *SpAdaptersService) GetSpAdapters(input *GetSpAdaptersInput) (output *models.SpAdapters, resp *http.Response, err error)

GetSpAdapters - Get the list of configured SP adapter instances. RequestType: GET Input: input *GetSpAdaptersInput

func (*SpAdaptersService) GetSpAdaptersWithContext

func (s *SpAdaptersService) GetSpAdaptersWithContext(ctx context.Context, input *GetSpAdaptersInput) (output *models.SpAdapters, resp *http.Response, err error)

GetSpAdaptersWithContext - Get the list of configured SP adapter instances. RequestType: GET Input: ctx context.Context, input *GetSpAdaptersInput

func (*SpAdaptersService) GetUrlMappings

func (s *SpAdaptersService) GetUrlMappings() (output *models.SpAdapterUrlMappings, resp *http.Response, err error)

GetUrlMappings - (Deprecated) List the mappings between URLs and adapter instances. RequestType: GET Input:

func (*SpAdaptersService) GetUrlMappingsWithContext

func (s *SpAdaptersService) GetUrlMappingsWithContext(ctx context.Context) (output *models.SpAdapterUrlMappings, resp *http.Response, err error)

GetUrlMappingsWithContext - (Deprecated) List the mappings between URLs and adapter instances. RequestType: GET Input: ctx context.Context,

func (*SpAdaptersService) InvokeAction

func (s *SpAdaptersService) InvokeAction(input *InvokeActionInput) (output *models.ActionResult, resp *http.Response, err error)

InvokeAction - Invokes an action for an SP adapter instance. RequestType: POST Input: input *InvokeActionInput

func (*SpAdaptersService) InvokeActionWithContext

func (s *SpAdaptersService) InvokeActionWithContext(ctx context.Context, input *InvokeActionInput) (output *models.ActionResult, resp *http.Response, err error)

InvokeActionWithContext - Invokes an action for an SP adapter instance. RequestType: POST Input: ctx context.Context, input *InvokeActionInput

func (*SpAdaptersService) UpdateSpAdapter

func (s *SpAdaptersService) UpdateSpAdapter(input *UpdateSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)

UpdateSpAdapter - Update an SP adapter instance. RequestType: PUT Input: input *UpdateSpAdapterInput

func (*SpAdaptersService) UpdateSpAdapterWithContext

func (s *SpAdaptersService) UpdateSpAdapterWithContext(ctx context.Context, input *UpdateSpAdapterInput) (output *models.SpAdapter, resp *http.Response, err error)

UpdateSpAdapterWithContext - Update an SP adapter instance. RequestType: PUT Input: ctx context.Context, input *UpdateSpAdapterInput

func (*SpAdaptersService) UpdateUrlMappings

func (s *SpAdaptersService) UpdateUrlMappings(input *UpdateUrlMappingsInput) (output *models.SpAdapterUrlMappings, resp *http.Response, err error)

UpdateUrlMappings - (Deprecated) Update the mappings between URLs and adapters instances. RequestType: PUT Input: input *UpdateUrlMappingsInput

func (*SpAdaptersService) UpdateUrlMappingsWithContext

func (s *SpAdaptersService) UpdateUrlMappingsWithContext(ctx context.Context, input *UpdateUrlMappingsInput) (output *models.SpAdapterUrlMappings, resp *http.Response, err error)

UpdateUrlMappingsWithContext - (Deprecated) Update the mappings between URLs and adapters instances. RequestType: PUT Input: ctx context.Context, input *UpdateUrlMappingsInput

type UpdateSpAdapterInput

type UpdateSpAdapterInput struct {
	Body models.SpAdapter
	Id   string
}

type UpdateUrlMappingsInput

type UpdateUrlMappingsInput struct {
	Body models.SpAdapterUrlMappings
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL