Documentation
¶
Index ¶
- type ChangeDetails
- type DocumentType
- type Event
- type EventAgent
- type EventCategoriesQuery
- type EventCategory
- type EventGroup
- type EventGroupsQuery
- type EventReference
- type EventService
- func (s EventService) Get(query EventsQuery) (*resources.Resources[*Event], error)
- func (s EventService) GetAgents() (*[]EventAgent, error)
- func (s EventService) GetCategories(query EventCategoriesQuery) (*[]EventCategory, error)
- func (s EventService) GetDocumentTypes() (*[]DocumentType, error)
- func (s EventService) GetGroups(query EventGroupsQuery) (*[]EventGroup, error)
- type EventsQuery
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ChangeDetails ¶
type ChangeDetails struct {
Differences interface{} `json:"Differences,omitempty"`
DocumentContext interface{} `json:"DocumentContext,omitempty"`
}
type DocumentType ¶
type Event ¶
type Event struct {
Category string `json:"Category,omitempty"`
ChangeDetails *ChangeDetails `json:"ChangeDetails,omitempty"`
Comments string `json:"Comments,omitempty"`
Details string `json:"Details,omitempty"`
IdentityEstablishedWith string `json:"IdentityEstablishedWith,omitempty"`
IsService bool `json:"IsService,omitempty"`
Message string `json:"Message,omitempty"`
MessageHTML string `json:"MessageHtml,omitempty"`
MessageReferences []*EventReference `json:"MessageReferences"`
Occurred time.Time `json:"Occurred,omitempty"`
RelatedDocumentIds []string `json:"RelatedDocumentIds"`
SpaceID string `json:"SpaceId,omitempty"`
UserAgent string `json:"UserAgent,omitempty"`
UserID string `json:"UserId,omitempty"`
Username string `json:"Username,omitempty"`
resources.Resource
}
type EventAgent ¶
type EventCategoriesQuery ¶
type EventCategoriesQuery struct {
AppliesTo string `uri:"appliesTo" url:"appliesTo,omitempty"`
}
type EventCategory ¶
type EventGroup ¶
type EventGroupsQuery ¶
type EventGroupsQuery struct {
AppliesTo string `uri:"appliesTo" url:"appliesTo,omitempty"`
}
type EventReference ¶
type EventService ¶
EventService handles communication with event-related methods of the Octopus API.
func NewEventService ¶
func (EventService) Get ¶
func (s EventService) Get(query EventsQuery) (*resources.Resources[*Event], error)
Get returns a collection of events 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 (EventService) GetAgents ¶
func (s EventService) GetAgents() (*[]EventAgent, error)
func (EventService) GetCategories ¶
func (s EventService) GetCategories(query EventCategoriesQuery) (*[]EventCategory, error)
func (EventService) GetDocumentTypes ¶
func (s EventService) GetDocumentTypes() (*[]DocumentType, error)
func (EventService) GetGroups ¶
func (s EventService) GetGroups(query EventGroupsQuery) (*[]EventGroup, error)
type EventsQuery ¶
type EventsQuery struct {
AsCSV string `uri:"asCsv,omitempty" url:"asCsv,omitempty"`
DocumentTypes []string `uri:"documentTypes,omitempty" url:"documentTypes,omitempty"`
Environments []string `uri:"environments,omitempty" url:"environments,omitempty"`
EventAgents []string `uri:"eventAgents,omitempty" url:"eventAgents,omitempty"`
EventCategories []string `uri:"eventCategories,omitempty" url:"eventCategories,omitempty"`
EventGroups []string `uri:"eventGroups,omitempty" url:"eventGroups,omitempty"`
ExcludeDifference bool `uri:"excludeDifference,omitempty" url:"excludeDifference,omitempty"`
From string `uri:"from,omitempty" url:"from,omitempty"`
FromAutoID string `uri:"fromAutoId,omitempty" url:"fromAutoId,omitempty"`
IDs []string `uri:"ids,omitempty" url:"ids,omitempty"`
IncludeSystem bool `uri:"includeSystem,omitempty" url:"includeSystem,omitempty"`
Internal string `uri:"interal,omitempty" url:"interal,omitempty"`
Name string `uri:"name,omitempty" url:"name,omitempty"`
PartialName string `uri:"partialName,omitempty" url:"partialName,omitempty"`
ProjectGroups []string `uri:"projectGroups,omitempty" url:"projectGroups,omitempty"`
Projects []string `uri:"projects,omitempty" url:"projects,omitempty"`
Regarding string `uri:"regarding,omitempty" url:"regarding,omitempty"`
RegardingAny string `uri:"regardingAny,omitempty" url:"regardingAny,omitempty"`
Skip int `uri:"skip,omitempty" url:"skip,omitempty"`
Spaces []string `uri:"spaces,omitempty" url:"spaces,omitempty"`
Take int `uri:"take,omitempty" url:"take,omitempty"`
Tags []string `uri:"tags,omitempty" url:"tags,omitempty"`
Tenants []string `uri:"tenants,omitempty" url:"tenants,omitempty"`
To string `uri:"to,omitempty" url:"to,omitempty"`
ToAutoID string `uri:"toAutoId,omitempty" url:"toAutoId,omitempty"`
User string `uri:"user,omitempty" url:"user,omitempty"`
Users []string `uri:"users,omitempty" url:"users,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.