tagsets

package

v2.98.0 Latest Latest Go to latest Published: Jan 7, 2026 License: Apache-2.0 Imports: 8 Imported by: 5

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/OctopusDeploy/go-octopusdeploy

Links

Open Source Insights

Documentation ¶

Index ¶

func DeleteByID(client newclient.Client, spaceID string, ID string) error
func Get(client newclient.Client, spaceID string, tagSetsQuery TagSetsQuery) (*resources.Resources[*TagSet], error)
func IsNil(i interface{}) bool
type Tag
- func NewTag(name string, color string) *Tag
type TagSet
type TagSetScope
type TagSetService
- func NewTagSetService(sling *sling.Sling, uriTemplate string, sortOrderPath string) *TagSetService
type TagSetType
type TagSetsQuery

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DeleteByID ¶ added in v2.33.0

func DeleteByID(client newclient.Client, spaceID string, ID string) error

DeleteByID deletes the tag set that matches the provided ID.

func Get ¶ added in v2.33.0

func Get(client newclient.Client, spaceID string, tagSetsQuery TagSetsQuery) (*resources.Resources[*TagSet], error)

Get returns a collection of tag sets based on the criteria defined by its input query parameter.

func IsNil ¶

func IsNil(i interface{}) bool

Types ¶

type Tag ¶

type Tag struct {
	CanonicalTagName string `json:"CanonicalTagName,omitempty"`
	Color            string `json:"Color"`
	Description      string `json:"Description"`
	ID               string `json:"Id,omitempty"`
	Name             string `json:"Name"`
	SortOrder        int    `json:"SortOrder,omitempty"`
}

func NewTag ¶ added in v2.3.0

func NewTag(name string, color string) *Tag

NewTag initializes a tag with a name and a color.

type TagSet ¶

type TagSet struct {
	Description string        `json:"Description"`
	Name        string        `json:"Name"`
	Scopes      []TagSetScope `json:"Scopes,omitempty"`
	SortOrder   int32         `json:"SortOrder,omitempty"`
	SpaceID     string        `json:"SpaceId,omitempty"`
	Tags        []*Tag        `json:"Tags,omitempty"`
	Type        TagSetType    `json:"Type,omitempty"`

	resources.Resource
}

func Add ¶ added in v2.33.0

func Add(client newclient.Client, tagSet *TagSet) (*TagSet, error)

Add creates a new tag set.

func GetAll ¶ added in v2.34.0

func GetAll(client newclient.Client, spaceID string) ([]*TagSet, error)

GetAll returns all tag sets. If an error occurs, it returns nil.

func GetByID ¶ added in v2.33.0

func GetByID(client newclient.Client, spaceID string, ID string) (*TagSet, error)

GetByID returns the tag set that matches the input ID.

func NewTagSet ¶

func NewTagSet(name string) *TagSet

NewTagSet initializes a TagSet with a name.

func Update ¶ added in v2.33.0

func Update(client newclient.Client, tagSet *TagSet) (*TagSet, error)

Update modifies a tag set based on the one provided as input.

type TagSetScope ¶ added in v2.83.0

type TagSetScope string

const (
	TagSetScopeTenant      TagSetScope = "Tenant"
	TagSetScopeEnvironment TagSetScope = "Environment"
	TagSetScopeProject     TagSetScope = "Project"
)

type TagSetService ¶

type TagSetService struct {
	services.CanDeleteService
	// contains filtered or unexported fields
}

func NewTagSetService ¶

func NewTagSetService(sling *sling.Sling, uriTemplate string, sortOrderPath string) *TagSetService

func (*TagSetService) Add deprecated

func (s *TagSetService) Add(tagSet *TagSet) (*TagSet, error)

Add creates a new tag set.

Deprecated: Use tagsets.Add

func (*TagSetService) Get deprecated

func (s *TagSetService) Get(tagSetsQuery TagSetsQuery) (*resources.Resources[*TagSet], error)

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

Deprecated: Use tagsets.Get

func (*TagSetService) GetAll ¶

func (s *TagSetService) GetAll() ([]*TagSet, error)

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

Deprecates: use tagsets.GetAll

func (*TagSetService) GetByID deprecated

func (s *TagSetService) GetByID(id string) (*TagSet, error)

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

Deprecated: Use tagsets.GetByID

func (*TagSetService) GetByName ¶

func (s *TagSetService) GetByName(name string) (*TagSet, error)

GetByName performs a lookup and returns the TagSet with a matching name.

func (*TagSetService) Update deprecated

func (s *TagSetService) Update(tagSet *TagSet) (*TagSet, error)

Update modifies a tag set based on the one provided as input.

Deprecated: Use tagsets.Update

type TagSetType ¶ added in v2.83.0

type TagSetType string

const (
	TagSetTypeSingleSelect TagSetType = "SingleSelect"
	TagSetTypeMultiSelect  TagSetType = "MultiSelect"
	TagSetTypeFreeText     TagSetType = "FreeText"
)

type TagSetsQuery ¶

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

Source Files ¶

View all Source files

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