projectgroups

Documentation

Index

• func IsNil(i interface{}) bool
• type ProjectGroup
  • func NewProjectGroup(name string) *ProjectGroup
  • func (s *ProjectGroup) GetName() string
• type ProjectGroupService
  • func NewProjectGroupService(sling *sling.Sling, uriTemplate string) *ProjectGroupService
  • func (s *ProjectGroupService) Add(projectGroup *ProjectGroup) (*ProjectGroup, error)
  • func (s *ProjectGroupService) Get(projectGroupsQuery ProjectGroupsQuery) (*resources.Resources[*ProjectGroup], error)
  • func (s *ProjectGroupService) GetAll() ([]*ProjectGroup, error)
  • func (s *ProjectGroupService) GetByID(id string) (*ProjectGroup, error)
  • func (s *ProjectGroupService) GetByIDOrName(idOrName string) (*ProjectGroup, error)
  • func (s *ProjectGroupService) GetByName(name string) (*ProjectGroup, error)
  • func (s *ProjectGroupService) GetByPartialName(partialName string) ([]*ProjectGroup, error)
  • func (s *ProjectGroupService) GetProjects(projectGroup *ProjectGroup) ([]*projects.Project, error)
  • func (s *ProjectGroupService) Update(resource ProjectGroup) (*ProjectGroup, error)
• type ProjectGroupsQuery

Functions

func IsNil

func IsNil(i interface{}) bool

Types

type ProjectGroup

type ProjectGroup struct {
	Description       string   `json:"Description,omitempty"`
	EnvironmentIDs    []string `json:"EnvironmentIds,omitempty"`
	Name              string   `json:"Name,omitempty" validate:"required"`
	RetentionPolicyID string   `json:"RetentionPolicyId,omitempty"`
	SpaceID           string   `json:"SpaceId,omitempty"`

	resources.Resource
}

func NewProjectGroup

func NewProjectGroup(name string) *ProjectGroup

func (*ProjectGroup) GetName

func (s *ProjectGroup) GetName() string

type ProjectGroupService

type ProjectGroupService struct {
	services.CanDeleteService
}

ProjectGroupService handles communication with ProjectGroup-related methods of the Octopus API.

func NewProjectGroupService

func NewProjectGroupService(sling *sling.Sling, uriTemplate string) *ProjectGroupService

NewProjectGroupService returns a projectGroupService with a preconfigured client.

func (*ProjectGroupService) Add

func (s *ProjectGroupService) Add(projectGroup *ProjectGroup) (*ProjectGroup, error)

Add creates a new project group.

func (*ProjectGroupService) Get

func (s *ProjectGroupService) Get(projectGroupsQuery ProjectGroupsQuery) (*resources.Resources[*ProjectGroup], error)

Get returns a collection of project groups based on the criteria defined by its input query parameter. If an error occurs, an empty collection is returned along with the associated error.

func (*ProjectGroupService) GetAll

func (s *ProjectGroupService) GetAll() ([]*ProjectGroup, error)

GetAll returns all project groups. If none can be found or an error occurs, it returns an empty collection.

func (*ProjectGroupService) GetByID

func (s *ProjectGroupService) GetByID(id string) (*ProjectGroup, error)

GetByID returns the project group that matches the input ID. If one cannot be found, it returns nil and an error.

func (*ProjectGroupService) GetByIDOrName

func (s *ProjectGroupService) GetByIDOrName(idOrName string) (*ProjectGroup, error)

func (*ProjectGroupService) GetByName

func (s *ProjectGroupService) GetByName(name string) (*ProjectGroup, error)

func (*ProjectGroupService) GetByPartialName

func (s *ProjectGroupService) GetByPartialName(partialName string) ([]*ProjectGroup, error)

GetByPartialName performs a lookup and returns a collection of project groups with a matching partial name.

func (*ProjectGroupService) GetProjects

func (s *ProjectGroupService) GetProjects(projectGroup *ProjectGroup) ([]*projects.Project, error)

func (*ProjectGroupService) Update

func (s *ProjectGroupService) Update(resource ProjectGroup) (*ProjectGroup, error)

Update modifies a project group based on the one provided as input.

type ProjectGroupsQuery

type ProjectGroupsQuery struct {
	IDs         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	PartialName string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Skip        int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take        int      `uri:"take,omitempty" url:"take,omitempty"`
}