Documentation
¶
Index ¶
- Constants
- type CreateDashboardCreateDashboard
- type CreateDashboardResponse
- type CreateDebugDashboardCreateDebugDashboard
- type CreateDebugDashboardResponse
- type GetConfigFileSchemaResponse
- type GetDashboardDashboard
- type GetDashboardResponse
- type MediaFileInput
- type MetricsTemplate
- type PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview
- func (v *PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetChartCount() int
- func (v *PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetDashboards() ...
- func (v *PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetRowsToBeHidden() int
- func (v *PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetTopicName() string
- type PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef
- type PreviewTopicRemovalResponse
- type UpdateMetricsConfigResponse
- type ValidateMetricsConfigResponse
- type ValidateMetricsSetResponse
Constants ¶
const CreateDashboard_Operation = `` /* 262-byte string literal not displayed */
The mutation executed by CreateDashboard.
const CreateDebugDashboard_Operation = `` /* 433-byte string literal not displayed */
The mutation executed by CreateDebugDashboard.
const GetConfigFileSchema_Operation = `
query GetConfigFileSchema {
configFileSchema
}
`
The query executed by GetConfigFileSchema.
const GetDashboard_Operation = `
query GetDashboard ($id: String!) {
dashboard(id: $id) {
id
name
isStale
lastRanAt
}
}
`
The query executed by GetDashboard.
const PreviewTopicRemoval_Operation = `` /* 209-byte string literal not displayed */
The query executed by PreviewTopicRemoval.
const UpdateMetricsConfig_Operation = `` /* 305-byte string literal not displayed */
The mutation executed by UpdateMetricsConfig.
const ValidateMetricsConfig_Operation = `` /* 201-byte string literal not displayed */
The query executed by ValidateMetricsConfig.
const ValidateMetricsSet_Operation = `` /* 151-byte string literal not displayed */
The query executed by ValidateMetricsSet.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateDashboardCreateDashboard ¶ added in v0.52.0
CreateDashboardCreateDashboard includes the requested fields of the GraphQL type Dashboard.
func (*CreateDashboardCreateDashboard) GetId ¶ added in v0.52.0
func (v *CreateDashboardCreateDashboard) GetId() string
GetId returns CreateDashboardCreateDashboard.Id, and is useful for accessing the field via an interface.
func (*CreateDashboardCreateDashboard) GetName ¶ added in v0.52.0
func (v *CreateDashboardCreateDashboard) GetName() string
GetName returns CreateDashboardCreateDashboard.Name, and is useful for accessing the field via an interface.
type CreateDashboardResponse ¶ added in v0.52.0
type CreateDashboardResponse struct {
// Create a new dashboard
CreateDashboard CreateDashboardCreateDashboard `json:"createDashboard"`
}
CreateDashboardResponse is returned by CreateDashboard on success.
func CreateDashboard ¶ added in v0.52.0
func (*CreateDashboardResponse) GetCreateDashboard ¶ added in v0.52.0
func (v *CreateDashboardResponse) GetCreateDashboard() CreateDashboardCreateDashboard
GetCreateDashboard returns CreateDashboardResponse.CreateDashboard, and is useful for accessing the field via an interface.
type CreateDebugDashboardCreateDebugDashboard ¶ added in v0.47.0
type CreateDebugDashboardCreateDebugDashboard struct {
Id string `json:"id"`
Name string `json:"name"`
}
CreateDebugDashboardCreateDebugDashboard includes the requested fields of the GraphQL type Dashboard.
func (*CreateDebugDashboardCreateDebugDashboard) GetId ¶ added in v0.47.0
func (v *CreateDebugDashboardCreateDebugDashboard) GetId() string
GetId returns CreateDebugDashboardCreateDebugDashboard.Id, and is useful for accessing the field via an interface.
func (*CreateDebugDashboardCreateDebugDashboard) GetName ¶ added in v0.47.0
func (v *CreateDebugDashboardCreateDebugDashboard) GetName() string
GetName returns CreateDebugDashboardCreateDebugDashboard.Name, and is useful for accessing the field via an interface.
type CreateDebugDashboardResponse ¶ added in v0.47.0
type CreateDebugDashboardResponse struct {
// Create a debug dashboard from uploaded emissions and config
CreateDebugDashboard CreateDebugDashboardCreateDebugDashboard `json:"createDebugDashboard"`
}
CreateDebugDashboardResponse is returned by CreateDebugDashboard on success.
func CreateDebugDashboard ¶ added in v0.47.0
func CreateDebugDashboard( ctx_ context.Context, client_ graphql.Client, projectId string, config string, templateFiles []MetricsTemplate, emissionsFile string, branchId string, metricsSetName string, mediaFiles []MediaFileInput, ) (data_ *CreateDebugDashboardResponse, err_ error)
func (*CreateDebugDashboardResponse) GetCreateDebugDashboard ¶ added in v0.47.0
func (v *CreateDebugDashboardResponse) GetCreateDebugDashboard() CreateDebugDashboardCreateDebugDashboard
GetCreateDebugDashboard returns CreateDebugDashboardResponse.CreateDebugDashboard, and is useful for accessing the field via an interface.
type GetConfigFileSchemaResponse ¶ added in v0.61.0
type GetConfigFileSchemaResponse struct {
// Returns the JSON Schema (Draft-07) describing the metrics configuration file format.
ConfigFileSchema string `json:"configFileSchema"`
}
GetConfigFileSchemaResponse is returned by GetConfigFileSchema on success.
func GetConfigFileSchema ¶ added in v0.61.0
func (*GetConfigFileSchemaResponse) GetConfigFileSchema ¶ added in v0.61.0
func (v *GetConfigFileSchemaResponse) GetConfigFileSchema() string
GetConfigFileSchema returns GetConfigFileSchemaResponse.ConfigFileSchema, and is useful for accessing the field via an interface.
type GetDashboardDashboard ¶ added in v0.47.0
type GetDashboardDashboard struct {
Id string `json:"id"`
Name string `json:"name"`
IsStale bool `json:"isStale"`
LastRanAt string `json:"lastRanAt"`
}
GetDashboardDashboard includes the requested fields of the GraphQL type Dashboard.
func (*GetDashboardDashboard) GetId ¶ added in v0.47.0
func (v *GetDashboardDashboard) GetId() string
GetId returns GetDashboardDashboard.Id, and is useful for accessing the field via an interface.
func (*GetDashboardDashboard) GetIsStale ¶ added in v0.47.0
func (v *GetDashboardDashboard) GetIsStale() bool
GetIsStale returns GetDashboardDashboard.IsStale, and is useful for accessing the field via an interface.
func (*GetDashboardDashboard) GetLastRanAt ¶ added in v0.47.0
func (v *GetDashboardDashboard) GetLastRanAt() string
GetLastRanAt returns GetDashboardDashboard.LastRanAt, and is useful for accessing the field via an interface.
func (*GetDashboardDashboard) GetName ¶ added in v0.47.0
func (v *GetDashboardDashboard) GetName() string
GetName returns GetDashboardDashboard.Name, and is useful for accessing the field via an interface.
type GetDashboardResponse ¶ added in v0.47.0
type GetDashboardResponse struct {
// Get a single dashboard by ID
Dashboard GetDashboardDashboard `json:"dashboard"`
}
GetDashboardResponse is returned by GetDashboard on success.
func GetDashboard ¶ added in v0.47.0
func (*GetDashboardResponse) GetDashboard ¶ added in v0.47.0
func (v *GetDashboardResponse) GetDashboard() GetDashboardDashboard
GetDashboard returns GetDashboardResponse.Dashboard, and is useful for accessing the field via an interface.
type MediaFileInput ¶ added in v0.63.0
type MediaFileInput struct {
Name string `json:"name"`
// base64 encoded media file contents
Contents string `json:"contents"`
}
func (*MediaFileInput) GetContents ¶ added in v0.63.0
func (v *MediaFileInput) GetContents() string
GetContents returns MediaFileInput.Contents, and is useful for accessing the field via an interface.
func (*MediaFileInput) GetName ¶ added in v0.63.0
func (v *MediaFileInput) GetName() string
GetName returns MediaFileInput.Name, and is useful for accessing the field via an interface.
type MetricsTemplate ¶
type MetricsTemplate struct {
Name string `json:"name"`
// base64 encoded template contents
Contents string `json:"contents"`
}
func (*MetricsTemplate) GetContents ¶
func (v *MetricsTemplate) GetContents() string
GetContents returns MetricsTemplate.Contents, and is useful for accessing the field via an interface.
func (*MetricsTemplate) GetName ¶
func (v *MetricsTemplate) GetName() string
GetName returns MetricsTemplate.Name, and is useful for accessing the field via an interface.
type PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview ¶ added in v0.67.0
type PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview struct {
TopicName string `json:"topicName"`
RowsToBeHidden int `json:"rowsToBeHidden"`
ChartCount int `json:"chartCount"`
Dashboards []PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef `json:"dashboards"`
}
PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview includes the requested fields of the GraphQL type TopicRemovalPreview.
func (*PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetChartCount ¶ added in v0.67.0
func (v *PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetChartCount() int
GetChartCount returns PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview.ChartCount, and is useful for accessing the field via an interface.
func (*PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetDashboards ¶ added in v0.67.0
func (v *PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetDashboards() []PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef
GetDashboards returns PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview.Dashboards, and is useful for accessing the field via an interface.
func (*PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetRowsToBeHidden ¶ added in v0.67.0
func (v *PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetRowsToBeHidden() int
GetRowsToBeHidden returns PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview.RowsToBeHidden, and is useful for accessing the field via an interface.
func (*PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetTopicName ¶ added in v0.67.0
func (v *PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview) GetTopicName() string
GetTopicName returns PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview.TopicName, and is useful for accessing the field via an interface.
type PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef ¶ added in v0.67.0
type PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef struct {
Id string `json:"id"`
Name string `json:"name"`
}
PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef includes the requested fields of the GraphQL type TopicRemovalDashboardRef.
func (*PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef) GetId ¶ added in v0.67.0
func (v *PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef) GetId() string
GetId returns PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef.Id, and is useful for accessing the field via an interface.
func (*PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef) GetName ¶ added in v0.67.0
func (v *PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef) GetName() string
GetName returns PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreviewDashboardsTopicRemovalDashboardRef.Name, and is useful for accessing the field via an interface.
type PreviewTopicRemovalResponse ¶ added in v0.67.0
type PreviewTopicRemovalResponse struct {
// Previews the topics a config sync would remove: rows that would be hidden, job/batch chart count, and affected dashboards. Does not persist anything.
PreviewTopicRemoval []PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview `json:"previewTopicRemoval"`
}
PreviewTopicRemovalResponse is returned by PreviewTopicRemoval on success.
func PreviewTopicRemoval ¶ added in v0.67.0
func (*PreviewTopicRemovalResponse) GetPreviewTopicRemoval ¶ added in v0.67.0
func (v *PreviewTopicRemovalResponse) GetPreviewTopicRemoval() []PreviewTopicRemovalPreviewTopicRemovalTopicRemovalPreview
GetPreviewTopicRemoval returns PreviewTopicRemovalResponse.PreviewTopicRemoval, and is useful for accessing the field via an interface.
type UpdateMetricsConfigResponse ¶
type UpdateMetricsConfigResponse struct {
// Update metrics config with the given configuration
UpdateMetricsConfig string `json:"updateMetricsConfig"`
}
UpdateMetricsConfigResponse is returned by UpdateMetricsConfig on success.
func UpdateMetricsConfig ¶
func (*UpdateMetricsConfigResponse) GetUpdateMetricsConfig ¶
func (v *UpdateMetricsConfigResponse) GetUpdateMetricsConfig() string
GetUpdateMetricsConfig returns UpdateMetricsConfigResponse.UpdateMetricsConfig, and is useful for accessing the field via an interface.
type ValidateMetricsConfigResponse ¶ added in v0.60.0
type ValidateMetricsConfigResponse struct {
// Validates a metrics config against an existing branch without persisting it. Returns true when valid; otherwise errors with the validation messages.
ValidateMetricsConfig bool `json:"validateMetricsConfig"`
}
ValidateMetricsConfigResponse is returned by ValidateMetricsConfig on success.
func ValidateMetricsConfig ¶ added in v0.60.0
func ValidateMetricsConfig( ctx_ context.Context, client_ graphql.Client, branchId string, config string, templateFiles []MetricsTemplate, ) (data_ *ValidateMetricsConfigResponse, err_ error)
func (*ValidateMetricsConfigResponse) GetValidateMetricsConfig ¶ added in v0.60.0
func (v *ValidateMetricsConfigResponse) GetValidateMetricsConfig() bool
GetValidateMetricsConfig returns ValidateMetricsConfigResponse.ValidateMetricsConfig, and is useful for accessing the field via an interface.
type ValidateMetricsSetResponse ¶ added in v0.59.0
type ValidateMetricsSetResponse struct {
// Validates that a metrics set exists in the branch's latest metrics config. Returns true when valid; otherwise errors with the list of available sets.
ValidateMetricsSet bool `json:"validateMetricsSet"`
}
ValidateMetricsSetResponse is returned by ValidateMetricsSet on success.
func ValidateMetricsSet ¶ added in v0.59.0
func (*ValidateMetricsSetResponse) GetValidateMetricsSet ¶ added in v0.59.0
func (v *ValidateMetricsSetResponse) GetValidateMetricsSet() bool
GetValidateMetricsSet returns ValidateMetricsSetResponse.ValidateMetricsSet, and is useful for accessing the field via an interface.