client

package

v0.2.0 Latest Latest Go to latest Published: May 22, 2020 License: MPL-2.0 Imports: 16 Imported by: 0

Documentation ¶

Index ¶

Variables
type Client
- func NewClient(customerID string, options ...Option) (*Client, error)
type Dataset
type DatasetConfig
type Field
type Option
type ResultStatus
- func (s *ResultStatus) Error() error
type Stage
type Transform
type TransformConfig
- func NewTransformConfig(inputs map[string]string, references, metadata map[string]string, ...) (*TransformConfig, error)
type Workspace

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrDatasetNotFound = errors.New("dataset not found")
)

View Source

var (
	ErrUnauthorized = errors.New("authorization error")
)

View Source

var (
	ErrWorkspaceNotFound = errors.New("workspace not found")
)

View Source

var FieldTypes = []string{
	"array",
	"bool",
	"float64",
	"int64",
	"object",
	"string",
	"timestamp",
}

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(customerID string, options ...Option) (*Client, error)

func (*Client) CreateDataset ¶

func (c *Client) CreateDataset(workspaceID string, config DatasetConfig) (*Dataset, error)

func (*Client) DeleteDataset ¶

func (c *Client) DeleteDataset(id string) error

DeleteDataset deletes dataset by ID.

func (*Client) GetDataset ¶

func (c *Client) GetDataset(id string) (*Dataset, error)

func (*Client) GetTransform ¶

func (c *Client) GetTransform(id string) (*Transform, error)

func (*Client) GetWorkspace ¶

func (c *Client) GetWorkspace(id string) (*Workspace, error)

func (*Client) ListDatasets ¶

func (c *Client) ListDatasets() (ds []*Dataset, err error)

ListDatasets retrieves all datasets across workspaces. No filtering provided for now.

func (*Client) ListWorkspaces ¶

func (c *Client) ListWorkspaces() ([]*Workspace, error)

func (*Client) LookupDataset ¶

func (c *Client) LookupDataset(workspaceID string, label string) (*Dataset, error)

func (*Client) Run ¶

func (c *Client) Run(reqBody string, vars map[string]interface{}) (map[string]interface{}, error)

Run raw GraphQL query against API

func (*Client) SetTransform ¶

func (c *Client) SetTransform(datasetID string, config *TransformConfig) (*Transform, error)

func (*Client) UpdateDataset ¶

func (c *Client) UpdateDataset(workspaceID string, ID string, config DatasetConfig) (*Dataset, error)

func (*Client) Verify ¶

func (c *Client) Verify() error

Verify checks if we can connect to API.

type Dataset ¶

type Dataset struct {
	WorkspaceID string        `json:"workspaceId"`
	ID          string        `json:"id"`
	Config      DatasetConfig `json:"config"`
}

Dataset is published within a workspace

type DatasetConfig ¶

type DatasetConfig struct {
	Name             string         `json:"name,omitempty"`
	FreshnessDesired *time.Duration `json:"freshnessDesired,omitempty"`
	IconURL          *string        `json:"iconUrl,omitempty"`

	// schema
	Fields []*Field `json:"fields,omitempty"`
}

DatasetConfig contains all the configurable elements of a dataset.

type Field ¶

type Field struct {
	Name string `json:"field,omitempty"`
	Type string `json:"type,omitempty"`

	ValidTo   bool `json:"valid_to,omitempty"`
	ValidFrom bool `json:"valid_from,omitempty"`
	Label     bool `json:"label,omitempty"`
}

type Option ¶ added in v0.2.0

type Option func(*Client) error

func WithDomain ¶ added in v0.2.0

func WithDomain(domain string) Option

WithDomain overrides domain name used

func WithHTTPClient ¶ added in v0.2.0

func WithHTTPClient(client *http.Client) Option

WithHTTPClient overrides default HTTP client

func WithInsecure ¶ added in v0.2.0

func WithInsecure() Option

WithInsecure sets HTTP client to not verify TLS requests Must be set after WithHTTPClient, if both options are present

func WithToken ¶ added in v0.2.0

func WithToken(token string) Option

WithToken sets bearer token

func WithUserCredentials ¶ added in v0.2.0

func WithUserCredentials(user, password string) Option

type ResultStatus ¶

type ResultStatus struct {
	Success      bool                   `json:"success"`
	ErrorMessage string                 `json:"errorMessage"`
	DetailedInfo map[string]interface{} `json:"detailedInfo"`
}

func (*ResultStatus) Error ¶

func (s *ResultStatus) Error() error

type Stage ¶

type Stage struct {
	Name     string `json:"name,omitempty"`
	Input    string `json:"input,omitempty"`
	Pipeline string `json:"pipeline,omitempty"`
}

Stage declares a source to operate on, and a pipeline to execute

type Transform ¶

type Transform struct {
	ID string `json:"id"`
	*TransformConfig
}

type TransformConfig ¶

type TransformConfig struct {
	Inputs     map[string]string `json:"inputs"`
	References map[string]string `json:"references"`
	Stages     []*Stage          `json:"stages"`
	Metadata   map[string]string
	// contains filtered or unexported fields
}

TransformConfig describes a sequence of stages

func NewTransformConfig ¶

func NewTransformConfig(inputs map[string]string, references, metadata map[string]string, stages ...*Stage) (*TransformConfig, error)

type Workspace ¶

type Workspace struct {
	ID    string `json:"id"`
	Label string `json:"label"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL