client

package

Go to main page

Versions in this module

v0

v0.92.0

Nov 16, 2023

v0.91.1

Jul 26, 2023

Changes in this version

type Client

+ func (c *Client) DeleteTriggerDeliveryPolicy(realm string, policyName string) (AstarteRequest, error)

+ func (c *Client) GetTriggerDeliveryPolicy(realm string, policyName string) (AstarteRequest, error)

+ func (c *Client) InstallTriggerDeliveryPolicy(realm string, policyPayload any) (AstarteRequest, error)

+ func (c *Client) ListTriggerDeliveryPolicies(realm string) (AstarteRequest, error)

+ type DeleteTriggerDeliveryPolicyRequest struct

+ func (r DeleteTriggerDeliveryPolicyRequest) Run(c *Client) (AstarteResponse, error)

+ func (r DeleteTriggerDeliveryPolicyRequest) ToCurl(_ *Client) string

+ type GetTriggerDeliveryPolicyRequest struct

+ func (r GetTriggerDeliveryPolicyRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetTriggerDeliveryPolicyRequest) ToCurl(_ *Client) string

+ type GetTriggerDeliveryPolicyResponse struct

+ func (r GetTriggerDeliveryPolicyResponse) Parse() (any, error)

+ func (r GetTriggerDeliveryPolicyResponse) Raw(f func(*http.Response) any) any

+ type InstallTriggerDeliveryPolicyRequest struct

+ func (r InstallTriggerDeliveryPolicyRequest) Run(c *Client) (AstarteResponse, error)

+ func (r InstallTriggerDeliveryPolicyRequest) ToCurl(_ *Client) string

+ type InstallTriggerDeliveryPolicyResponse struct

+ func (r InstallTriggerDeliveryPolicyResponse) Parse() (any, error)

+ func (r InstallTriggerDeliveryPolicyResponse) Raw(f func(*http.Response) any) any

+ type ListTriggerDeliveryPoliciesRequest struct

+ func (r ListTriggerDeliveryPoliciesRequest) Run(c *Client) (AstarteResponse, error)

+ func (r ListTriggerDeliveryPoliciesRequest) ToCurl(_ *Client) string

+ type ListTriggerDeliveryPoliciesResponse struct

+ func (r ListTriggerDeliveryPoliciesResponse) Parse() (any, error)

+ func (r ListTriggerDeliveryPoliciesResponse) Raw(f func(*http.Response) any) any

v0.91.0

May 29, 2023

Changes in this version

+ var ErrBothJWTAndPrivateKey = errors.New("Can't provide both an Astarte JWT and an Astarte private key")

+ var ErrConflictingUrls = errors.New("Conflicting URLs provided")

+ var ErrExpiryButNoPrivateKeyProvided = errors.New("Expiry was set, but no Astarte private key provided")

+ var ErrNegativeReplicationFactor = errors.New("Replication factor must be a strictly positive integer")

+ var ErrNoAuthProvided = errors.New("Neither an Astarte JWT nor an Astarte private key were provided")

+ var ErrNoPrivateKeyProvided = errors.New("No Astarte private key provided")

+ var ErrNoUrlsProvided = errors.New("No Astarte URL(s) provided")

+ var ErrRealmNameNotProvided = errors.New("Realm name was not provided")

+ var ErrRealmPublicKeyNotProvided = errors.New("Realm public key was not provided")

+ var ErrTooHighExpiry = errors.New("Expiry for tokens generated from a private key must be less than 5 minutes")

+ var ErrTooManyReplicationFactors = errors.New("Can't have both replication factor and datacenter replication factors")

+ func ErrDifferentStatusCode(expected, received int) error

+ func ErrInvalidDeviceID(deviceID string) error

+ func WithDatacenterReplicationFactors(datacenterReplicationFactors map[string]int) realmOption

+ func WithRealmName(name string) realmOption

+ func WithRealmPublicKey(publicKey string) realmOption

+ func WithReplicationFactor(replicationFactor int) realmOption

+ type AddDeviceAliasRequest struct

+ func (r AddDeviceAliasRequest) Run(c *Client) (AstarteResponse, error)

+ func (r AddDeviceAliasRequest) ToCurl(c *Client) string

+ type AddDeviceAliasResponse struct

+ type AddDeviceToGroupRequest struct

