client

package
v0.14.42 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 5, 2025 License: MPL-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrUnauthorized         = errors.New("authorization error")
	ErrMissingCustomer      = errors.New("customer ID not set")
	ErrMissingDomain        = errors.New("domain not set")
	ErrTokenEmail           = errors.New("token and user email are mutually exclusive")
	ErrMissingPassword      = errors.New("password must be set when user email is provided")
	ErrMissingRetryDuration = errors.New("retry duration must be larger than 0")
	ErrMalformedSource      = errors.New("source identifier must follow \"category/comment\" format")
)
View Source 
var (
	ErrNotFound = errors.New("not found")
)

Functions

This section is empty.

Types

type Client 

type Client struct {
	*Config

	Meta    *meta.Client
	Rest    *rest.Client
	Collect *collect.Client
	// contains filtered or unexported fields
}

Client handles interacting with our API(s)

func New added in v0.13.14 

func New(c *Config) (*Client, error)

New returns a new client

func (*Client) ClearDefaultDashboard added in v0.13.14 

func (c *Client) ClearDefaultDashboard(ctx context.Context, dsid string) error

func (*Client) CreateApp added in v0.13.14 

func (c *Client) CreateApp(ctx context.Context, workspaceId string, input *meta.AppInput) (*meta.App, error)

CreateApp creates an app

func (*Client) CreateAppDataSource added in v0.13.14 

func (c *Client) CreateAppDataSource(ctx context.Context, input *meta.AppDataSourceInput) (*meta.AppDataSource, error)

CreateAppDataSource creates an appdatasource

func (*Client) CreateBoard added in v0.13.14 

func (c *Client) CreateBoard(ctx context.Context, dsid string, boardType meta.BoardType, input *meta.BoardInput) (*meta.Board, error)

CreateBoard creates a board

func (*Client) CreateBookmark added in v0.13.14 

func (c *Client) CreateBookmark(ctx context.Context, input *meta.BookmarkInput) (*meta.Bookmark, error)

CreateBookmark creates a bookmark group

func (*Client) CreateBookmarkGroup added in v0.13.14 

func (c *Client) CreateBookmarkGroup(ctx context.Context, workspaceId string, input *meta.BookmarkGroupInput) (*meta.BookmarkGroup, error)

CreateBookmarkGroup creates a bookmark group

func (*Client) CreateChannel added in v0.13.14 

func (c *Client) CreateChannel(ctx context.Context, workspaceId string, input *meta.ChannelInput, monitors []string) (*meta.Channel, error)

CreateChannel creates a channel

func (*Client) CreateChannelAction added in v0.13.14 

func (c *Client) CreateChannelAction(ctx context.Context, workspaceId string, input *meta.ActionInput, channels []string) (*meta.ChannelAction, error)

CreateChannelAction creates a channel action

func (*Client) CreateCorrelationTag added in v0.14.10 

func (c *Client) CreateCorrelationTag(ctx context.Context, dataset, tag string, path meta.LinkFieldInput) error

func (*Client) CreateDashboard added in v0.13.14 

func (c *Client) CreateDashboard(ctx context.Context, workspaceId string, input *meta.DashboardInput) (*meta.Dashboard, error)

func (*Client) CreateDatasetOutboundShare added in v0.14.1 

func (c *Client) CreateDatasetOutboundShare(ctx context.Context, workspaceId string, datasetId string, shareId string, input *meta.DatasetOutboundShareInput) (*meta.DatasetOutboundShare, error)

func (*Client) CreateDatastream added in v0.13.14 

func (c *Client) CreateDatastream(ctx context.Context, workspaceId string, input *meta.DatastreamInput) (*meta.Datastream, error)

CreateDatastream creates a datastream

func (*Client) CreateDatastreamToken added in v0.13.14 

func (c *Client) CreateDatastreamToken(ctx context.Context, datastreamId string, input *meta.DatastreamTokenInput, password *string) (*meta.DatastreamToken, error)

CreateDatastreamToken creates a datastream token

func (*Client) CreateFiledrop added in v0.13.15 

func (c *Client) CreateFiledrop(ctx context.Context, workspaceId string, datastreamId string, input *meta.FiledropInput) (*meta.Filedrop, error)

CreateFiledrop creates a filedrop

func (*Client) CreateFolder added in v0.13.14 

func (c *Client) CreateFolder(ctx context.Context, workspaceId string, input *meta.FolderInput) (*meta.Folder, error)

CreateFolder creates a folder

func (*Client) CreateForeignKey added in v0.13.14 

func (c *Client) CreateForeignKey(ctx context.Context, workspaceID string, input *meta.DeferredForeignKeyInput) (*meta.DeferredForeignKey, error)

CreateForeignKey

func (*Client) CreateIngestFilter added in v0.14.35 

func (c *Client) CreateIngestFilter(ctx context.Context, workspace string, input *meta.IngestFilterInput) (*meta.IngestFilter, error)

