/
model_create_update_dashboard_request.go
34 lines (31 loc) · 4.58 KB
/
model_create_update_dashboard_request.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/*
* Dashboards API
*
* API for creating, retrieving, updating, and deleting dashboards and dashboard groups. <br> Dashboards are groups of charts. In a dashboard, all the charts that belong to the dashboard appear at the same time and follow the same filtering options. ## Dashboard layout The system lays out dashboards and the charts they contain with these dimensions: <br> * The web UI reserves a 12x100 grid for each dashboard and assigns one or more charts to specific locations within the grid. * A chart associated with the dashboard can be any size from 1x1 to 12x3. * If you assign overlapping dashboard locations for charts, the system attempts to resize or reorganize the layout. This ensures that all of the charts fit within the space alloted to the dashboard. ## Dashboard access By default, all users in an organization can edit and delete dashboards and dashboard groups. If SignalFx has enabled the \"write permissions\" feature for your organization, you can limit editing or deleting of specific dashboards to specific individuals or teams, or both. Use this feature to prevent unauthorized or accidental modifications to dashboards and the charts they contain. ## Cloning dashboards Users who don't have permission to edit a dashboard can still clone it and modify the clone. ## View dashboards You can view dashboards you create using the API in the web UI by specifying their \"id\" property in a web UI URL, by following this syntax: <br> <code>https://app.signalfx.com/#/dashboard/<DASHBOARD_ID></code> <br> Dashboards you create using the API also appear by name in the web UI catalog and in their dashboard group.
*
* API version: 3.0.0
* Generated by: OpenAPI Generator (https://openapi-generator.tech)
*/
package dashboard
type CreateUpdateDashboardRequest struct {
AuthorizedWriters *AuthorizedWriters `json:"authorizedWriters,omitempty"`
Permissions *ObjectPermissions `json:"permissions,omitempty"`
ChartDensity DashboardChartDensity `json:"chartDensity,omitempty"`
Charts []*DashboardChart `json:"charts,omitempty"`
// Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the web UI.
Description string `json:"description,omitempty"`
DiscoveryOptions *DiscoveryOptions `json:"discoveryOptions,omitempty"`
// Array of event overlay definitions that you can apply to all of the charts of this dashboard. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event.<br> **Note:** The objects in this array correspond to the *suggested* event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the `selectedEventOverlays` property instead.
EventOverlays []*ChartEventOverlay `json:"eventOverlays,omitempty"`
Filters *ChartsFilters `json:"filters,omitempty"`
// ID of an existing dashboard group to associate with this dashboard. If you don't specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.
GroupId string `json:"groupId,omitempty"`
// Milliseconds to wait for late-arriving datapoints before rejecting them for inclusion in the charts in this dashboard. This value *overrides* but doesn't *change* the max delay setting for individua charts in the dashboard. If you omit this property, the system uses individual chart settings.<br> For individual charts, you can force the system to calculate a sensible value by removing the chart's `maxDelayOverride` property. To force the system to do this for all charts in a dashboard, set `CreateDashboardBody.maxDelayOverride` to 0.
MaxDelayOverride *int32 `json:"maxDelayOverride,omitempty"`
// A human-readable label for the dashboard. The web UI displays this label in the dashboard's group.
Name string `json:"name,omitempty"`
// Array of event overlays that are currently active for the charts in this dashboard. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the the overlay's color and event line settings. To set options for inactive overlays so you can apply them at a later time, use the `eventOverlays` property instead.
SelectedEventOverlays []*ChartEventOverlay `json:"selectedEventOverlays,omitempty"`
// Array of dashboard tags. Reserved for future use.
Tags []string `json:"tags,omitempty"`
}