datalink

Documentation

Index

• type CreateUpdateDataLinkRequest
• type DataLink
• type SearchResults
• type Target
• type TimeFormat
• type Type

Types

type CreateUpdateDataLinkRequest

type CreateUpdateDataLinkRequest struct {
	// Name (key) of the metadata that's the trigger of a data link.
	PropertyName string `json:"propertyName,omitempty"`
	// Value of the metadata that's the trigger of a data link.
	PropertyValue string `json:"propertyValue,omitempty"`

	// Optional dashboard id
	ContextId string `json:"contextId,omitempty"`

	Targets []*Target `json:"targets,omitempty"`
}

type DataLink

type DataLink struct {
	// The data link 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 data link. 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"`
	// The data link'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 data link 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 data link. If the last update was by the system, the value is \"AAAAAAAAAA\". This value is \"read-only\".
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// Name (key) of the metadata that's the trigger of a data link.
	PropertyName string `json:"propertyName,omitempty"`
	// Value of the metadata that's the trigger of a data link.
	PropertyValue string `json:"propertyValue,omitempty"`
	// Optional dashboard id
	ContextId string `json:"contextId,omitempty"`

	Targets []*Target `json:"targets,omitempty"`
}

type SearchResults

type SearchResults struct {
	// Number of objects that match the search query. If you use paging, `count` is either the value of the `limit` request parameter or the number of objects still undelivered after the request reached the `offset` request parameter.<br> *Note:* If you use paging, count is not the number of objects returned in the response.
	Count int32 `json:"count,omitempty"`
	// An array of data link definitions that match the request criteria.
	Results []DataLink `json:"results,omitempty"`
}

type Target

type Target struct {
	Type Type `json:"type,omitempty"`
	// SignalFx-assigned ID of the dashboard link target's dashboard group
	DashboardGroupId string `json:"dashboardGroupId,omitempty"`
	// User-assigned name of a link target dashboard's dashboard group.
	DashboardGroupName string `json:"dashboardGroupName,omitempty"`
	// SignalFx-assigned ID of the dashboard link target
	DashboardId string `json:"dashboardId,omitempty"`
	// User-assigned name of the dashboard link target.
	DashboardName string `json:"dashboardName,omitempty"`
	// Flag that designates a target as the default for a data link object.
	IsDefault bool `json:"isDefault"`
	// User-assigned target name.
	Name string `json:"name,omitempty"`
	// The minimum time window for a search sent to an external site.
	MinimumTimeWindow util.StringOrInteger `json:"minimumTimeWindow,omitempty"`
	// Describes the relationship between SignalFx metadata keys and external system properties when the key names are different
	PropertyKeyMapping map[string]string `json:"propertyKeyMapping,omitempty"`
	TimeFormat         TimeFormat        `json:"timeFormat,omitempty"`
	URL                string            `json:"url,omitempty"`
}

type TimeFormat

type TimeFormat string

TimeFormat : Designates the format of minimumTimeWindow in the same data link target object.

const (
	ISO8601      TimeFormat = "ISO8601"
	Epoch        TimeFormat = "Epoch"
	EpochSeconds TimeFormat = "EpochSeconds"
)

List of Time Format

type Type

type Type string

Type : Target type designator

const (
	INTERNAL_LINK Type = "INTERNAL_LINK"
	EXTERNAL_LINK Type = "EXTERNAL_LINK"
	SPLUNK_LINK   Type = "SPLUNK_LINK"
)

List of Type