func (*Client) CreateIngestToken added in v0.14.37 

func (c *Client) CreateIngestToken(ctx context.Context, workspace string, input meta.IngestTokenInput) (*meta.IngestToken, error)

*

  • Ingest tokens

func (*Client) CreateLayeredSettingRecord added in v0.13.14 

func (c *Client) CreateLayeredSettingRecord(ctx context.Context, input *meta.LayeredSettingRecordInput) (*meta.LayeredSettingRecord, error)

func (*Client) CreateMonitor added in v0.13.14 

func (c *Client) CreateMonitor(ctx context.Context, workspaceId string, input *meta.MonitorInput) (*meta.Monitor, error)

CreateMonitor creates a monitor

func (*Client) CreateMonitorAction added in v0.13.14 

func (c *Client) CreateMonitorAction(ctx context.Context, input *meta.MonitorActionInput) (*meta.MonitorAction, error)

CreateMonitorAction creates a monitor action

func (*Client) CreateMonitorActionAttachment added in v0.13.14 

func (c *Client) CreateMonitorActionAttachment(ctx context.Context, input *meta.MonitorActionAttachmentInput) (*meta.MonitorActionAttachment, error)

CreateMonitorActionAttachment creates a monitor action attachment

func (*Client) CreateMonitorV2 added in v0.14.14 

func (c *Client) CreateMonitorV2(ctx context.Context, workspaceId string, input *meta.MonitorV2Input) (*meta.MonitorV2, error)

func (*Client) CreateMonitorV2Action added in v0.14.14 

func (c *Client) CreateMonitorV2Action(ctx context.Context, workspaceId string, input *meta.MonitorV2ActionInput) (*meta.MonitorV2Action, error)

func (*Client) CreatePoller added in v0.13.14 

func (c *Client) CreatePoller(ctx context.Context, workspaceId string, input *meta.PollerInput) (*meta.Poller, error)

CreatePoller creates a poller

func (*Client) CreatePreferredPath added in v0.13.14 

func (c *Client) CreatePreferredPath(ctx context.Context, workspaceId string, input *meta.PreferredPathInput) (*meta.PreferredPath, error)

CreatePreferredPath creates a preferred path

func (*Client) CreateRbacGroup added in v0.13.14 

func (c *Client) CreateRbacGroup(ctx context.Context, input *meta.RbacGroupInput) (*meta.RbacGroup, error)

CreateRbacGroup creates an rbacgroup

func (*Client) CreateRbacGroupmember added in v0.13.14 

func (c *Client) CreateRbacGroupmember(ctx context.Context, input *meta.RbacGroupmemberInput) (*meta.RbacGroupmember, error)

CreateRbacGroupmember creates an rbacgroupmember

func (*Client) CreateRbacStatement added in v0.13.14 

func (c *Client) CreateRbacStatement(ctx context.Context, input *meta.RbacStatementInput) (*meta.RbacStatement, error)

CreateRbacStatement creates an rbacstatement

func (*Client) CreateReferenceTable added in v0.14.28 

func (c *Client) CreateReferenceTable(ctx context.Context, input *rest.ReferenceTableInput) (*rest.ReferenceTable, error)

*

  • ReferenceTable

func (*Client) CreateReport added in v0.14.30 

func (c *Client) CreateReport(ctx context.Context, input *rest.ReportsDefinition) (result *rest.ReportsResource, err error)

*

  • Reports

func (*Client) CreateSnowflakeOutboundShare added in v0.14.1 

func (c *Client) CreateSnowflakeOutboundShare(ctx context.Context, workspaceId string, input *meta.SnowflakeOutboundShareInput) (*meta.SnowflakeOutboundShare, error)

func (*Client) CreateSourceDataset added in v0.13.14 

func (c *Client) CreateSourceDataset(ctx context.Context, workspaceId string, dataset *meta.DatasetDefinitionInput, table *meta.SourceTableDefinitionInput) (*meta.Dataset, error)

CreateSourceDataset creates a new source dataset

func (*Client) CreateWorksheet added in v0.13.14 

func (c *Client) CreateWorksheet(ctx context.Context, workspaceId string, input *meta.WorksheetInput) (*meta.Worksheet, error)

CreateWorksheet creates a worksheet

func (*Client) CreateWorkspace added in v0.13.14 

func (c *Client) CreateWorkspace(ctx context.Context, input *meta.WorkspaceInput) (*meta.Workspace, error)

CreateWorkspace creates a workspace

func (*Client) DeleteApp added in v0.13.14 

func (c *Client) DeleteApp(ctx context.Context, id string) error

DeleteApp

func (*Client) DeleteAppDataSource added in v0.13.14 

func (c *Client) DeleteAppDataSource(ctx context.Context, id string) error

DeleteAppDataSource

func (*Client) DeleteBoard added in v0.13.14 

func (c *Client) DeleteBoard(ctx context.Context, id string) error

DeleteBoard

