team

Documentation

Index

• type CreateUpdateTeamRequest
• type NotificationLists
• type SearchResults
• type Team

Types

type CreateUpdateTeamRequest

type CreateUpdateTeamRequest struct {
	// Name or label for the team
	Name string `json:"name,omitempty"`
	// Text that provides extended information about the team
	Description string `json:"description,omitempty"`
	// List of organization members IDs that belong to this team
	Members           []string          `json:"members,omitempty"`
	NotificationLists NotificationLists `json:"notificationLists,omitempty"`
	DashboardGroups   []string          `json:"dashboardGroups,omitempty"`
	Detectors         []string          `json:"detectors,omitempty"`
}

Object that specifies the properties of a SignalFx team.<br> **NOTE:** When you create a team, you need to specify the `name` property in the request body.

type NotificationLists

type NotificationLists struct {
	// List of notification destinations to use for **undefined** alerts category.
	Default []*notification.Notification `json:"default,omitempty"`
	// List of notification destinations to use for **critical** alerts
	Critical []*notification.Notification `json:"critical,omitempty"`
	// List of notification destinations to use for **warning** alerts
	Warning []*notification.Notification `json:"warning,omitempty"`
	// List of notification destinations to use for **major** alerts
	Major []*notification.Notification `json:"major,omitempty"`
	// List of notification destinations to use for **minor** alerts
	Minor []*notification.Notification `json:"minor,omitempty"`
	// List of notification destinations to use for **information** alerts.
	Info []*notification.Notification `json:"info,omitempty"`
}

Specifies the notification targets to which SignalFx sends alerts when you specify the team as an alert recipient

type SearchResults

type SearchResults struct {
	// Number of team objects that matched the provided search criteria.<br> **Note:** This value is a count of the total number of objects in the result set. The number of objects that the system returns is affected by the `limit` and `offset` query parameters. In summary:<br>   * `count`: Size of result set   * number of returned objects:        * (`limit` - `offset`) >= `count`: `count`       * (`limit` - `offset`) < `count`: `limit` - `offset`
	Count int32 `json:"count,omitempty"`
	// List of team objects that the system returns as the result of the request. The number and location of the objects within the result set depend on the query  parameters you specify in the request. To learn more, see the top-level description of the API and the description of the `count` response property
	Results []Team `json:"results,omitempty"`
}

Query results, in the form of a JSON object

type Team

type Team struct {
	// SignalFx-defined ID for the team. **This property is read-only**.
	Id string `json:"id,omitempty"`
	// Name or label for the team
	Name string `json:"name,omitempty"`
	// Text that provides extended information about the team
	Description string `json:"description,omitempty"`
	// List of organization members IDs that belong to this team
	Members           []string          `json:"members,omitempty"`
	NotificationLists NotificationLists `json:"notificationLists,omitempty"`
	DashboardGroups   []string          `json:"dashboardGroups,omitempty"`
	Detectors         []string          `json:"detectors,omitempty"`
}

Object that specifies the properties of a SignalFx team.<br> **NOTE:** When you create a team, you need to specify the `name` property in the request body.