models

Documentation

Index

• Variables
• func InitItsiApiLimiter(concurrency int)
• func NewCache(size int) *resourceCache
• func NilTemplateMarshal(b *Base) (string, error)
• type Base
  • func NewBase(clientConfig ClientConfig, key, id, objectType string) *Base
  • func (b *Base) Clone() *Base
  • func (b *Base) Create(ctx context.Context) (*Base, error)
  • func (b *Base) Delete(ctx context.Context) error
  • func (b *Base) Dump(ctx context.Context, offset, count int) ([]*Base, error)
  • func (b *Base) Find(ctx context.Context) (result *Base, err error)
  • func (b *Base) GetPageSize() int
  • func (b *Base) Populate(raw []byte) error
  • func (b *Base) PopulateRawJSON(ctx context.Context, body map[string]interface{}) error
  • func (b *Base) Read(ctx context.Context) (*Base, error)
  • func (b *Base) Update(ctx context.Context) error
  • func (b *Base) UpdateAsync(ctx context.Context) error
• type ClientConfig
• type CollectionApi
  • func NewCollection(clientConfig ClientConfig, collection, app, owner, key, objectType string) *CollectionApi
  • func (c *CollectionApi) Create(ctx context.Context) (*CollectionApi, error)
  • func (c *CollectionApi) Delete(ctx context.Context) (*CollectionApi, error)
  • func (c *CollectionApi) Marshal(obj interface{}) (bytes []byte, err error)
  • func (c *CollectionApi) Read(ctx context.Context) (*CollectionApi, error)
  • func (c *CollectionApi) SetCodeHandle(code int, instruction util.HandleCode)
  • func (c *CollectionApi) Unmarshal(bytes []byte) (res interface{}, err error)
  • func (c *CollectionApi) Update(ctx context.Context) (*CollectionApi, error)
• type HttpClients
  • func (hc *HttpClients) Get(config ClientConfig) IHttpClient
• type IHttpClient
• type IHttpClients
  • func InitHttpClients() IHttpClients
• type RESTKeyByTFID
  • func NewRESTKeyByTFID() *RESTKeyByTFID
  • func (m *RESTKeyByTFID) Get(RestInterface, ObjectType, TFID string) (RESTKey string)
  • func (m *RESTKeyByTFID) Update(RestInterface, ObjectType, TFID string, RESTKey string)
• type RawJson
  • func (rj RawJson) MarshalJSON() ([]byte, error)
  • func (rj RawJson) ToInterfaceMap() (m map[string]interface{}, err error)
  • func (rj *RawJson) UnmarshalJSON(data []byte) error

Variables

var Cache *resourceCache

var CollectionApiConfigs map[string]collectionApiConfig

var GenerateResourceKey = func() (string, error) {
	return uuid.GenerateUUID()
}

var RestConfigs map[string]restConfig

var Verbose bool = false

Functions

func InitItsiApiLimiter

func InitItsiApiLimiter(concurrency int)

func NewCache

func NewCache(size int) *resourceCache

func NilTemplateMarshal

func NilTemplateMarshal(b *Base) (string, error)

Types

type Base

type Base struct {
	Splunk ClientConfig

	// key used to collect this resource via the REST API
	RESTKey string
	// Terraform Identifier
	TFID    string
	RawJson RawJson
	Fields  []string
	Hash    string
	// contains filtered or unexported fields
}

func NewBase

func NewBase(clientConfig ClientConfig, key, id, objectType string) *Base

func (*Base) Clone

func (b *Base) Clone() *Base

func (*Base) Create

func (b *Base) Create(ctx context.Context) (*Base, error)

func (*Base) Delete

func (b *Base) Delete(ctx context.Context) error

func (*Base) Dump

func (b *Base) Dump(ctx context.Context, offset, count int) ([]*Base, error)

func (*Base) Find

func (b *Base) Find(ctx context.Context) (result *Base, err error)

Returns an object from cache if it's present, or makes the relevant API calls..

func (*Base) GetPageSize

func (b *Base) GetPageSize() int

func (*Base) Populate

func (b *Base) Populate(raw []byte) error

func (*Base) PopulateRawJSON

func (b *Base) PopulateRawJSON(ctx context.Context, body map[string]interface{}) error

func (*Base) Read

func (b *Base) Read(ctx context.Context) (*Base, error)

func (*Base) Update

func (b *Base) Update(ctx context.Context) error

func (*Base) UpdateAsync

func (b *Base) UpdateAsync(ctx context.Context) error

type ClientConfig

type ClientConfig struct {
	BearerToken string
	User        string
	Password    string
	Host        string
	Port        int
	SkipTLS     bool
	Concurrency int
	Timeout     int
	RetryPolicy backoff.Policy
}

type CollectionApi

type CollectionApi struct {
	RESTKey              string                  // key used to collect this resource via the REST API
	Collection           string                  // Collection name
	App                  string                  // Collection App
	Owner                string                  // Collection owner
	Data                 map[string]interface{}  // Data for this object
	Params               string                  // URL query string, iff provided
	Body                 []byte                  // Body used for this API call
	CustomBehaviourCodes map[int]util.HandleCode // Common unretriable errors
	// contains filtered or unexported fields
}

func NewCollection

func NewCollection(clientConfig ClientConfig, collection, app, owner, key, objectType string) *CollectionApi

func (*CollectionApi) Create

func (c *CollectionApi) Create(ctx context.Context) (*CollectionApi, error)

func (*CollectionApi) Delete

func (c *CollectionApi) Delete(ctx context.Context) (*CollectionApi, error)

func (*CollectionApi) Marshal

func (c *CollectionApi) Marshal(obj interface{}) (bytes []byte, err error)

func (*CollectionApi) Read

func (c *CollectionApi) Read(ctx context.Context) (*CollectionApi, error)

func (*CollectionApi) SetCodeHandle

func (c *CollectionApi) SetCodeHandle(code int, instruction util.HandleCode)

func (*CollectionApi) Unmarshal

func (c *CollectionApi) Unmarshal(bytes []byte) (res interface{}, err error)

func (*CollectionApi) Update

func (c *CollectionApi) Update(ctx context.Context) (*CollectionApi, error)

type HttpClients

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

func (*HttpClients) Get

func (hc *HttpClients) Get(config ClientConfig) IHttpClient

type IHttpClient

type IHttpClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type IHttpClients

type IHttpClients interface {
	Get(config ClientConfig) IHttpClient
}

func InitHttpClients

func InitHttpClients() IHttpClients

type RESTKeyByTFID

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

func NewRESTKeyByTFID

func NewRESTKeyByTFID() *RESTKeyByTFID

func (*RESTKeyByTFID) Get

func (m *RESTKeyByTFID) Get(RestInterface, ObjectType, TFID string) (RESTKey string)

func (*RESTKeyByTFID) Update

func (m *RESTKeyByTFID) Update(RestInterface, ObjectType, TFID string, RESTKey string)

type RawJson

type RawJson json.RawMessage

func (RawJson) MarshalJSON

func (rj RawJson) MarshalJSON() ([]byte, error)

func (RawJson) ToInterfaceMap

func (rj RawJson) ToInterfaceMap() (m map[string]interface{}, err error)

func (*RawJson) UnmarshalJSON

func (rj *RawJson) UnmarshalJSON(data []byte) error