func (*Client) DeleteBookmark added in v0.13.14 

func (c *Client) DeleteBookmark(ctx context.Context, id string) error

DeleteBookmark

func (*Client) DeleteBookmarkGroup added in v0.13.14 

func (c *Client) DeleteBookmarkGroup(ctx context.Context, id string) error

DeleteBookmarkGroup

func (*Client) DeleteChannel added in v0.13.14 

func (c *Client) DeleteChannel(ctx context.Context, id string) error

DeleteChannel

func (*Client) DeleteChannelAction added in v0.13.14 

func (c *Client) DeleteChannelAction(ctx context.Context, id string) error

DeleteChannelAction

func (*Client) DeleteCorrelationTag added in v0.14.10 

func (c *Client) DeleteCorrelationTag(ctx context.Context, dataset, tag string, path meta.LinkFieldInput) error

func (*Client) DeleteDashboard added in v0.13.14 

func (c *Client) DeleteDashboard(ctx context.Context, id string) error

func (*Client) DeleteDataset 

func (c *Client) DeleteDataset(ctx context.Context, id string) error

DeleteDataset by ID

func (*Client) DeleteDatasetOutboundShare added in v0.14.1 

func (c *Client) DeleteDatasetOutboundShare(ctx context.Context, id string) error

func (*Client) DeleteDatastream added in v0.13.14 

func (c *Client) DeleteDatastream(ctx context.Context, id string) error

DeleteDatastream

func (*Client) DeleteDatastreamToken added in v0.13.14 

func (c *Client) DeleteDatastreamToken(ctx context.Context, id string) error

DeleteDatastreamToken

func (*Client) DeleteFiledrop added in v0.13.15 

func (c *Client) DeleteFiledrop(ctx context.Context, id string) error

DeleteFiledrop deletes a filedrop

func (*Client) DeleteFolder added in v0.13.14 

func (c *Client) DeleteFolder(ctx context.Context, id string) error

DeleteFolder

func (*Client) DeleteForeignKey added in v0.13.14 

func (c *Client) DeleteForeignKey(ctx context.Context, id string) error

DeleteForeignKey

func (*Client) DeleteIngestFilter added in v0.14.35 

func (c *Client) DeleteIngestFilter(ctx context.Context, filterId string) error

func (*Client) DeleteIngestToken added in v0.14.37 

func (c *Client) DeleteIngestToken(ctx context.Context, id string) error

func (*Client) DeleteLayeredSettingRecord added in v0.13.14 

func (c *Client) DeleteLayeredSettingRecord(ctx context.Context, id string) error

func (*Client) DeleteMonitor added in v0.13.14 

func (c *Client) DeleteMonitor(ctx context.Context, id string) error

DeleteMonitor deletes a monitor

func (*Client) DeleteMonitorAction added in v0.13.14 

func (c *Client) DeleteMonitorAction(ctx context.Context, id string) error

DeleteMonitorAction deletes a monitor action

func (*Client) DeleteMonitorActionAttachment added in v0.13.14 

func (c *Client) DeleteMonitorActionAttachment(ctx context.Context, id string) error

DeleteMonitorActionAttachment deletes a monitor action attachment

func (*Client) DeleteMonitorV2 added in v0.14.14 

func (c *Client) DeleteMonitorV2(ctx context.Context, id string) error

func (*Client) DeleteMonitorV2Action added in v0.14.14 

func (c *Client) DeleteMonitorV2Action(ctx context.Context, id string) error

func (*Client) DeletePoller added in v0.13.14 

func (c *Client) DeletePoller(ctx context.Context, id string) error

DeletePoller

func (*Client) DeletePreferredPath added in v0.13.14 

func (c *Client) DeletePreferredPath(ctx context.Context, id string) error

DeletePreferredPath

func (*Client) DeleteRbacGroup added in v0.13.14 

func (c *Client) DeleteRbacGroup(ctx context.Context, id string) error

DeleteRbacGroup

func (*Client) DeleteRbacGroupmember added in v0.13.14 

func (c *Client) DeleteRbacGroupmember(ctx context.Context, id string) error

DeleteRbacGroupmember

func (*Client) DeleteRbacStatement added in v0.13.14 

func (c *Client) DeleteRbacStatement(ctx context.Context, id string) error

DeleteRbacStatement

func (*Client) DeleteReferenceTable added in v0.14.28 

func (c *Client) DeleteReferenceTable(ctx context.Context, id string) error

func (*Client) DeleteReport added in v0.14.30 

func (c *Client) DeleteReport(ctx context.Context, id string) (err error)

func (*Client) DeleteSnowflakeOutboundShare added in v0.14.1 

func (c *Client) DeleteSnowflakeOutboundShare(ctx context.Context, id string) error

func (*Client) DeleteWorksheet added in v0.13.14 

func (c *Client) DeleteWorksheet(ctx context.Context, id string) error

DeleteWorksheet