+ func (r AddDeviceToGroupRequest) Run(c *Client) (AstarteResponse, error)

+ func (r AddDeviceToGroupRequest) ToCurl(c *Client) string

+ type AstarteRequest interface

+ Run func(c *Client) (AstarteResponse, error)

+ ToCurl func(c *Client) string

+ type AstarteResponse interface

+ Parse func() (any, error)

+ Raw func(func(*http.Response) any) any

type Client

+ func New(options ...Option) (*Client, error)

+ func (c *Client) AddDeviceAlias(realm string, deviceID string, aliasTag string, deviceAlias string) (AstarteRequest, error)

+ func (c *Client) AddDeviceToGroup(realm, groupName, deviceID string) (AstarteRequest, error)

+ func (c *Client) CreateGroup(realm, groupName string, deviceIDList []string) (AstarteRequest, error)

+ func (c *Client) CreateRealm(opts ...realmOption) (AstarteRequest, error)

+ func (c *Client) DeleteDeviceAlias(realm string, deviceID string, aliasTag string) (AstarteRequest, error)

+ func (c *Client) DeleteDeviceAttribute(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (AstarteRequest, error)

+ func (c *Client) DeleteInterface(realm string, interfaceName string, interfaceMajor int) (AstarteRequest, error)

+ func (c *Client) DeleteTrigger(realm string, triggerName string) (AstarteRequest, error)

+ func (c *Client) GetAllProperties(realm string, deviceIdentifier string, ...) (AstarteRequest, error)

+ func (c *Client) GetAppengineURL() (ret *url.URL)

+ func (c *Client) GetDatastreamIndividualPaginator(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (Paginator, error)

+ func (c *Client) GetDatastreamIndividualSnapshot(realm string, deviceIdentifier string, ...) (AstarteRequest, error)

+ func (c *Client) GetDatastreamIndividualTimeWindowPaginator(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (Paginator, error)

+ func (c *Client) GetDatastreamObjectPaginator(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (Paginator, error)

+ func (c *Client) GetDatastreamObjectSnapshot(realm string, deviceIdentifier string, ...) (AstarteRequest, error)

+ func (c *Client) GetDatastreamObjectTimeWindowPaginator(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (Paginator, error)

+ func (c *Client) GetDeviceDetails(realm string, deviceIdentifier string, ...) (AstarteRequest, error)

+ func (c *Client) GetDeviceIDFromAlias(realm string, deviceAlias string) (AstarteRequest, error)

+ func (c *Client) GetDeviceListPaginator(realm string, pageSize int, format DeviceResultFormat) (Paginator, error)

+ func (c *Client) GetDevicesStats(realm string) (AstarteRequest, error)

+ func (c *Client) GetHousekeepingURL() (ret *url.URL)

+ func (c *Client) GetInterface(realm string, interfaceName string, interfaceMajor int) (AstarteRequest, error)

+ func (c *Client) GetMQTTv1ProtocolInformationForDevice(realm, deviceID string) (AstarteRequest, error)

+ func (c *Client) GetPairingURL() (ret *url.URL)

+ func (c *Client) GetProperty(realm string, deviceIdentifier string, ...) (AstarteRequest, error)

+ func (c *Client) GetRealm(realm string) (AstarteRequest, error)

+ func (c *Client) GetRealmManagementURL() (ret *url.URL)

+ func (c *Client) GetTrigger(realm string, triggerName string) (AstarteRequest, error)

+ func (c *Client) InstallInterface(realm string, interfacePayload interfaces.AstarteInterface, isAsync bool) (AstarteRequest, error)

+ func (c *Client) InstallTrigger(realm string, triggerPayload any) (AstarteRequest, error)

+ func (c *Client) ListDeviceAliases(realm string, deviceIdentifier string, ...) (AstarteRequest, error)

+ func (c *Client) ListDeviceAttributes(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType) (AstarteRequest, error)

+ func (c *Client) ListDeviceInterfaces(realm string, deviceIdentifier string, ...) (AstarteRequest, error)

+ func (c *Client) ListGroupDevices(realm, groupName string, pageSize int, format DeviceResultFormat) (Paginator, error)

+ func (c *Client) ListGroups(realm string) (AstarteRequest, error)

+ func (c *Client) ListInterfaceMajorVersions(realm string, interfaceName string) (AstarteRequest, error)

+ func (c *Client) ListInterfaces(realm string) (AstarteRequest, error)

+ func (c *Client) ListRealms() (AstarteRequest, error)

+ func (c *Client) ListTriggers(realm string) (AstarteRequest, error)

+ func (c *Client) ObtainNewMQTTv1CertificateForDevice(realm, deviceID, csr string) (AstarteRequest, error)

+ func (c *Client) RegisterDevice(realm string, deviceID string) (AstarteRequest, error)

+ func (c *Client) RemoveDeviceFromGroup(realm, groupName, deviceID string) (AstarteRequest, error)

+ func (c *Client) SendData(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (AstarteRequest, error)

+ func (c *Client) SendDatastream(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (AstarteRequest, error)

+ func (c *Client) SetDeviceAttribute(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (AstarteRequest, error)

+ func (c *Client) SetDeviceInhibited(realm string, deviceIdentifier string, ...) (AstarteRequest, error)

+ func (c *Client) SetProperty(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (AstarteRequest, error)

+ func (c *Client) UnregisterDevice(realm string, deviceID string) (AstarteRequest, error)

+ func (c *Client) UnsetProperty(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (AstarteRequest, error)

+ func (c *Client) UpdateInterface(realm string, interfaceName string, interfaceMajor int, ...) (AstarteRequest, error)

+ type CreateGroupRequest struct

+ func (r CreateGroupRequest) Run(c *Client) (AstarteResponse, error)

+ func (r CreateGroupRequest) ToCurl(c *Client) string

+ type CreateGroupResponse struct

+ func (r CreateGroupResponse) Parse() (any, error)

+ func (r CreateGroupResponse) Raw(f func(*http.Response) any) any

+ type CreateRealmRequest struct

+ func (r CreateRealmRequest) Run(c *Client) (AstarteResponse, error)

+ func (r CreateRealmRequest) ToCurl(c *Client) string

+ type CreateRealmResponse struct

+ func (r CreateRealmResponse) Parse() (any, error)

+ func (r CreateRealmResponse) Raw(f func(*http.Response) any) any

+ type DatastreamIndividualValue struct

+ ReceptionTimestamp time.Time

+ Timestamp time.Time

+ Value interface{}

+ type DatastreamObjectValue struct

+ Timestamp time.Time

+ Values orderedmap.OrderedMap

+ func (s *DatastreamObjectValue) UnmarshalJSON(b []byte) error

+ type DeleteDeviceAliasRequest struct

+ func (r DeleteDeviceAliasRequest) Run(c *Client) (AstarteResponse, error)

+ func (r DeleteDeviceAliasRequest) ToCurl(c *Client) string

+ type DeleteDeviceAttributeRequest struct

+ func (r DeleteDeviceAttributeRequest) Run(c *Client) (AstarteResponse, error)

+ func (r DeleteDeviceAttributeRequest) ToCurl(c *Client) string

+ type DeleteInterfaceRequest struct

+ func (r DeleteInterfaceRequest) Run(c *Client) (AstarteResponse, error)

+ func (r DeleteInterfaceRequest) ToCurl(c *Client) string

+ type DeleteTriggerRequest struct

+ func (r DeleteTriggerRequest) Run(c *Client) (AstarteResponse, error)

+ func (r DeleteTriggerRequest) ToCurl(c *Client) string

+ type DevicesAndGroup struct

+ Devices []string

+ GroupName string

+ type Empty struct

+ func (e Empty) Parse() (any, error)

+ func (e Empty) Raw(func(*http.Response) any) any

+ func (r Empty) Run(c *Client) (AstarteResponse, error)

+ func (r Empty) ToCurl(c *Client) string

+ type GetDatastreamSnapshotRequest struct

+ func (r GetDatastreamSnapshotRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetDatastreamSnapshotRequest) ToCurl(c *Client) string

+ type GetDatastreamSnapshotResponse struct

+ func (r GetDatastreamSnapshotResponse) Parse() (any, error)

+ func (r GetDatastreamSnapshotResponse) Raw(f func(*http.Response) any) any

+ type GetDeviceDetailsRequest struct

+ func (r GetDeviceDetailsRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetDeviceDetailsRequest) ToCurl(c *Client) string

+ type GetDeviceDetailsResponse struct

+ func (r GetDeviceDetailsResponse) Parse() (any, error)

+ func (r GetDeviceDetailsResponse) Raw(f func(*http.Response) any) any

+ type GetDeviceIDFromAliasRequest struct

+ func (r GetDeviceIDFromAliasRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetDeviceIDFromAliasRequest) ToCurl(c *Client) string

+ type GetDeviceIDFromAliasResponse struct

+ func (r GetDeviceIDFromAliasResponse) Parse() (any, error)

+ func (r GetDeviceIDFromAliasResponse) Raw(f func(*http.Response) any) any

+ type GetDeviceStatsResponse struct

+ func (r GetDeviceStatsResponse) Parse() (any, error)

+ func (r GetDeviceStatsResponse) Raw(f func(*http.Response) any) any

+ type GetDevicesStatsRequest struct

+ func (r GetDevicesStatsRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetDevicesStatsRequest) ToCurl(c *Client) string

+ type GetInterfaceRequest struct

+ func (r GetInterfaceRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetInterfaceRequest) ToCurl(c *Client) string

+ type GetInterfaceResponse struct

+ func (r GetInterfaceResponse) Parse() (any, error)

+ func (r GetInterfaceResponse) Raw(f func(*http.Response) any) any

+ type GetNextDatastreamPageRequest struct

+ func (r GetNextDatastreamPageRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetNextDatastreamPageRequest) ToCurl(c *Client) string

+ type GetNextDatastreamPageResponse struct

+ func (r GetNextDatastreamPageResponse) Parse() (any, error)

+ func (r GetNextDatastreamPageResponse) Raw(f func(*http.Response) any) any

+ type GetNextDeviceListPageRequest struct

+ func (r GetNextDeviceListPageRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetNextDeviceListPageRequest) ToCurl(c *Client) string

+ type GetNextDeviceListPageResponse struct

+ func (r GetNextDeviceListPageResponse) Parse() (any, error)

+ func (r GetNextDeviceListPageResponse) Raw(f func(*http.Response) any) any

+ type GetPropertiesRequest struct

+ func (r GetPropertiesRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetPropertiesRequest) ToCurl(c *Client) string

+ type GetPropertiesResponse struct

+ func (r GetPropertiesResponse) Parse() (any, error)

+ func (r GetPropertiesResponse) Raw(f func(*http.Response) any) any

+ type GetRealmRequest struct

+ func (r GetRealmRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetRealmRequest) ToCurl(c *Client) string

+ type GetRealmResponse struct

+ func (r GetRealmResponse) Parse() (any, error)

+ func (r GetRealmResponse) Raw(f func(*http.Response) any) any

+ type GetTriggerRequest struct

+ func (r GetTriggerRequest) Run(c *Client) (AstarteResponse, error)

+ func (r GetTriggerRequest) ToCurl(c *Client) string

+ type GetTriggerResponse struct

+ func (r GetTriggerResponse) Parse() (any, error)

+ func (r GetTriggerResponse) Raw(f func(*http.Response) any) any

+ type InhibitDeviceRequest struct

+ func (r InhibitDeviceRequest) Run(c *Client) (AstarteResponse, error)

+ func (r InhibitDeviceRequest) ToCurl(c *Client) string

+ type InstallInterfaceRequest struct

+ func (r InstallInterfaceRequest) Run(c *Client) (AstarteResponse, error)

+ func (r InstallInterfaceRequest) ToCurl(c *Client) string

+ type InstallInterfaceResponse struct

+ func (r InstallInterfaceResponse) Parse() (any, error)

+ func (r InstallInterfaceResponse) Raw(f func(*http.Response) any) any

+ type InstallTriggerRequest struct

+ func (r InstallTriggerRequest) Run(c *Client) (AstarteResponse, error)

+ func (r InstallTriggerRequest) ToCurl(c *Client) string

+ type InstallTriggerResponse struct

+ func (r InstallTriggerResponse) Parse() (any, error)

+ func (r InstallTriggerResponse) Raw(f func(*http.Response) any) any

+ type ListDeviceAliasesRequest struct

+ func (r ListDeviceAliasesRequest) Run(c *Client) (AstarteResponse, error)

+ func (r ListDeviceAliasesRequest) ToCurl(c *Client) string

+ type ListDeviceAliasesResponse struct

+ func (r ListDeviceAliasesResponse) Parse() (any, error)

+ func (r ListDeviceAliasesResponse) Raw(f func(*http.Response) any) any

+ type ListDeviceAttributesRequest struct

+ func (r ListDeviceAttributesRequest) Run(c *Client) (AstarteResponse, error)

+ func (r ListDeviceAttributesRequest) ToCurl(c *Client) string

+ type ListDeviceAttributesResponse struct

+ func (r ListDeviceAttributesResponse) Parse() (any, error)

+ func (r ListDeviceAttributesResponse) Raw(f func(*http.Response) any) any

+ type ListDeviceInterfacesRequest struct

+ func (r ListDeviceInterfacesRequest) Run(c *Client) (AstarteResponse, error)

+ func (r ListDeviceInterfacesRequest) ToCurl(c *Client) string

+ type ListDeviceInterfacesResponse struct

+ func (r ListDeviceInterfacesResponse) Parse() (any, error)

+ func (r ListDeviceInterfacesResponse) Raw(f func(*http.Response) any) any

+ type ListGroupsRequest struct

+ func (r ListGroupsRequest) Run(c *Client) (AstarteResponse, error)

+ func (r ListGroupsRequest) ToCurl(c *Client) string

+ type ListGroupsResponse struct

+ func (r ListGroupsResponse) Parse() (any, error)

+ func (r ListGroupsResponse) Raw(f func(*http.Response) any) any

+ type ListInterfaceMajorVersionsRequest struct

+ func (r ListInterfaceMajorVersionsRequest) Run(c *Client) (AstarteResponse, error)

+ func (r ListInterfaceMajorVersionsRequest) ToCurl(c *Client) string

+ type ListInterfaceMajorVersionsResponse struct

+ func (r ListInterfaceMajorVersionsResponse) Parse() (any, error)

+ func (r ListInterfaceMajorVersionsResponse) Raw(f func(*http.Response) any) any

+ type ListInterfacesRequest struct

+ func (r ListInterfacesRequest) Run(c *Client) (AstarteResponse, error)

+ func (r ListInterfacesRequest) ToCurl(c *Client) string

+ type ListInterfacesResponse struct

+ func (r ListInterfacesResponse) Parse() (any, error)

+ func (r ListInterfacesResponse) Raw(f func(*http.Response) any) any

+ type ListRealmsRequest struct

+ func (r ListRealmsRequest) Run(c *Client) (AstarteResponse, error)

+ func (r ListRealmsRequest) ToCurl(c *Client) string

+ type ListRealmsResponse struct

+ func (r ListRealmsResponse) Parse() (any, error)

+ func (r ListRealmsResponse) Raw(f func(*http.Response) any) any

+ type ListTriggersRequest struct

+ func (r ListTriggersRequest) Run(c *Client) (AstarteResponse, error)

+ func (r ListTriggersRequest) ToCurl(c *Client) string

+ type ListTriggersResponse struct

+ func (r ListTriggersResponse) Parse() (any, error)

+ func (r ListTriggersResponse) Raw(f func(*http.Response) any) any

+ type Mqttv1DeviceInformationRequest struct

+ func (r Mqttv1DeviceInformationRequest) Run(c *Client) (AstarteResponse, error)

+ func (r Mqttv1DeviceInformationRequest) ToCurl(c *Client) string

+ type Mqttv1DeviceInformationResponse struct

+ func (r Mqttv1DeviceInformationResponse) Parse() (any, error)

+ func (r Mqttv1DeviceInformationResponse) Raw(f func(*http.Response) any) any

+ type NewDeviceCertificateRequest struct

+ func (r NewDeviceCertificateRequest) Run(c *Client) (AstarteResponse, error)

+ func (r NewDeviceCertificateRequest) ToCurl(c *Client) string

+ type NewDeviceCertificateResponse struct

+ func (r NewDeviceCertificateResponse) Parse() (any, error)

+ func (r NewDeviceCertificateResponse) Raw(f func(*http.Response) any) any

+ type NoDataResponse struct

+ func (r NoDataResponse) Parse() (any, error)

+ func (r NoDataResponse) Raw(f func(*http.Response) any) any

+ type Option = func(c *Client) error

+ func WithAppEngineURL(appEngineURL string) Option

+ func WithBaseURL(baseURL string) Option

+ func WithExpiry(expirySeconds int) Option

+ func WithHTTPClient(httpClient *http.Client) Option

+ func WithHousekeepingURL(housekeepingURL string) Option

+ func WithJWT(token string) Option

+ func WithPairingURL(pairingURL string) Option

+ func WithPrivateKey(privateKey T) Option

+ func WithRealmManagementURL(realmManagementURL string) Option

+ func WithUserAgent(userAgent string) Option

+ type Paginator interface

+ GetNextPage func() (AstarteRequest, error)

+ GetPageSize func() int

+ HasNextPage func() bool

+ Rewind func()

+ type PropertyValue any

+ type RegisterDeviceRequest struct

+ func (r RegisterDeviceRequest) Run(c *Client) (AstarteResponse, error)

+ func (r RegisterDeviceRequest) ToCurl(c *Client) string

+ type RegisterDeviceResponse struct

+ func (r RegisterDeviceResponse) Parse() (any, error)

+ func (r RegisterDeviceResponse) Raw(f func(*http.Response) any) any

+ type RemoveDeviceFromGroupRequest struct

+ func (r RemoveDeviceFromGroupRequest) Run(c *Client) (AstarteResponse, error)

+ func (r RemoveDeviceFromGroupRequest) ToCurl(c *Client) string

+ type SendDatastreamRequest struct

+ func (r SendDatastreamRequest) Run(c *Client) (AstarteResponse, error)

+ func (r SendDatastreamRequest) ToCurl(c *Client) string

+ type SetDeviceAttributeRequest struct

+ func (r SetDeviceAttributeRequest) Run(c *Client) (AstarteResponse, error)

+ func (r SetDeviceAttributeRequest) ToCurl(c *Client) string

+ type SetPropertyRequest struct

+ func (r SetPropertyRequest) Run(c *Client) (AstarteResponse, error)

+ func (r SetPropertyRequest) ToCurl(c *Client) string

+ type UnregisterDeviceRequest struct

+ func (r UnregisterDeviceRequest) Run(c *Client) (AstarteResponse, error)

+ func (r UnregisterDeviceRequest) ToCurl(c *Client) string

+ type UnsetPropertyRequest struct

+ func (r UnsetPropertyRequest) Run(c *Client) (AstarteResponse, error)

+ func (r UnsetPropertyRequest) ToCurl(c *Client) string

+ type UpdateInterfaceRequest struct

+ func (r UpdateInterfaceRequest) Run(c *Client) (AstarteResponse, error)

+ func (r UpdateInterfaceRequest) ToCurl(c *Client) string

v0.90.4

Apr 14, 2022

v0.90.3

Mar 1, 2022

v0.90.2

Aug 17, 2021

Changes in this version

type AppEngineService

+ func (s *AppEngineService) DeleteDeviceAttribute(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) error

+ func (s *AppEngineService) ListDeviceAttributes(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType) (map[string]string, error)

+ func (s *AppEngineService) SetDeviceAttribute(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) error

type DeviceDetails

+ Attributes map[string]string

v0.90.1

Feb 19, 2021

v0.90.0

Nov 18, 2020

Changes in this version

+ var ErrMalformedPayload = errors.New("received an invalid JSONAPI payload")

+ type AppEngineService struct

+ func (s *AppEngineService) AddDeviceAlias(realm string, deviceID string, aliasTag string, deviceAlias string) error

+ func (s *AppEngineService) AddDeviceToGroup(realm string, groupName string, deviceIdentifier string, ...) error

+ func (s *AppEngineService) CreateGroup(realm string, groupName string, deviceIdentifierList []string, ...) error

+ func (s *AppEngineService) DeleteDeviceAlias(realm string, deviceID string, aliasTag string) error

+ func (s *AppEngineService) DeleteDeviceMetadata(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) error

+ func (s *AppEngineService) GetAggregateDatastreamSnapshot(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (DatastreamAggregateValue, error)

+ func (s *AppEngineService) GetAggregateDatastreamsTimeWindow(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) ([]DatastreamAggregateValue, error)

+ func (s *AppEngineService) GetAggregateParametricDatastreamSnapshot(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (map[string]DatastreamAggregateValue, error)

+ func (s *AppEngineService) GetDatastreamSnapshot(realm string, deviceIdentifier string, ...) (map[string]DatastreamValue, error)

+ func (s *AppEngineService) GetDatastreamsPaginator(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (DatastreamPaginator, error)

+ func (s *AppEngineService) GetDatastreamsTimeWindowPaginator(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) (DatastreamPaginator, error)

+ func (s *AppEngineService) GetDevice(realm string, deviceIdentifier string, ...) (DeviceDetails, error)

+ func (s *AppEngineService) GetDeviceIDFromAlias(realm string, deviceAlias string) (string, error)

+ func (s *AppEngineService) GetDeviceIDFromDeviceIdentifier(realm string, deviceIdentifier string, ...) (string, error)

+ func (s *AppEngineService) GetDeviceListPaginator(realm string, pageSize int, format DeviceResultFormat) (DeviceListPaginator, error)

+ func (s *AppEngineService) GetDevicesStats(realm string) (DevicesStats, error)

+ func (s *AppEngineService) GetLastAggregateDatastreams(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) ([]DatastreamAggregateValue, error)

+ func (s *AppEngineService) GetLastDatastreams(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) ([]DatastreamValue, error)

+ func (s *AppEngineService) GetProperties(realm string, deviceIdentifier string, ...) (map[string]interface{}, error)

+ func (s *AppEngineService) InhibitDevice(realm string, deviceIdentifier string, ...) error

+ func (s *AppEngineService) ListDeviceAliases(realm string, deviceID string) (map[string]string, error)

+ func (s *AppEngineService) ListDeviceInterfaces(realm string, deviceIdentifier string, ...) ([]string, error)

+ func (s *AppEngineService) ListDeviceMetadata(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType) (map[string]string, error)

+ func (s *AppEngineService) ListDevices(realm string) ([]string, error)

+ func (s *AppEngineService) ListDevicesWithDetails(realm string) ([]DeviceDetails, error)

+ func (s *AppEngineService) ListGroupDevices(realm string, groupName string) ([]string, error)

+ func (s *AppEngineService) ListGroups(realm string) ([]string, error)

+ func (s *AppEngineService) RemoveDeviceFromGroup(realm string, groupName string, deviceIdentifier string, ...) error

+ func (s *AppEngineService) SendAggregateDatastream(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) error

+ func (s *AppEngineService) SendData(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) error

+ func (s *AppEngineService) SendDatastream(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) error

+ func (s *AppEngineService) SetDeviceMetadata(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) error

+ func (s *AppEngineService) SetProperty(realm, deviceIdentifier string, deviceIdentifierType DeviceIdentifierType, ...) error

+ type AstarteMQTTv1ProtocolInformation struct

+ BrokerURL string

+ type Client struct

+ AppEngine *AppEngineService

+ Housekeeping *HousekeepingService

+ Pairing *PairingService

+ RealmManagement *RealmManagementService

+ UserAgent string

+ func NewClient(rawBaseURL string, httpClient *http.Client) (*Client, error)

+ func NewClientWithIndividualURLs(individualURLs map[misc.AstarteService]string, httpClient *http.Client) (*Client, error)

+ func (c *Client) SetToken(token string)

+ func (c *Client) SetTokenFromPrivateKey(privateKey []byte) error

+ func (c *Client) SetTokenFromPrivateKeyFile(privateKeyFile string) error

+ func (c *Client) SetTokenFromPrivateKeyFileWithClaims(privateKeyFile string, servicesAndClaims map[misc.AstarteService][]string, ...) error

+ func (c *Client) SetTokenFromPrivateKeyFileWithTTL(privateKeyFile string, ttlSeconds int64) error

+ func (c *Client) SetTokenFromPrivateKeyWithClaims(privateKey []byte, servicesAndClaims map[misc.AstarteService][]string, ...) error

+ func (c *Client) SetTokenFromPrivateKeyWithTTL(privateKey []byte, ttlSeconds int64) error

+ type DatastreamAggregateValue struct

+ Timestamp time.Time

+ Values orderedmap.OrderedMap

+ func (s *DatastreamAggregateValue) UnmarshalJSON(b []byte) error

+ type DatastreamPaginator struct

+ func (d *DatastreamPaginator) GetNextAggregatePage() ([]DatastreamAggregateValue, error)

+ func (d *DatastreamPaginator) GetNextPage() ([]DatastreamValue, error)

+ func (d *DatastreamPaginator) GetPageSize() int

+ func (d *DatastreamPaginator) GetResultSetOrder() ResultSetOrder

+ func (d *DatastreamPaginator) HasNextPage() bool

+ func (d *DatastreamPaginator) Rewind()

+ type DatastreamValue struct

+ ReceptionTimestamp time.Time

+ Timestamp time.Time

+ Value interface{}

+ type DeviceDetails struct

+ Aliases map[string]string

+ Connected bool

+ CredentialsInhibited bool

+ DeviceID string

+ FirstCredentialsRequest time.Time

+ FirstRegistration time.Time

+ Introspection map[string]DeviceInterfaceIntrospection

+ LastConnection time.Time

+ LastCredentialsRequestIP net.IP

+ LastDisconnection time.Time

+ LastSeenIP net.IP

+ Metadata map[string]string

+ PreviousInterfaces []DeviceInterfaceIntrospection

+ TotalReceivedBytes uint64

+ TotalReceivedMessages int64

+ type DeviceIdentifierType int

+ const AstarteDeviceAlias

+ const AstarteDeviceID

+ const AutodiscoverDeviceIdentifier

+ type DeviceInterfaceIntrospection struct

+ ExchangedBytes uint64

+ ExchangedMessages uint64

+ Major int

+ Minor int

+ Name string

+ type DeviceListPaginator struct

+ func (d *DeviceListPaginator) GetNextPage(pagePtr interface{}) error

+ func (d *DeviceListPaginator) GetPageSize() int

+ func (d *DeviceListPaginator) HasNextPage() bool

+ func (d *DeviceListPaginator) Rewind()

+ type DeviceResultFormat int

+ const DeviceDetailsFormat

+ const DeviceIDFormat

+ type DevicesStats struct

+ ConnectedDevices int64

+ TotalDevices int64

+ type HousekeepingService struct

+ func (s *HousekeepingService) CreateRealm(realm string, publicKeyString string) error

+ func (s *HousekeepingService) CreateRealmWithDatacenterReplication(realm string, publicKeyString string, ...) error

+ func (s *HousekeepingService) CreateRealmWithReplicationFactor(realm string, publicKeyString string, replicationFactor int) error

+ func (s *HousekeepingService) GetRealm(realm string) (RealmDetails, error)

+ func (s *HousekeepingService) ListRealms() ([]string, error)

+ type Links struct

+ Next string

+ Self string

+ type PairingService struct

+ func (s *PairingService) GetMQTTv1ProtocolInformationForDevice(realm, deviceID string) (AstarteMQTTv1ProtocolInformation, error)

+ func (s *PairingService) ObtainNewMQTTv1CertificateForDevice(realm, deviceID, csr string) (string, error)

+ func (s *PairingService) RegisterDevice(realm string, deviceID string) (string, error)

+ func (s *PairingService) UnregisterDevice(realm string, deviceID string) error

+ type RealmDetails struct

+ DatacenterReplicationFactors map[string]int

+ JwtPublicKeyPEM string

+ Name string

+ ReplicationClass ReplicationClass

+ ReplicationFactor int

+ type RealmManagementService struct

+ func (s *RealmManagementService) DeleteInterface(realm string, interfaceName string, interfaceMajor int) error

+ func (s *RealmManagementService) DeleteTrigger(realm string, triggerName string) error

+ func (s *RealmManagementService) GetInterface(realm string, interfaceName string, interfaceMajor int) (interfaces.AstarteInterface, error)

+ func (s *RealmManagementService) GetTrigger(realm string, triggerName string) (map[string]interface{}, error)

+ func (s *RealmManagementService) InstallInterface(realm string, interfacePayload interfaces.AstarteInterface) error

+ func (s *RealmManagementService) InstallTrigger(realm string, triggerPayload interface{}) error

+ func (s *RealmManagementService) ListInterfaceMajorVersions(realm string, interfaceName string) ([]int, error)

+ func (s *RealmManagementService) ListInterfaces(realm string) ([]string, error)

+ func (s *RealmManagementService) ListTriggers(realm string) ([]string, error)

+ func (s *RealmManagementService) UpdateInterface(realm string, interfaceName string, interfaceMajor int, ...) error

+ type ReplicationClass int

+ const NetworkTopologyStrategy

+ const SimpleStrategy

+ func (s *ReplicationClass) UnmarshalJSON(b []byte) error

+ func (s ReplicationClass) MarshalJSON() ([]byte, error)

+ func (s ReplicationClass) String() string

+ type ResultSetOrder int

+ const AscendingOrder

+ const DescendingOrder

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