Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Latest commit

 

History

History
1188 lines (820 loc) · 18.3 KB

redash.md

File metadata and controls

1188 lines (820 loc) · 18.3 KB

redash

-- import "github.com/koooge/redash-sdk-go/redash"

Usage

type Client

type Client struct {
	Config *Config
}

func NewClient

func NewClient(config *Config) *Client

func (*Client) CreateDataSource

func (c *Client) CreateDataSource(input *CreateDataSourceInput) *CreateDataSourceOutput

func (*Client) CreateQuery

func (c *Client) CreateQuery(input *CreateQueryInput) *CreateQueryOutput

func (*Client) DeleteDataSource

func (c *Client) DeleteDataSource(input *DeleteDataSourceInput) *DeleteDataSourceOutput

func (*Client) DeleteQuery

func (c *Client) DeleteQuery(input *DeleteQueryInput) *DeleteQueryOutput

func (*Client) GetAlert

func (c *Client) GetAlert(input *GetAlertInput) *GetAlertOutput

func (*Client) GetDashboard

func (c *Client) GetDashboard(input *GetDashboardInput) *GetDashboardOutput

func (*Client) GetDashboardTags

func (c *Client) GetDashboardTags(_ *GetDashboardTagsInput) *GetDashboardTagsOutput

func (*Client) GetDataSource

func (c *Client) GetDataSource(input *GetDataSourceInput) *GetDataSourceOutput

func (*Client) GetDataSourceSchema

func (c *Client) GetDataSourceSchema(input *GetDataSourceSchemaInput) *GetDataSourceSchemaOutput

func (*Client) GetDestination

func (c *Client) GetDestination(input *GetDestinationInput) *GetDestinationOutput

func (*Client) GetEvents

func (c *Client) GetEvents(_ *GetEventsInput) *GetEventsOutput

func (*Client) GetGroup

func (c *Client) GetGroup(input *GetGroupInput) *GetGroupOutput

func (*Client) GetJob

func (c *Client) GetJob(input *GetJobInput) *GetJobOutput

func (*Client) GetMyQueries

func (c *Client) GetMyQueries(_ *GetMyQueriesInput) *GetMyQueriesOutput

func (*Client) GetOrganizationSettings

func (c *Client) GetOrganizationSettings(_ *GetOrganizationSettingsInput) *GetOrganizationSettingsOutput

func (*Client) GetPublicDashboard

func (c *Client) GetPublicDashboard(input *GetPublicDashboardInput) *GetPublicDashboardOutput

func (*Client) GetQuery

func (c *Client) GetQuery(input *GetQueryInput) *GetQueryOutput

func (*Client) GetQueryRecent

func (c *Client) GetQueryRecent(_ *GetQueryRecentInput) *GetQueryRecentOutput

func (*Client) GetQueryResult

func (c *Client) GetQueryResult(input *GetQueryResultInput) *GetQueryResultOutput

func (*Client) GetQuerySearch

func (c *Client) GetQuerySearch(_ *GetQuerySearchInput) *GetQuerySearchOutput

func (*Client) GetQuerySnippet

func (c *Client) GetQuerySnippet(input *GetQuerySnippetInput) *GetQuerySnippetOutput

func (*Client) GetQueryTags

func (c *Client) GetQueryTags(_ *GetQueryTagsInput) *GetQueryTagsOutput

func (*Client) GetUser

func (c *Client) GetUser(input *GetUserInput) *GetUserOutput

func (*Client) ListAlertSubscriptions

func (c *Client) ListAlertSubscriptions(input *ListAlertSubscriptionsInput) *ListAlertSubscriptionsOutput

func (*Client) ListAlerts

func (c *Client) ListAlerts(_ *ListAlertsInput) *ListAlertsOutput

func (*Client) ListDashboardFavorites

func (c *Client) ListDashboardFavorites(_ *ListDashboardFavoritesInput) *ListDashboardFavoritesOutput

func (*Client) ListDashboards