func (*Client) DeleteWorkspace added in v0.13.14 

func (c *Client) DeleteWorkspace(ctx context.Context, id string) error

DeleteWorkspace

func (*Client) GetApp added in v0.13.14 

func (c *Client) GetApp(ctx context.Context, id string) (*meta.App, error)

GetApp by ID

func (*Client) GetAppDataSource added in v0.13.14 

func (c *Client) GetAppDataSource(ctx context.Context, id string) (*meta.AppDataSource, error)

GetAppDataSource by ID

func (*Client) GetBoard added in v0.13.14 

func (c *Client) GetBoard(ctx context.Context, id string) (*meta.Board, error)

GetBoard returns board by ID

func (*Client) GetBookmark added in v0.13.14 

func (c *Client) GetBookmark(ctx context.Context, id string) (*meta.Bookmark, error)

GetBookmark returns bookmark by ID

func (*Client) GetBookmarkGroup added in v0.13.14 

func (c *Client) GetBookmarkGroup(ctx context.Context, id string) (*meta.BookmarkGroup, error)

GetBookmarkGroup returns bookmarkGroup by ID

func (*Client) GetChannel added in v0.13.14 

func (c *Client) GetChannel(ctx context.Context, id string) (*meta.Channel, error)

GetChannel returns channel by ID

func (*Client) GetChannelAction added in v0.13.14 

func (c *Client) GetChannelAction(ctx context.Context, id string) (*meta.ChannelAction, error)

GetChannelAction returns channelAction by ID

func (*Client) GetCloudInfo added in v0.14.13 

func (c *Client) GetCloudInfo(ctx context.Context) (*meta.CloudInfo, error)

func (*Client) GetDashboard added in v0.13.14 

func (c *Client) GetDashboard(ctx context.Context, id string) (*meta.Dashboard, error)

func (*Client) GetDataset 

func (c *Client) GetDataset(ctx context.Context, id string) (*meta.Dataset, error)

GetDataset returns dataset by ID

func (*Client) GetDatasetOutboundShare added in v0.14.1 

func (c *Client) GetDatasetOutboundShare(ctx context.Context, id string) (*meta.DatasetOutboundShare, error)

func (*Client) GetDatastream added in v0.13.14 

func (c *Client) GetDatastream(ctx context.Context, id string) (*meta.Datastream, error)

GetDatastream by ID

func (*Client) GetDatastreamToken added in v0.13.14 

func (c *Client) GetDatastreamToken(ctx context.Context, id string) (*meta.DatastreamToken, error)

GetDatastreamToken by ID

func (*Client) GetDefaultDashboard added in v0.13.14 

func (c *Client) GetDefaultDashboard(ctx context.Context, dsid string) (*string, error)

func (*Client) GetFiledrop added in v0.13.15 

func (c *Client) GetFiledrop(ctx context.Context, id string) (*meta.Filedrop, error)

GetFiledrop returns a filedrop by ID

func (*Client) GetFolder added in v0.13.14 

func (c *Client) GetFolder(ctx context.Context, id string) (*meta.Folder, error)

GetFolder by ID

func (*Client) GetForeignKey added in v0.13.14 

func (c *Client) GetForeignKey(ctx context.Context, id string) (*meta.DeferredForeignKey, error)

GetForeignKey returns deferred foreign key

func (*Client) GetIngestFilter added in v0.14.35 

func (c *Client) GetIngestFilter(ctx context.Context, filterId string) (*meta.IngestFilter, error)

func (*Client) GetIngestInfo added in v0.14.10 

func (c *Client) GetIngestInfo(ctx context.Context) (*meta.IngestInfo, error)

func (*Client) GetIngestToken added in v0.14.37 

func (c *Client) GetIngestToken(ctx context.Context, id string) (*meta.IngestToken, error)

func (*Client) GetLayeredSettingRecord added in v0.13.14 

func (c *Client) GetLayeredSettingRecord(ctx context.Context, id string) (*meta.LayeredSettingRecord, error)

func (*Client) GetMonitor added in v0.13.14 

func (c *Client) GetMonitor(ctx context.Context, id string) (*meta.Monitor, error)

GetMonitor returns monitor by ID

func (*Client) GetMonitorAction added in v0.13.14 

func (c *Client) GetMonitorAction(ctx context.Context, id string) (*meta.MonitorAction, error)

GetMonitorAction returns a monitor action by ID

func (*Client) GetMonitorActionAttachment added in v0.13.14 

func (c *Client) GetMonitorActionAttachment(ctx context.Context, id string) (*meta.MonitorActionAttachment, error)

GetMonitorActionAttachment returns a monitor action attachment by ID

func (*Client) GetMonitorV2 added in v0.14.14 

func (c *Client) GetMonitorV2(ctx context.Context, id string) (*meta.MonitorV2, error)

func (*Client) GetMonitorV2Action added in v0.14.14 

