environment

Documentation

Index

• Constants
• type EnvironmentAPI
• type EnvironmentService
  • func New(cfg *config.Config) *EnvironmentService
  • func (s *EnvironmentService) DeleteEnvironmentCommand() (resp *http.Response, err error)
  • func (s *EnvironmentService) GetEnvironmentCommand() (output *models.EnvironmentView, resp *http.Response, err error)
  • func (s *EnvironmentService) UpdateEnvironmentCommand(input *UpdateEnvironmentCommandInput) (output *models.EnvironmentView, resp *http.Response, err error)
• type UpdateEnvironmentCommandInput

Constants

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

Types

type EnvironmentAPI

type EnvironmentAPI interface {
	DeleteEnvironmentCommand() (resp *http.Response, err error)
	GetEnvironmentCommand() (output *models.EnvironmentView, resp *http.Response, err error)
	UpdateEnvironmentCommand(input *UpdateEnvironmentCommandInput) (output *models.EnvironmentView, resp *http.Response, err error)
}

type EnvironmentService

type EnvironmentService struct {
	*client.Client
}

EnvironmentService provides the API operations for making requests to Environment endpoint.

func New

func New(cfg *config.Config) *EnvironmentService

New createa a new instance of the EnvironmentService client.

Example:

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

//Create a EnvironmentService from the configuration
svc := environment.New(cfg)

func (*EnvironmentService) DeleteEnvironmentCommand

func (s *EnvironmentService) DeleteEnvironmentCommand() (resp *http.Response, err error)

DeleteEnvironmentCommand - Resets the Environment configuration to default values RequestType: DELETE Input:

func (*EnvironmentService) GetEnvironmentCommand

func (s *EnvironmentService) GetEnvironmentCommand() (output *models.EnvironmentView, resp *http.Response, err error)

GetEnvironmentCommand - Get the Environment RequestType: GET Input:

func (*EnvironmentService) UpdateEnvironmentCommand

func (s *EnvironmentService) UpdateEnvironmentCommand(input *UpdateEnvironmentCommandInput) (output *models.EnvironmentView, resp *http.Response, err error)

UpdateEnvironmentCommand - Update the Environment RequestType: PUT Input: input *UpdateEnvironmentCommandInput

type UpdateEnvironmentCommandInput

type UpdateEnvironmentCommandInput struct {
	Body models.EnvironmentView
}

UpdateEnvironmentCommandInput - Inputs for UpdateEnvironmentCommand