api

package

v0.0.0-...-d4916f2 Latest Latest Go to latest Published: Jan 18, 2024 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/evertoncolling/poc-requests-go

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type ClientConfig
type CogniteClient
- func NewCogniteClient(clientConfig ClientConfig) CogniteClient
type CredentialProvider
type OAuthClientCredentials
- func AzureADClientCredentials(clientId string, clientSecret string, tenantId string, cluster string) OAuthClientCredentials
- func (m OAuthClientCredentials) FetchToken() string
type TimeSeries
type Token
- func (t Token) FetchToken() string
type Units
- func (u *Units) List() (dto.UnitList, error)

Constants ¶

View Source

const (
	VERSION = "0.0.1"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ClientConfig ¶

type ClientConfig struct {
	ClientName  string
	Cluster     string
	Project     string
	Credentials CredentialProvider
}

type CogniteClient ¶

type CogniteClient struct {
	ClientConfig ClientConfig
	AccessToken  string
	BaseURL      string
	Headers      map[string]string
	TimeSeries   TimeSeries
	Units        Units
}

func NewCogniteClient ¶

func NewCogniteClient(clientConfig ClientConfig) CogniteClient

type CredentialProvider ¶

type CredentialProvider interface {
	FetchToken() string
}

type OAuthClientCredentials ¶

type OAuthClientCredentials struct {
	ClientId     string
	ClientSecret string
	AuthorityURI string
	Cluster      string
}

func AzureADClientCredentials ¶

func AzureADClientCredentials(
	clientId string,
	clientSecret string,
	tenantId string,
	cluster string,
) OAuthClientCredentials

func (OAuthClientCredentials) FetchToken ¶

func (m OAuthClientCredentials) FetchToken() string

type TimeSeries ¶

type TimeSeries struct {
	Client *CogniteClient
}

func (*TimeSeries) Filter ¶

func (t *TimeSeries) Filter(
	filter *dto.TimeSeriesFilter,
	advancedFilter map[string]interface{},
	limit int,
	cursor string,
	partition string,
	sort []map[string]interface{},
) (dto.TimeSeriesList, error)

func (*TimeSeries) List ¶

func (t *TimeSeries) List(
	limit int,
	includeMetadata bool,
	cursor string,
	partition string,
	assetIDs []int64,
	rootAssetIDs []int64,
	externalIDPrefix string,
) (dto.TimeSeriesList, error)

func (*TimeSeries) RetrieveData ¶

func (t *TimeSeries) RetrieveData(
	items *[]dto.DataPointsQueryItem,
	startTime *string,
	endTime *string,
	limit *int64,
	aggregates *[]string,
	granularity *string,
	includeOutsidePoints *bool,
	ignoreUnknownIds *bool,
) (*dto.DataPointListResponse, error)

func (*TimeSeries) RetrieveLatest ¶

func (t *TimeSeries) RetrieveLatest(
	items *[]dto.LatestDataPointsQueryItem,
	ignoreUnknownIds *bool,
) (*dto.DataPointListResponse, error)

type Token ¶

type Token struct {
	AccessToken string
}

func (Token) FetchToken ¶

func (t Token) FetchToken() string

type Units ¶

type Units struct {
	Client *CogniteClient
}

func (*Units) List ¶

func (u *Units) List() (dto.UnitList, error)

Source Files ¶

View all Source files

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