func (c *Client) GetMonitorV2Action(ctx context.Context, id string) (*meta.MonitorV2Action, error)

func (*Client) GetPoller added in v0.13.14 

func (c *Client) GetPoller(ctx context.Context, id string) (*meta.Poller, error)

GetPoller returns a poller by ID

func (*Client) GetPreferredPath added in v0.13.14 

func (c *Client) GetPreferredPath(ctx context.Context, id string) (*meta.PreferredPath, error)

GetPreferredPath gets the preferred path by ID. If the path is invalid, an error may be returned in addition to the path object.

func (*Client) GetRbacDefaultGroup added in v0.13.14 

func (c *Client) GetRbacDefaultGroup(ctx context.Context) (*meta.RbacGroup, error)

GetRbacDefaultGroup

func (*Client) GetRbacDefaultSharingGroups added in v0.14.30 

func (c *Client) GetRbacDefaultSharingGroups(ctx context.Context) ([]meta.RbacDefaultSharingGroup, error)

func (*Client) GetRbacGroup added in v0.13.14 

func (c *Client) GetRbacGroup(ctx context.Context, id string) (*meta.RbacGroup, error)

GetRbacGroup by ID

func (*Client) GetRbacGroupmember added in v0.13.14 

func (c *Client) GetRbacGroupmember(ctx context.Context, id string) (*meta.RbacGroupmember, error)

GetRbacGroupmember by ID

func (*Client) GetRbacResourceStatements added in v0.14.23 

func (c *Client) GetRbacResourceStatements(ctx context.Context, ids []string) ([]meta.RbacStatement, error)

GetRbacResourceStatements gets all statements for the given objects

func (*Client) GetRbacStatement added in v0.13.14 

func (c *Client) GetRbacStatement(ctx context.Context, id string) (*meta.RbacStatement, error)

GetRbacStatement by ID

func (*Client) GetReferenceTable added in v0.14.28 

func (c *Client) GetReferenceTable(ctx context.Context, id string) (*rest.ReferenceTable, error)

func (*Client) GetReport added in v0.14.30 

func (c *Client) GetReport(ctx context.Context, id string) (*rest.ReportsResource, error)

func (*Client) GetSnowflakeOutboundShare added in v0.14.1 

func (c *Client) GetSnowflakeOutboundShare(ctx context.Context, id string) (*meta.SnowflakeOutboundShare, error)

func (*Client) GetSourceDataset added in v0.13.14 

func (c *Client) GetSourceDataset(ctx context.Context, id string) (*meta.Dataset, error)

GetDataset returns the source dataset by ID

func (*Client) GetTerraform added in v0.13.14 

func (c *Client) GetTerraform(ctx context.Context, id string, objType meta.TerraformObjectType) (*meta.TerraformDefinition, error)

GetTerraform returns terraform definition

func (*Client) GetUser added in v0.13.14 

func (c *Client) GetUser(ctx context.Context, id string) (*meta.User, error)

GetUser by ID

func (*Client) GetWorksheet added in v0.13.14 

func (c *Client) GetWorksheet(ctx context.Context, id string) (*meta.Worksheet, error)

GetWorksheet by ID

func (*Client) GetWorkspace 

func (c *Client) GetWorkspace(ctx context.Context, id string) (*meta.Workspace, error)

GetWorkspace by ID

func (*Client) IsCorrelationTagPresent added in v0.14.10 

func (c *Client) IsCorrelationTagPresent(ctx context.Context, dataset, tag string, path meta.LinkFieldInput) (bool, error)

func (*Client) ListDatasetsIdNameOnly added in v0.14.19 

func (c *Client) ListDatasetsIdNameOnly(ctx context.Context) ([]*meta.DatasetIdName, error)

List all datasets, but only asks for id and name to prevent looping in expensive resolvers

func (*Client) ListUsers added in v0.14.19 

func (c *Client) ListUsers(ctx context.Context) ([]meta.User, error)

List all users in current customer

func (*Client) ListWorksheetIdLabelOnly added in v0.14.19 

func (c *Client) ListWorksheetIdLabelOnly(ctx context.Context, workspaceId string) ([]*meta.WorksheetIdLabel, error)

List all worksheets, but only fetch ids and labels to prevent using expensive resolvers

func (*Client) ListWorkspaces 

func (c *Client) ListWorkspaces(ctx context.Context) (workspaces []*meta.Workspace, err error)

ListWorkspaces.

func (*Client) LookupApp added in v0.13.14 

func (c *Client) LookupApp(ctx context.Context, workspaceID string, name string) (*meta.App, error)

LookupApp by name.

func (*Client) LookupDataset 

func (c *Client) LookupDataset(ctx context.Context, workspaceID string, name string) (*meta.Dataset, error)

LookupDataset by name.

func (*Client) LookupDatastream added in v0.13.14 

func (c *Client) LookupDatastream(ctx context.Context, workspaceID string, name string) (*meta.Datastream, error)

LookupDatastream by name.

