model_simple_dashboard_model.go

/*
 * 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/&lt;DASHBOARD_ID&gt;</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

import (
	"github.com/signalfx/signalfx-go/chart"
)

// Dashboard object that describes the properties needed for a simple dashboard that's specified only by the charts it contains
type SimpleDashboardModel struct {
	ChartDensity DashboardChartDensity `json:"chartDensity,omitempty"`
	Charts       []*chart.Chart        `json:"charts,omitempty"`
	// The dashboard creation date and time, in the form of a Unix time value (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0). The system sets this value, and you can't modify it.
	Created int64 `json:"created,omitempty"`
	// SignalFx-assigned user ID of the user that created the dashboard. If the system created this dashboard, the value is \"AAAAAAAAAA\". The system sets this value, and you can't modify it.
	Creator string `json:"creator,omitempty"`
	// Custom properties for the dashboard, in the form of a JSON object that contains key-value pairs. Custom properties must follow these syntax restrictions:<br> **Key:**<br>   * ASCII characters only   * Length <= 128 characters   * Can only contain upper and lower case alphanumeric characters,     underscores (\"_\"), and hyphens (\"-\")   * Must start with an alphabetic character, upper or lower case.   * Can't start with any of the following strings, which are     reserved for system use: \"_\", \"sf_\", \"aws_\", or \"gcp_\". <br> **Value:**<br>   * Must be present if you specify a key   * Must not be empty   * ASCII characters only   * Length <= 256 characters
	CustomProperties map[string]interface{} `json:"customProperties,omitempty"`
	// Description of the chart. This value appears underneath the chart name in the SignalFx web UI.
	Description string `json:"description,omitempty"`
	// Reserved for system use
	DiscoveryOptions map[string]interface{} `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 []*EventOverlayFilter `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"`
	// The dashboard's SignalFx-assigned ID. This value is \"read-only\" for a create request. The system assigns it and returns it to you in the response.
	Id string `json:"id,omitempty"`
	// The last time the dashboard was updated, in the form of a Unix timestamp (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0) This value is \"read-only\".
	LastUpdated int64 `json:"lastUpdated,omitempty"`
	// SignalFx-assigned ID of the last user who updated the dashboard. If the last update was by the system, the value is \"AAAAAAAAAA\". This value is \"read-only\".
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// Flag that controls modification of the dashboard. If `true`, users can't modify the dashboard. If `false`, users that have authorization to access the dashboard can edit it.
	Locked bool `json:"locked,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"`
	// The displayed name of the chart in the dashboard
	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"`
	// An array that contains tag values. You can use tags to search for or filter charts. One use is to tag charts that are in production with the value `prod`. <br> **NOTE:** You can't have more than 50 tags per chart.
	Tags []string `json:"tags,omitempty"`
}