func (c *Client) ListDashboards(_ *ListDashboardsInput) *ListDashboardsOutput

func (*Client) ListDataSources

func (c *Client) ListDataSources(_ *ListDataSourcesInput) *ListDataSourcesOutput

func (*Client) ListDataSourcesTypes

func (c *Client) ListDataSourcesTypes(_ *ListDataSourcesTypesInput) *ListDataSourcesTypesOutput

func (*Client) ListDestinationTypes

func (c *Client) ListDestinationTypes(_ *ListDestinationTypesInput) *ListDestinationTypesOutput

func (*Client) ListDestinations

func (c *Client) ListDestinations(_ *ListDestinationsInput) *ListDestinationsOutput

func (*Client) ListGroupMembers

func (c *Client) ListGroupMembers(input *ListGroupMembersInput) *ListGroupMembersOutput

func (*Client) ListGroups

func (c *Client) ListGroups(_ *ListGroupsInput) *ListGroupsOutput

func (*Client) ListQueries

func (c *Client) ListQueries(_ *ListQueriesInput) *ListQueriesOutput

func (*Client) ListQueryFavorites

func (c *Client) ListQueryFavorites(_ *ListQueryFavoritesInput) *ListQueryFavoritesOutput

func (*Client) ListQuerySnippets

func (c *Client) ListQuerySnippets(_ *ListQuerySnippetsInput) *ListQuerySnippetsOutput

func (*Client) ListUsers

func (c *Client) ListUsers(_ *ListUsersInput) *ListUsersOutput

func (*Client) ModifyQuery

func (c *Client) ModifyQuery(input *ModifyQueryInput) *ModifyQueryOutput

func (*Client) PauseDataSource

func (c *Client) PauseDataSource(input *PauseDataSourceInput) *PauseDataSourceOutput

func (*Client) SetConfig

func (c *Client) SetConfig(config *Config)

func (*Client) TestDataSource

func (c *Client) TestDataSource(input *TestDataSourceInput) *TestDataSourceOutput

func (*Client) UnpauseDataSource

func (c *Client) UnpauseDataSource(input *UnpauseDataSourceInput) *UnpauseDataSourceOutput

func (*Client) UpdateDataSource

func (c *Client) UpdateDataSource(input *UpdateDataSourceInput) *UpdateDataSourceOutput

type Config

type Config struct {
	EndpointUrl string
	ApiKey      string
}

type CreateDataSourceInput

type CreateDataSourceInput struct {
	Options *CreateDataSourceInputOptions `json:"options"`
	Name    string                        `json:"name"`
	Type    string                        `json:"type"`
}

POST /api/data_sources

type CreateDataSourceInputOptions

type CreateDataSourceInputOptions struct {
	Dbname string `json:"dbname"`
}

type CreateDataSourceOutput

type CreateDataSourceOutput struct {
	Body       string `json:"-"`
	StatusCode int    `json:"-"`
	Id         int    `json:"id"`
}

type CreateQueryInput

type CreateQueryInput struct {
	DataSourceId int    `json:"data_source_id"`
	Query        string `json:"query"`
	Name         string `json:"name"`
	Description  string `json:"description,omitempty"`
	Schedule     string `json:"schedule,omitempty"`
}

type CreateQueryOutput

type CreateQueryOutput struct {
	QueryId    int    `json:"id"`
	Body       string `json:"-"`
	StatusCode int    `json:"-"`
}

type DeleteDataSourceInput

type DeleteDataSourceInput struct {
	DataSourceId int
}

DELETE /api/data_sources/{data_source_id}

type DeleteDataSourceOutput

type DeleteDataSourceOutput struct {
	Body       string
	StatusCode int
}

type DeleteQueryInput

type DeleteQueryInput struct {
	QueryId int
}

type DeleteQueryOutput

type DeleteQueryOutput struct {
	Body       string
	StatusCode int
}

type GetAlertInput

type GetAlertInput struct {
	AlertId int
}

type GetAlertOutput

type GetAlertOutput struct {
	Body       string
	StatusCode int
}