func (*Client) LookupFolder added in v0.13.14 

func (c *Client) LookupFolder(ctx context.Context, workspaceID string, name string) (*meta.Folder, error)

LookupFolder by name.

func (*Client) LookupForeignKey added in v0.13.14 

func (c *Client) LookupForeignKey(ctx context.Context, source string, target string, srcFields []string, dstFields []string) (*meta.DatasetForeignKeysForeignKey, error)

LookupForeignKey by source, target and fields

func (*Client) LookupModuleVersions added in v0.13.14 

func (c *Client) LookupModuleVersions(ctx context.Context, id string) ([]*meta.ModuleVersion, error)

func (*Client) LookupMonitor added in v0.13.14 

func (c *Client) LookupMonitor(ctx context.Context, workspaceId string, id string) (*meta.Monitor, error)

LookupMonitor returns monitor by name

func (*Client) LookupMonitorAction added in v0.14.10 

func (c *Client) LookupMonitorAction(ctx context.Context, workspaceID string, name string) (*meta.MonitorAction, error)

func (*Client) LookupMonitorV2 added in v0.14.14 

func (c *Client) LookupMonitorV2(ctx context.Context, workspaceId *string, nameExact *string) (*meta.MonitorV2, error)

func (*Client) LookupRbacGroup added in v0.13.14 

func (c *Client) LookupRbacGroup(ctx context.Context, name string) (*meta.RbacGroup, error)

LookupRbacGroup by name.

func (*Client) LookupReferenceTable added in v0.14.28 

func (c *Client) LookupReferenceTable(ctx context.Context, label string) (*rest.ReferenceTable, error)

func (*Client) LookupUser added in v0.13.14 

func (c *Client) LookupUser(ctx context.Context, email string) (*meta.User, error)

LookupUser by email.

func (*Client) LookupWorkspace added in v0.13.14 

func (c *Client) LookupWorkspace(ctx context.Context, name string) (*meta.Workspace, error)

LookupWorkspace by name.

func (*Client) MutateRbacStatements added in v0.14.23 

func (c *Client) MutateRbacStatements(ctx context.Context, toCreate []meta.RbacStatementInput, toUpdate []meta.UpdateRbacStatementInput, toDelete []string) (*meta.MutateRbacStatementsResponse, error)

MutateRbacStatements

func (*Client) Observe added in v0.13.14 

func (c *Client) Observe(ctx context.Context, path string, body io.Reader, tags map[string]string, options ...func(*http.Request)) error

Observe submits observations

func (*Client) Query added in v0.13.14 

func (c *Client) Query(ctx context.Context, stages []*meta.StageInput, params *meta.QueryParams) (result []*meta.TaskResult, err error)

Query for result

func (*Client) SaveDataset added in v0.13.14 

func (c *Client) SaveDataset(ctx context.Context, wsid string, input *meta.DatasetInput, queryInput *meta.MultiStageQueryInput, dependencyHandling *meta.DependencyHandlingInput) (*meta.Dataset, error)

func (*Client) SaveDatasetDryRun added in v0.14.30 

func (c *Client) SaveDatasetDryRun(ctx context.Context, wsid string, input *meta.DatasetInput, queryInput *meta.MultiStageQueryInput) ([]meta.DatasetMaterialization, error)

func (*Client) SaveMonitorV2Relations added in v0.14.15 

func (c *Client) SaveMonitorV2Relations(ctx context.Context, monitorId string, actionRelations []meta.ActionRelationInput) (*meta.MonitorV2, error)

func (*Client) SaveMonitorV2WithActions added in v0.14.23 

func (c *Client) SaveMonitorV2WithActions(
	ctx context.Context,
	workspaceId string,
	monitorId *string,
	input *meta.MonitorV2Input,
	actions []meta.MonitorV2ActionAndRelationInput,
) (*meta.MonitorV2, error)

func (*Client) SearchMonitorV2Action added in v0.14.15 

func (c *Client) SearchMonitorV2Action(ctx context.Context, workspaceId *string, nameExact *string) ([]meta.MonitorV2Action, error)

func (*Client) SetDefaultDashboard added in v0.13.14 

func (c *Client) SetDefaultDashboard(ctx context.Context, dsid string, dashid string) error

func (*Client) SetRbacDefaultGroup added in v0.13.14 

func (c *Client) SetRbacDefaultGroup(ctx context.Context, id string) error

SetRbacDefaultGroup

func (*Client) SetRbacDefaultSharingGroups added in v0.14.30 

func (c *Client) SetRbacDefaultSharingGroups(ctx context.Context, input []meta.RbacDefaultSharingGroupInput) error

func (*Client) UnsetRbacDefaultGroup added in v0.13.14 

func (c *Client) UnsetRbacDefaultGroup(ctx context.Context) error

UnsetRbacDefaultGroup

func (*Client) UpdateApp added in v0.13.14 

