spec

Documentation

Index

• Variables
• type Spec
  • func (s *Spec) SetDefaults()
  • func (s Spec) Validate() error
• type TableOptions
  • func (ts TableOptions) ForTable(name string) *TableOptionsSpec
• type TableOptionsSpec
  • func (to *TableOptionsSpec) GetAssociations() []string
  • func (to *TableOptionsSpec) GetProperties() []string

Variables

var JSONSchema string

Types

type Spec

type Spec struct {
	// In order for CloudQuery to sync resources from your HubSpot setup, you will need to authenticate with your HubSpot account. You will need to create a [HubSpot Private App](https://developers.hubspot.com/docs/api/private-apps), and copy the App Token here.
	// If not specified `HUBSPOT_APP_TOKEN` environment variable will be used instead.
	AppToken string `json:"app_token,omitempty" jsonschema:"minLength=1"`
	// Max number of requests per second to perform against the Hubspot API.
	MaxRequestsPerSecond int `json:"max_requests_per_second,omitempty" jsonschema:"minimum=1,default=5"`
	// Key-value map of options for each table. The key is the name of the table. The value is an options object.
	TableOptions TableOptions `json:"table_options,omitempty"`
	// Concurrency setting for the CloudQuery scheduler.
	Concurrency int `json:"concurrency,omitempty" jsonschema:"minimum=1,default=1000"`
}

func (*Spec) SetDefaults

func (s *Spec) SetDefaults()

func (Spec) Validate

func (s Spec) Validate() error

type TableOptions

type TableOptions map[string]*TableOptionsSpec

func (TableOptions) ForTable

func (ts TableOptions) ForTable(name string) *TableOptionsSpec

type TableOptionsSpec

type TableOptionsSpec struct {
	// List of properties to sync. If empty, everything is synced.
	Properties []string `json:"properties,omitempty" jsonschema:"minLength=1"`
	// List of associations to sync. If empty, everything is synced.
	Associations []string `json:"associations,omitempty" jsonschema:"minLength=1"`
}

Table options spec.

func (*TableOptionsSpec) GetAssociations

func (to *TableOptionsSpec) GetAssociations() []string

func (*TableOptionsSpec) GetProperties

func (to *TableOptionsSpec) GetProperties() []string