type GetDashboardInput

type GetDashboardInput struct {
	DashboardSlug string
}

type GetDashboardOutput

type GetDashboardOutput struct {
	Body       string
	StatusCode int
}

type GetDashboardTagsInput

type GetDashboardTagsInput struct {
}

type GetDashboardTagsOutput

type GetDashboardTagsOutput struct {
	Body       string
	StatusCode int
}

type GetDataSourceInput

type GetDataSourceInput struct {
	DataSourceId int
}

GET /api/data_sources/{data_source_id}

type GetDataSourceOutput

type GetDataSourceOutput struct {
	Body       string
	StatusCode int
}

type GetDataSourceSchemaInput

type GetDataSourceSchemaInput struct {
	DataSourceId int
}

GET /api/data_sources/{data_source_id}/schema

type GetDataSourceSchemaOutput

type GetDataSourceSchemaOutput struct {
	Body       string
	StatusCode int
}

type GetDestinationInput

type GetDestinationInput struct {
	DestinationId int
}

type GetDestinationOutput

type GetDestinationOutput struct {
	Body       string
	StatusCode int
}

type GetEventsInput

type GetEventsInput struct {
}

type GetEventsOutput

type GetEventsOutput struct {
	Body       string
	StatusCode int
}

type GetGroupInput

type GetGroupInput struct {
	GroupId int
}

type GetGroupOutput

type GetGroupOutput struct {
	Body       string
	StatusCode int
}

type GetJobInput

type GetJobInput struct {
	JobId int
}

type GetJobOutput

type GetJobOutput struct {
	Body       string
	StatusCode int
}

type GetMyQueriesInput

type GetMyQueriesInput struct {
}

type GetMyQueriesOutput

type GetMyQueriesOutput struct {
	Body       string
	StatusCode int
}

type GetOrganizationSettingsInput

type GetOrganizationSettingsInput struct {
}

type GetOrganizationSettingsOutput

type GetOrganizationSettingsOutput struct {
	Body       string
	StatusCode int
}

type GetPublicDashboardInput

type GetPublicDashboardInput struct {
	Token string
}

type GetPublicDashboardOutput

type GetPublicDashboardOutput struct {
	Body       string
	StatusCode int
}

type GetQueryInput

type GetQueryInput struct {
	QueryId int
}

type GetQueryOutput

type GetQueryOutput struct {
	Body       string
	StatusCode int
}

type GetQueryRecentInput

type GetQueryRecentInput struct {
}

type GetQueryRecentOutput

type GetQueryRecentOutput struct {
	Body       string
	StatusCode int
}

type GetQueryResultInput

type GetQueryResultInput struct {
	QueryResultId int
}

type GetQueryResultOutput

type GetQueryResultOutput struct {
	Body       string
	StatusCode int
}

type GetQuerySearchInput

type GetQuerySearchInput struct {
}

type GetQuerySearchOutput

type GetQuerySearchOutput struct {
	Body       string
	StatusCode int
}

type GetQuerySnippetInput

type GetQuerySnippetInput struct {
	QuerySnippetId int
}

type GetQuerySnippetOutput

type GetQuerySnippetOutput struct {
	Body       string
	StatusCode int
}

type GetQueryTagsInput

type GetQueryTagsInput struct {
}

type GetQueryTagsOutput

type GetQueryTagsOutput struct {
	Body       string
	StatusCode int
}

type GetUserInput

type GetUserInput struct {
	UserId int
}

type GetUserOutput

type GetUserOutput struct {
	Body       string
	StatusCode int
}

type IClient