func (c *Client) UpdateApp(ctx context.Context, id string, input *meta.AppInput) (*meta.App, error)

UpdateApp updates a app

func (*Client) UpdateAppDataSource added in v0.13.14 

func (c *Client) UpdateAppDataSource(ctx context.Context, id string, input *meta.AppDataSourceInput) (*meta.AppDataSource, error)

UpdateAppDataSource updates an appdatasource

func (*Client) UpdateBoard added in v0.13.14 

func (c *Client) UpdateBoard(ctx context.Context, id string, input *meta.BoardInput) (*meta.Board, error)

UpdateBoard updates a board

func (*Client) UpdateBookmark added in v0.13.14 

func (c *Client) UpdateBookmark(ctx context.Context, id string, input *meta.BookmarkInput) (*meta.Bookmark, error)

UpdateBookmark updates a bookmark

func (*Client) UpdateBookmarkGroup added in v0.13.14 

func (c *Client) UpdateBookmarkGroup(ctx context.Context, id string, input *meta.BookmarkGroupInput) (*meta.BookmarkGroup, error)

UpdateBookmarkGroup updates a bookmark group

func (*Client) UpdateChannel added in v0.13.14 

func (c *Client) UpdateChannel(ctx context.Context, id string, input *meta.ChannelInput, monitors []string) (*meta.Channel, error)

UpdateChannel updates a channel

func (*Client) UpdateChannelAction added in v0.13.14 

func (c *Client) UpdateChannelAction(ctx context.Context, id string, input *meta.ActionInput, channels []string) (*meta.ChannelAction, error)

UpdateChannelAction updates a channel action

func (*Client) UpdateDashboard added in v0.13.14 

func (c *Client) UpdateDashboard(ctx context.Context, id string, workspaceId string, input *meta.DashboardInput) (*meta.Dashboard, error)

XXX: this should not have to take workspaceId, but API forces us to

func (*Client) UpdateDatasetOutboundShare added in v0.14.1 

func (c *Client) UpdateDatasetOutboundShare(ctx context.Context, id string, input *meta.DatasetOutboundShareInput) (*meta.DatasetOutboundShare, error)

func (*Client) UpdateDatastream added in v0.13.14 

func (c *Client) UpdateDatastream(ctx context.Context, id string, input *meta.DatastreamInput) (*meta.Datastream, error)

UpdateDatastream updates a datastream

func (*Client) UpdateDatastreamToken added in v0.13.14 

func (c *Client) UpdateDatastreamToken(ctx context.Context, id string, input *meta.DatastreamTokenInput) (*meta.DatastreamToken, error)

UpdateDatastreamToken updates a datastream

func (*Client) UpdateFiledrop added in v0.13.15 

func (c *Client) UpdateFiledrop(ctx context.Context, id string, input *meta.FiledropInput) (*meta.Filedrop, error)

UpdateFiledrop updates a filedrop

func (*Client) UpdateFolder added in v0.13.14 

func (c *Client) UpdateFolder(ctx context.Context, id string, input *meta.FolderInput) (*meta.Folder, error)

UpdateFolder updates a folder

func (*Client) UpdateForeignKey added in v0.13.14 

func (c *Client) UpdateForeignKey(ctx context.Context, id string, input *meta.DeferredForeignKeyInput) (*meta.DeferredForeignKey, error)

UpdateForeignKey by ID

func (*Client) UpdateIngestFilter added in v0.14.35 

func (c *Client) UpdateIngestFilter(ctx context.Context, filterId string, input *meta.IngestFilterInput) (*meta.IngestFilter, error)

func (*Client) UpdateIngestToken added in v0.14.37 

func (c *Client) UpdateIngestToken(ctx context.Context, id string, input meta.IngestTokenInput) (*meta.IngestToken, error)

func (*Client) UpdateLayeredSettingRecord added in v0.13.14 

func (c *Client) UpdateLayeredSettingRecord(ctx context.Context, input *meta.LayeredSettingRecordInput) (*meta.LayeredSettingRecord, error)

func (*Client) UpdateMonitor added in v0.13.14 

func (c *Client) UpdateMonitor(ctx context.Context, id string, input *meta.MonitorInput) (*meta.Monitor, error)

UpdateMonitor updates a monitor

func (*Client) UpdateMonitorAction added in v0.13.14 

func (c *Client) UpdateMonitorAction(ctx context.Context, id string, input *meta.MonitorActionInput) (*meta.MonitorAction, error)

UpdateMonitorAction updates a monitor action

func (*Client) UpdateMonitorActionAttachment added in v0.13.14 

func (c *Client) UpdateMonitorActionAttachment(ctx context.Context, id string, input *meta.MonitorActionAttachmentInput) (*meta.MonitorActionAttachment, error)

UpdateMonitorActionAttachment updates a monitor action attachment

func (*Client) UpdateMonitorV2 added in v0.14.14 

func (c *Client) UpdateMonitorV2(ctx context.Context, id string, input *meta.MonitorV2Input) (*meta.MonitorV2, error)

func (*Client) UpdateMonitorV2Action added in v0.14.14 

func (c *Client) UpdateMonitorV2Action(ctx context.Context, id string, input *meta.MonitorV2ActionInput) (*meta.MonitorV2Action, error)

func (*Client) UpdatePoller added in v0.13.14 

func (c *Client) UpdatePoller(ctx context.Context, id string, input *meta.PollerInput) (*meta.Poller, error)

UpdatePoller updates a poller

func (*Client) UpdatePreferredPath added in v0.13.14 

func (c *Client) UpdatePreferredPath(ctx context.Context, id string, input *meta.PreferredPathInput) (*meta.PreferredPath, error)

UpdatePreferredPath updates a preferred path

func (*Client) UpdateRbacGroup added in v0.13.14 

func (c *Client) UpdateRbacGroup(ctx context.Context, id string, input *meta.RbacGroupInput) (*meta.RbacGroup, error)

UpdateRbacGroup updates an rbacgroup

func (*Client) UpdateRbacStatement added in v0.13.14 

func (c *Client) UpdateRbacStatement(ctx context.Context, id string, input *meta.RbacStatementInput) (*meta.RbacStatement, error)

UpdateRbacStatement updates an rbacstatement

func (*Client) UpdateReferenceTable added in v0.14.28 

func (c *Client) UpdateReferenceTable(ctx context.Context, id string, input *rest.ReferenceTableInput) (*rest.ReferenceTable, error)

func (*Client) UpdateReferenceTableMetadata added in v0.14.28 

func (c *Client) UpdateReferenceTableMetadata(ctx context.Context, id string, input *rest.ReferenceTableMetadataInput) (*rest.ReferenceTable, error)

func (*Client) UpdateReport added in v0.14.30 

func (c *Client) UpdateReport(ctx context.Context, id string, input *rest.ReportsDefinition) (result *rest.ReportsResource, err error)

func (*Client) UpdateSnowflakeOutboundShare added in v0.14.1 

func (c *Client) UpdateSnowflakeOutboundShare(ctx context.Context, id string, input *meta.SnowflakeOutboundShareInput) (*meta.SnowflakeOutboundShare, error)

func (*Client) UpdateSourceDataset added in v0.13.14 

func (c *Client) UpdateSourceDataset(ctx context.Context, workspaceId string, id string, dataset *meta.DatasetDefinitionInput, table *meta.SourceTableDefinitionInput) (*meta.Dataset, error)

UpdateSourceDataset updates the existing source dataset

func (*Client) UpdateWorksheet added in v0.13.14 

func (c *Client) UpdateWorksheet(ctx context.Context, id string, workspaceId string, input *meta.WorksheetInput) (*meta.Worksheet, error)

UpdateWorksheet updates a worksheet XXX: this should not have to take workspaceId, but API forces us to

func (*Client) UpdateWorkspace added in v0.13.14 

func (c *Client) UpdateWorkspace(ctx context.Context, id string, input *meta.WorkspaceInput) (*meta.Workspace, error)

UpdateWorkspace updates a workspace

type Config added in v0.13.14 

type Config struct {
	CustomerID string `json:"customer_id"`
	Domain     string `json:"domain"`

	// auth
	UserAgent    *string `json:"user_agent"`
	ApiToken     *string `json:"api_token"`
	UserEmail    *string `json:"user_email"`
	UserPassword *string `json:"user_password"`

	// client options
	Insecure bool `json:"insecure"`

	RetryCount int           `json:"retry_count"`
	RetryWait  time.Duration `json:"retry_wait"`

	HTTPClientTimeout time.Duration `json:"http_timeout"`
	Flags             map[string]bool

	// optional source identifier when managing Observe resources
	Source *string `json:"source"`

	// optional managing id to tag Observe resources with
	ManagingObjectID *string `json:"managing_object_id"`

	// optional traceparent identifier to pass via header
	TraceParent *string `json:"traceparent"`

	// enable extra queries needed to export bindings
	ExportObjectBindings bool `json:"export_object_bindings"`
}

Config contains all configuration attributes for our client.

Clients sharing a same config may end up using the same underlying HTTP client in order to reuse connections more efficiently. We use Hash() to cache clients. Do not introduce private fields to this struct without adjusting how the hash function is computed.

func (*Config) Hash added in v0.13.14 

func (c *Config) Hash() uint64

func (*Config) Validate added in v0.13.14 

func (c *Config) Validate() error

type RoundTripperFunc added in v0.13.14 

type RoundTripperFunc func(*http.Request) (*http.Response, error)

RoundTripperFunc implements http.RoundTripper

func (RoundTripperFunc) RoundTrip added in v0.13.14 

func (r RoundTripperFunc) RoundTrip(req *http.Request) (*http.Response, error)

Source Files

View all Source files

Directories

Path Synopsis
internal
collect
types

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.