type IClient interface {
	// client
	SetConfig(*Config)

	// alerts
	ListAlerts(*ListAlertsInput) *ListAlertsOutput
	GetAlert(*GetAlertInput) *GetAlertOutput
	ListAlertSubscriptions(*ListAlertSubscriptionsInput) *ListAlertSubscriptionsOutput

	// dashboards
	ListDashboards(*ListDashboardsInput) *ListDashboardsOutput
	GetDashboard(*GetDashboardInput) *GetDashboardOutput
	GetPublicDashboard(*GetPublicDashboardInput) *GetPublicDashboardOutput
	GetDashboardTags(*GetDashboardTagsInput) *GetDashboardTagsOutput

	// data_sources
	ListDataSources(*ListDataSourcesInput) *ListDataSourcesOutput
	CreateDataSource(*CreateDataSourceInput) *CreateDataSourceOutput
	ListDataSourcesTypes(*ListDataSourcesTypesInput) *ListDataSourcesTypesOutput
	GetDataSource(*GetDataSourceInput) *GetDataSourceOutput
	UpdateDataSource(*UpdateDataSourceInput) *UpdateDataSourceOutput
	DeleteDataSource(*DeleteDataSourceInput) *DeleteDataSourceOutput
	GetDataSourceSchema(*GetDataSourceSchemaInput) *GetDataSourceSchemaOutput
	PauseDataSource(*PauseDataSourceInput) *PauseDataSourceOutput
	UnpauseDataSource(*UnpauseDataSourceInput) *UnpauseDataSourceOutput
	TestDataSource(*TestDataSourceInput) *TestDataSourceOutput

	// destinations
	ListDestinations(*ListDestinationsInput) *ListDestinationsOutput
	GetDestination(*GetDestinationInput) *GetDestinationOutput
	ListDestinationTypes(*ListDestinationTypesInput) *ListDestinationTypesOutput

	// events
	GetEvents(*GetEventsInput) *GetEventsOutput

	// favorites
	ListQueryFavorites(*ListQueryFavoritesInput) *ListQueryFavoritesOutput
	ListDashboardFavorites(*ListDashboardFavoritesInput) *ListDashboardFavoritesOutput

	// groups
	ListGroups(*ListGroupsInput) *ListGroupsOutput
	GetGroup(*GetGroupInput) *GetGroupOutput
	ListGroupMembers(*ListGroupMembersInput) *ListGroupMembersOutput

	// queries
	ListQueries(*ListQueriesInput) *ListQueriesOutput
	GetQuery(*GetQueryInput) *GetQueryOutput
	GetQuerySearch(*GetQuerySearchInput) *GetQuerySearchOutput
	GetQueryRecent(*GetQueryRecentInput) *GetQueryRecentOutput
	GetMyQueries(*GetMyQueriesInput) *GetMyQueriesOutput
	GetQueryTags(*GetQueryTagsInput) *GetQueryTagsOutput
	CreateQuery(*CreateQueryInput) *CreateQueryOutput
	ModifyQuery(*ModifyQueryInput) *ModifyQueryOutput
	DeleteQuery(*DeleteQueryInput) *DeleteQueryOutput

	// query_results
	GetQueryResult(*GetQueryResultInput) *GetQueryResultOutput
	GetJob(*GetJobInput) *GetJobOutput

	// query_snippets
	ListQuerySnippets(*ListQuerySnippetsInput) *ListQuerySnippetsOutput
	GetQuerySnippet(*GetQuerySnippetInput) *GetQuerySnippetOutput

	// settings
	GetOrganizationSettings(*GetOrganizationSettingsInput) *GetOrganizationSettingsOutput

	// users
	ListUsers(*ListUsersInput) *ListUsersOutput
	GetUser(*GetUserInput) *GetUserOutput
}

type ListAlertSubscriptionsInput

type ListAlertSubscriptionsInput struct {
	AlertId int
}

type ListAlertSubscriptionsOutput

type ListAlertSubscriptionsOutput struct {
	Body       string
	StatusCode int
}

type ListAlertsInput

type ListAlertsInput struct {
}

type ListAlertsOutput

type ListAlertsOutput struct {
	Body       string
	StatusCode int
}

type ListDashboardFavoritesInput

type ListDashboardFavoritesInput struct {
}

type ListDashboardFavoritesOutput

type ListDashboardFavoritesOutput struct {
	Body       string
	StatusCode int
}

type ListDashboardsInput

type ListDashboardsInput struct {
}

type ListDashboardsOutput

type ListDashboardsOutput struct {
	Body       string
	StatusCode int
}

type ListDataSourcesInput

type ListDataSourcesInput struct {
}

GET /api/data_sources

type ListDataSourcesOutput

type ListDataSourcesOutput struct {
	Body       string
	StatusCode int
}

type ListDataSourcesTypesInput

type ListDataSourcesTypesInput struct {
}

GET /api/data_sources/types

type ListDataSourcesTypesOutput

type ListDataSourcesTypesOutput struct {
	Body       string
	StatusCode int
}

type ListDestinationTypesInput

type ListDestinationTypesInput struct {
}

type ListDestinationTypesOutput

type ListDestinationTypesOutput struct {
	Body       string
	StatusCode int
}

type ListDestinationsInput

type ListDestinationsInput struct {
}

type ListDestinationsOutput

type ListDestinationsOutput struct {
	Body       string
	StatusCode int
}

type ListGroupMembersInput

type ListGroupMembersInput struct {
	GroupId int
}

type ListGroupMembersOutput

type ListGroupMembersOutput struct {
	Body       string
	StatusCode int
}

type ListGroupsInput

type ListGroupsInput struct {
}

type ListGroupsOutput

type ListGroupsOutput struct {
	Body       string
	StatusCode int
}

type ListQueriesInput

type ListQueriesInput struct {
}

type ListQueriesOutput

type ListQueriesOutput struct {
	Body       string
	StatusCode int
}

type ListQueryFavoritesInput

type ListQueryFavoritesInput struct {
}

type ListQueryFavoritesOutput

type ListQueryFavoritesOutput struct {
	Body       string
	StatusCode int
}

type ListQuerySnippetsInput

type ListQuerySnippetsInput struct {
}

type ListQuerySnippetsOutput

type ListQuerySnippetsOutput struct {
	Body       string
	StatusCode int
}

type ListUsersInput

type ListUsersInput struct {
}

type ListUsersOutput

type ListUsersOutput struct {
	Body       string
	StatusCode int
}

type ModifyQueryInput

type ModifyQueryInput struct {
	QueryId      int    `json:"-"`
	DataSourceId int    `json:"data_source_id"`
	Query        string `json:"query"`
	Name         string `json:"name"`
	Description  string `json:"description,omitempty"`
	Schedule     string `json:"schedule,omitempty"`
}

type ModifyQueryOutput

type ModifyQueryOutput struct {
	Body       string
	StatusCode int
}

type PauseDataSourceInput

type PauseDataSourceInput struct {
	DataSourceId int    `json:"-"`
	Reason       string `json:"reason,omitempty"`
}

POST /api/data_sources/{data_source_id}/pause

type PauseDataSourceOutput

type PauseDataSourceOutput struct {
	Body       string
	StatusCode int
}

type TestDataSourceInput

type TestDataSourceInput struct {
	DataSourceId int
}

POST /api/data_sources/{data_source_id}/test

type TestDataSourceOutput

type TestDataSourceOutput struct {
	Body       string
	StatusCode int
}

type UnpauseDataSourceInput

type UnpauseDataSourceInput struct {
	DataSourceId int
}

DELETE /api/data_sources/{data_source_id}/pause

type UnpauseDataSourceOutput

type UnpauseDataSourceOutput struct {
	Body       string
	StatusCode int
}

type UpdateDataSourceInput

type UpdateDataSourceInput struct {
	DataSourceId int                           `json:"-"`
	Options      *UpdateDataSourceInputOptions `json:"options"`
	Name         string                        `json:"name"`
	Type         string                        `json:"type"`
}

POST /api/data_sources/{data_source_id}

type UpdateDataSourceInputOptions

type UpdateDataSourceInputOptions struct {
	Dbname string `json:"dbname"`
}

type UpdateDataSourceOutput

type UpdateDataSourceOutput struct {
	Body       string
	StatusCode int
}