c8y

package

Go to main page

Versions in this module

v0

v0.20.0

Jun 6, 2024

v0.19.1

Jun 1, 2024

v0.19.0

May 29, 2024

Changes in this version

type User

+ EffectiveRoles []Role

v0.18.0

May 29, 2024

v0.17.0

May 28, 2024

v0.16.0

May 18, 2024

Changes in this version

+ const RemoteAccessProtocolPassthrough

+ const RemoteAccessProtocolSSH

+ const RemoteAccessProtocolTelnet

+ const RemoteAccessProtocolVNC

type Client

+ RemoteAccess *RemoteAccessService

+ func (c *Client) HideSensitiveInformationIfActive(message string) string

+ type RemoteAccessCollectionOptions struct

+ type RemoteAccessConfiguration struct

+ Credentials RemoteAccessCredentials

+ Hostname string

+ ID string

+ Name string

+ Port int

+ Protocol string

+ type RemoteAccessCredentials struct

+ HostKey string

+ Password string

+ PrivateKey string

+ PublicKey string

+ Type string

+ Username string

+ type RemoteAccessService service

+ func (s *RemoteAccessService) Create(ctx context.Context, mo_id string, config_id string, body interface{}) (*RemoteAccessConfiguration, *Response, error)

+ func (s *RemoteAccessService) DeleteConfiguration(ctx context.Context, mo_id string, config_id string, ...) (*Response, error)

+ func (s *RemoteAccessService) GetConfiguration(ctx context.Context, mo_id, config_id string) (*RemoteAccessConfiguration, *Response, error)

+ func (s *RemoteAccessService) GetConfigurations(ctx context.Context, mo_id string, opt *RemoteAccessCollectionOptions) ([]RemoteAccessConfiguration, *Response, error)

+ func (s *RemoteAccessService) Update(ctx context.Context, mo_id string, config_id string, ...) (*Operation, *Response, error)

v0.15.10

Apr 26, 2024

Changes in this version

+ var ApplicationTagLatest = "latest"

+ func HasTag(tags []string, tag string) bool

v0.15.9

Apr 25, 2024

Changes in this version

type RequestOptions

+ PrepareRequestOnDryRun bool

v0.15.8

Apr 24, 2024

Changes in this version

type ApplicationOptions

+ Availability string

v0.15.7

Apr 24, 2024

Changes in this version

type Application

+ ApplicationVersions []ApplicationVersion

v0.15.6

Apr 21, 2024

v0.15.5

Apr 21, 2024

v0.15.4

Apr 21, 2024

Changes in this version

type RequestOptions

+ ValidateFuncs []RequestValidator

+ func (r *RequestOptions) WithValidateFunc(v ...RequestValidator) *RequestOptions

+ type RequestValidator func(*http.Request) error

v0.15.3

Apr 7, 2024

Changes in this version

type ApplicationVersionsService

+ func (s *ApplicationVersionsService) CreateVersionFromReader(ctx context.Context, ID string, file io.Reader, version ApplicationVersion) (*ApplicationVersion, *Response, error)

v0.15.2

Apr 6, 2024

v0.15.1

Apr 5, 2024

Changes in this version

type PaginationOptions

+ CurrentPage *int

+ func (o *PaginationOptions) SetCurrentPage(v int) *PaginationOptions

type UIManifestFile

+ Author string

+ License string

+ Remotes map[string][]string

+ RequiredPlatformVersion string

v0.15.0

Apr 5, 2024

Changes in this version

+ const ApplicationAvailabilityShared

+ const CumulocityUIManifestFile

+ var ContentTypeApplicationVersion = "application/vnd.com.nsn.cumulocity.applicationVersion+json"

+ var ContentTypeApplicationVersionCollection = "application/vnd.com.nsn.cumulocity.applicationVersionCollection+json"

+ func GetUIExtensionManifestContents(zipFilename string, contents interface{}) error

+ type ApplicationVersion struct

+ Application *Application

+ BinaryID string

+ Item gjson.Result

+ Tags []string

+ Version string

+ type ApplicationVersionsCollection struct

+ Items []gjson.Result

+ Versions []ApplicationVersion

+ type ApplicationVersionsOptions struct

+ Availability string

+ HasVersions *bool

+ Name string

+ Owner string

+ ProviderFor string

+ Subscriber string

+ Tenant string

+ Type string

+ User string

+ func (o *ApplicationVersionsOptions) WithHasVersions(v bool) *ApplicationVersionsOptions

+ type ApplicationVersionsService service

+ func (s *ApplicationVersionsService) CreateVersion(ctx context.Context, ID string, filenameOrURL string, ...) (*ApplicationVersion, *Response, error)

+ func (s *ApplicationVersionsService) DeleteVersionByName(ctx context.Context, ID string, version string) (*Response, error)

+ func (s *ApplicationVersionsService) DeleteVersionByTag(ctx context.Context, ID string, tag string) (*Response, error)

+ func (s *ApplicationVersionsService) GetVersionByName(ctx context.Context, ID string, version string) (*ApplicationVersion, *Response, error)

+ func (s *ApplicationVersionsService) GetVersionByTag(ctx context.Context, ID string, tag string) (*ApplicationVersion, *Response, error)

+ func (s *ApplicationVersionsService) GetVersions(ctx context.Context, ID string, opt *ApplicationVersionsOptions) (*ApplicationVersionsCollection, *Response, error)

+ func (s *ApplicationVersionsService) IsUrl(u string) bool

+ func (s *ApplicationVersionsService) ReplaceTags(ctx context.Context, ID string, version string, tags []string) (*ApplicationVersion, *Response, error)

type Client

+ ApplicationVersions *ApplicationVersionsService

+ UIExtension *UIExtensionService

+ type ExtensionOptions struct

+ Availability string

+ HasVersions bool

+ Name string

+ Owner string

+ ProviderFor string

+ Subscriber string

+ Tenant string

+ Type string

+ User string

+ type UIExtension struct

+ Manifest *UIManifest

+ ManifestFile *UIManifestFile

+ func NewApplicationExtension(name string) *UIExtension

+ func NewUIExtension(name string) *UIExtension

+ type UIExtensionService service

+ func (s *UIExtensionService) CreateExtension(ctx context.Context, application *Application, filename string, ...) (*ApplicationVersion, *Response, error)

+ func (s *UIExtensionService) GetExtensions(ctx context.Context, opt *ExtensionOptions) (*ApplicationCollection, *Response, error)

+ func (s *UIExtensionService) NewUIExtensionFromFile(filename string) (*UIExtension, error)

+ func (s *UIExtensionService) SetActive(ctx context.Context, appID string, binaryID string) (*Application, *Response, error)

+ type UIManifest struct

+ IsPackage *bool

+ Package string

+ func (m *UIManifest) WithIsPackage(v bool) *UIManifest

+ func (m *UIManifest) WithPackage(v string) *UIManifest

+ type UIManifestFile struct

+ ContextPath string

+ Description string

+ IsPackage bool

+ Key string

+ Name string

+ Package string

+ Version string

+ type UpsertOptions struct

+ SkipActivation bool

+ Version *ApplicationVersion

v0.14.14

Apr 2, 2024

Changes in this version

type Application

+ Roles []string

+ type Cacheable func(*http.Request) bool

+ type MeasurementSeriesDefinition struct

+ Name string

+ Type string

+ Unit string

v0.14.13

Jan 15, 2024

v0.14.12

Nov 29, 2023

Changes in this version

type ApplicationOptions

+ func (o *ApplicationOptions) WithHasVersions(v bool) *ApplicationOptions

v0.14.11

Nov 29, 2023

Changes in this version

type ApplicationOptions

+ HasVersions bool

+ Name string

+ Owner string

+ ProviderFor string

+ Subscriber string

+ Tenant string

+ User string

v0.14.10

Aug 9, 2023

v0.14.9

Jun 23, 2023

Changes in this version

+ func WithCommonOptionsContext(ctx context.Context, opts CommonOptions) context.Context

+ func WithDisabledDryRunContext(ctx context.Context) context.Context

v0.14.8

Jun 23, 2023

v0.14.7

Jun 23, 2023

Changes in this version

type Client

+ func (c *Client) GetHostname() string

+ func (c *Client) GetTenantName() string

+ func (c *Client) GetUsername() string

+ func (c *Client) ParseToken(tokenString string) (*CumulocityTokenClaim, error)

+ type CumulocityTokenClaim struct

+ TGA bool

+ Tenant string

+ User string

+ XSRFToken string

v0.14.6

Jun 7, 2023

v0.14.5

Jun 7, 2023

Changes in this version

type Notification2TokenClaim

+ Shared string

+ func (c *Notification2TokenClaim) IsShared() bool

v0.14.4

Jun 6, 2023

Changes in this version

type Client

+ Version string

v0.14.3

Jun 6, 2023

Changes in this version

type Client

+ func (c *Client) GetTenantVersion(ctx context.Context) (string, error)

v0.14.2

Jun 4, 2023

Changes in this version

type Response

+ func (r *Response) Duration() time.Duration

v0.14.1

Jun 3, 2023

Changes in this version

type Response

+ func (r *Response) SetBody(v []byte)

v0.14.0

May 21, 2023

Changes in this version

+ const AuthMethodBasic

+ const AuthMethodNone

+ const AuthMethodOAuth2Internal

+ const FragmentFirmware

+ const FragmentFirmwareBinary

+ const FragmentSoftware

+ const FragmentSoftwareBinary

+ const TimeFormat

+ var ErrNotFound = errors.New("item: not found")

+ var MethodsWithBody = []string

+ var MinTokenMinutes int64 = 1

+ func IsID(v string) bool

+ func NewCachedClient(httpClient *http.Client, cacheDir string, cacheTTL time.Duration, ...) *http.Client

+ func NewHTTPClient(opts ...ClientOption) *http.Client

+ func RequestSupportsBody(method string) bool

+ func UnsilenceLogger()

+ type AdditionParents struct

+ References []ManagedObjectReference

+ Self string

+ type AssetParents struct

+ References []ManagedObjectReference

+ Self string

+ type Cachable func(*http.Request) bool

+ type CacheOptions struct

+ BodyKeys []string

+ ExcludeAuth bool

+ ExcludeHost bool

+ Mode StoreMode

+ type Certificate struct

+ AlgorithmName string

+ AutoRegistrationEnabled bool

+ CertInPemFormat string

+ Fingerprint string

+ Issuer string

+ Name string

+ NotAfter string

+ NotBefore string

+ Self string

+ SerialNumber string

+ Status string

+ Subject string

+ Version int

+ type ChildAdditions struct

+ References []ManagedObjectReference

+ Self string

+ type ChildAssets struct

+ References []ManagedObjectReference

+ Self string

type Client

+ AuthorizationMethod string

+ Cookies []*http.Cookie

+ DeviceCertificate *DeviceCertificateService

+ Domain string

+ Firmware *InventoryFirmwareService

+ Notification2 *Notification2Service

+ Software *InventorySoftwareService

+ TFACode string

+ Token string

+ func (c *Client) DefaultDryRunHandler(options *RequestOptions, req *http.Request)

+ func (c *Client) GetXSRFToken() string

+ func (c *Client) LoginUsingOAuth2(ctx context.Context, initRequest ...string) error

+ func (c *Client) NewRequestWithoutAuth(method, path string, query string, body interface{}) (*http.Request, error)

+ func (c *Client) SetBasicAuthorization(req *http.Request)

+ func (c *Client) SetBearerAuthorization(req *http.Request)

+ func (c *Client) SetCookies(cookies []*http.Cookie)

+ func (c *Client) SetDomain(v string)

+ func (c *Client) SetHostHeader(req *http.Request)

+ func (c *Client) SetRequestOptions(options DefaultRequestOptions)

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

+ type ClientOption = func(http.RoundTripper) http.RoundTripper

+ func CacheResponse(ttl time.Duration, dir string, isCachable Cachable, options CacheOptions) ClientOption

+ func ReplaceTripper(tr http.RoundTripper) ClientOption

+ func WithInsecureSkipVerify(skipVerify bool) ClientOption

+ type CommonOptions struct

+ DryRun bool

+ OnResponse func(response *http.Response) io.Reader

+ type ContextCommonOptionsKey string

+ func GetContextCommonOptionsKey() ContextCommonOptionsKey

type ContextService

+ func (s *ContextService) CommonOptions(opts CommonOptions) context.Context

+ type DefaultRequestOptions struct

+ DryRun bool

+ DryRunHandler func(options *RequestOptions, req *http.Request)

+ DryRunResponse bool

+ type DeviceCertificateCollection struct

+ Certificates []Certificate

+ Items []gjson.Result

+ type DeviceCertificateCollectionOptions struct

+ type DeviceCertificateService service

+ func (s *DeviceCertificateService) Create(ctx context.Context, body interface{}) (*Certificate, *Response, error)

+ func (s *DeviceCertificateService) Delete(ctx context.Context, fingerprint string) (*Response, error)

+ func (s *DeviceCertificateService) GetCertificate(ctx context.Context, fingerprint string) (*Certificate, *Response, error)

+ func (s *DeviceCertificateService) GetCertificates(ctx context.Context, opt *DeviceCertificateCollectionOptions) (*DeviceCertificateCollection, *Response, error)

+ func (s *DeviceCertificateService) Update(ctx context.Context, fingerprint string, body interface{}) (*Certificate, *Response, error)

type ErrorResponse

+ Details ...

+ ErrorType string

+ Info string

+ type Firmware struct

+ func NewFirmware(name string) *Firmware

+ type FirmwareFragment struct

+ URL string

+ Version string

+ type FirmwareVersion struct

+ Firmware *FirmwareFragment

+ func NewFirmwareVersion(name string) *FirmwareVersion

type Hub

+ func NewHub() *Hub

+ func (h *Hub) Run()

+ type InventoryFirmwareService service

+ func (s *InventoryFirmwareService) CreateVersion(ctx context.Context, firmwareID string, binaryFile binary.MultiPartReader, ...) (*ManagedObject, *Response, error)

+ func (s *InventoryFirmwareService) GetFirmwareByName(ctx context.Context, name string, paging *PaginationOptions) (*ManagedObjectCollection, *Response, error)

+ func (s *InventoryFirmwareService) GetFirmwareVersionsByName(ctx context.Context, firmware string, name string, withParents bool, ...) (*ManagedObjectCollection, *Response, error)

type InventoryService

+ func (s *InventoryService) AddChildAddition(ctx context.Context, ID, childID string) (*ManagedObject, *Response, error)

+ func (s *InventoryService) CreateChildAddition(ctx context.Context, ID string, body interface{}) (*ManagedObject, *Response, error)

+ func (s *InventoryService) CreateChildAdditionWithBinary(ctx context.Context, parentID string, binaryFile binary.MultiPartReader, ...) (*ManagedObject, *Response, error)

+ func (s *InventoryService) CreateWithBinary(ctx context.Context, binaryFile binary.MultiPartReader, ...) (*ManagedObject, *Response, error)

+ func (s *InventoryService) DeleteWithOptions(ctx context.Context, ID string, options *ManagedObjectDeleteOptions) (*Response, error)

+ func (s *InventoryService) GetChildAdditions(ctx context.Context, id string, opt *ManagedObjectOptions) (*ManagedObjectReferencesCollection, *Response, error)

+ func (s *InventoryService) GetChildAssets(ctx context.Context, id string, opt *ManagedObjectOptions) (*ManagedObjectReferencesCollection, *Response, error)

+ type InventorySoftwareService service

+ func (s *InventorySoftwareService) CreateVersion(ctx context.Context, softwareID string, binaryFile binary.MultiPartReader, ...) (*ManagedObject, *Response, error)

+ func (s *InventorySoftwareService) GetSoftwareByName(ctx context.Context, name string, paging *PaginationOptions) (*ManagedObjectCollection, *Response, error)

+ func (s *InventorySoftwareService) GetSoftwareVersionsByName(ctx context.Context, software string, name string, withParents bool, ...) (*ManagedObjectCollection, *Response, error)

type ManagedObject

+ AdditionParents *AdditionParents

+ AssetParents *AssetParents

+ ChildAdditions *ChildAdditions

+ ChildAssets *ChildAssets

+ type ManagedObjectDeleteOptions struct

+ Cascade *bool

+ DeviceUser *bool

+ ForceCascade *bool

+ func (o *ManagedObjectDeleteOptions) WithCascade(v bool) *ManagedObjectDeleteOptions

+ func (o *ManagedObjectDeleteOptions) WithDeviceUser(v bool) *ManagedObjectDeleteOptions

+ func (o *ManagedObjectDeleteOptions) WithForceCascade(v bool) *ManagedObjectDeleteOptions

type NewDeviceRequest

+ CreationTime string

+ Owner string

+ TenantID string

+ type Notification2ClientOptions struct

+ ConnectionOptions notification2.ConnectionOptions

+ Consumer string

+ Options Notification2TokenOptions

+ Token string

+ type Notification2Service service

+ func (s *Notification2Service) CreateClient(ctx context.Context, opt Notification2ClientOptions) (*notification2.Notification2Client, error)

+ func (s *Notification2Service) CreateSubscription(ctx context.Context, ID string, subscription Notification2Subscription) (*Event, *Response, error)

+ func (s *Notification2Service) CreateToken(ctx context.Context, options Notification2TokenOptions) (*Notification2Token, *Response, error)

+ func (s *Notification2Service) DeleteSubscription(ctx context.Context, ID string) (*Response, error)

+ func (s *Notification2Service) DeleteSubscriptionBySource(ctx context.Context, opt Notification2SubscriptionDeleteOptions) (*Response, error)

+ func (s *Notification2Service) GetSubscription(ctx context.Context, ID string) (*Notification2Subscription, *Response, error)

+ func (s *Notification2Service) GetSubscriptions(ctx context.Context, opt *Notification2SubscriptionCollectionOptions) (*Notification2SubscriptionCollection, *Response, error)

+ func (s *Notification2Service) ParseToken(tokenString string) (*Notification2TokenClaim, error)

+ func (s *Notification2Service) RenewToken(ctx context.Context, opt Notification2ClientOptions) (string, error)

+ func (s *Notification2Service) UnsubscribeSubscriber(ctx context.Context, token string) (*UnsubscribeResponse, *Response, error)

+ type Notification2Subscription struct

+ Context string

+ FragmentsToCopy []string

+ ID string

+ Item gjson.Result

+ Self string

+ Source *Source

+ Subscription string

+ SubscriptionFilter Notification2SubscriptionFilter

+ type Notification2SubscriptionCollection struct

+ Items []gjson.Result

+ Subscriptions []Notification2Subscription

+ type Notification2SubscriptionCollectionOptions struct

+ Context string

+ Source string

+ type Notification2SubscriptionDeleteOptions struct

+ Context string

+ Source string

+ type Notification2SubscriptionFilter struct

+ Apis []string

+ TypeFilter string

+ type Notification2Token struct

+ Items []gjson.Result

+ Token string

+ type Notification2TokenClaim struct

+ Subscriber string

+ Topic string

+ func (c *Notification2TokenClaim) HasExpired() bool

+ func (c *Notification2TokenClaim) Subscription() string

+ func (c *Notification2TokenClaim) Tenant() string

+ type Notification2TokenOptions struct

+ ExpiresInMinutes int64

+ Shared bool

+ Subscriber string

+ Subscription string

type OperationCollectionOptions

+ BulkOperationId string

+ FragmentType string

+ Revert bool

type PaginationOptions

+ WithTotalElements bool

+ type ProxyReader struct

+ func NewByteReader(v []byte) *ProxyReader

+ func NewProxyReader(r io.Reader) *ProxyReader

+ func NewStringReader(v string) *ProxyReader

+ func (r ProxyReader) Close() error

+ func (r ProxyReader) GetValue() string

+ func (r ProxyReader) Read(p []byte) (n int, err error)

type RealtimeClient

+ func (c *RealtimeClient) SetBearerToken(token string)

+ func (c *RealtimeClient) SetCookies(cookies []*http.Cookie) error

+ func (c *RealtimeClient) SetRequestHeader(header http.Header)

+ func (c *RealtimeClient) SetXSRFToken(token string)

+ type RequestMiddleware func(r *http.Request) (*http.Request, error)

type RequestOptions

+ DryRunResponse bool

+ NoAuthentication bool

+ PrepareRequest func(*http.Request) (*http.Request, error)

+ func (r *RequestOptions) GetEscapedPath() (string, error)

+ func (r *RequestOptions) GetPath() (string, error)

+ func (r *RequestOptions) GetQuery() (string, error)

type Response

+ Response *http.Response

+ func (r *Response) Body() []byte

+ func (r *Response) Cookies() []*http.Cookie

+ func (r *Response) Header() http.Header

+ func (r *Response) IsError() bool

+ func (r *Response) IsSuccess() bool

+ func (r *Response) Proto() string

+ func (r *Response) RawBody() io.ReadCloser

+ func (r *Response) ReceivedAt() time.Time

+ func (r *Response) Size() int64

+ func (r *Response) Status() string

+ func (r *Response) StatusCode() int

+ func (r *Response) String() string

+ type Software struct

+ func NewSoftware(name string) *Software

+ type SoftwareFragment struct

+ URL string

+ Version string

+ type SoftwareVersion struct

+ Software *SoftwareFragment

+ func NewSoftwareVersion(name string) *SoftwareVersion

type Source

+ Name string

type Statistics

+ TotalElements *int

+ type StoreMode int

+ const StoreModeReadWrite

+ const StoreModeWrite

+ type TenantLoginOption struct

+ GrantType string

+ ID string

+ InitRequest string

+ Self string

+ TFAStrategy string

+ Type string

+ UserManagementSource string

+ VisibleOnLoginPage bool

+ type TenantLoginOptions struct

+ LoginOptions []TenantLoginOption

+ Self string

type TenantOptionsService

+ func (s *TenantOptionsService) GetVersion(ctx context.Context) (*TenantOption, *Response, error)

type TenantService

+ func (s *TenantService) GetLoginOptions(ctx context.Context) (*TenantLoginOptions, *Response, error)

+ type UnsubscribeResponse struct

+ Result string

v0.13.0-rc.3

May 13, 2023

v0.13.0-rc.2

May 13, 2023

v0.13.0-rc.1

Apr 20, 2023

v0.12.0-rc.10

Nov 26, 2022

v0.12.0-rc.9

Nov 26, 2022

v0.12.0-rc.8

Nov 26, 2022

v0.12.0-rc.7

Nov 26, 2022

v0.12.0-rc.6

Oct 3, 2022

v0.12.0-rc.5

Oct 2, 2022

v0.12.0-rc.4

Oct 2, 2022

v0.12.0-rc.3

Oct 2, 2022

v0.12.0-rc.2

Oct 2, 2022

v0.12.0-rc.1

Oct 2, 2022

v0.11.0-rc.2

Sep 30, 2022

v0.11.0-rc.1

Sep 29, 2022

v0.10.0-rc.14

Aug 28, 2022

v0.10.0-rc.13

Aug 28, 2022

v0.10.0-rc.12

Aug 28, 2022

v0.10.0-rc.11

Aug 28, 2022

v0.10.0-rc.10

Aug 27, 2022

v0.10.0-rc.9

Aug 27, 2022

v0.10.0-rc.8

Aug 27, 2022

v0.10.0-rc.7

Aug 27, 2022

v0.10.0-rc.6

Aug 17, 2022

v0.10.0-rc.5

Aug 9, 2022

v0.10.0-rc.4

Aug 2, 2022

v0.10.0-rc.3

Aug 1, 2022

v0.10.0-rc.2

Aug 1, 2022

v0.10.0-rc.1

Jul 18, 2022

v0.9.1-rc.15

Jun 23, 2022

v0.9.1-rc.14

Jun 18, 2022

v0.9.1-rc.13

May 29, 2022

v0.9.1-rc.12

May 9, 2022

v0.9.1-rc.11

Feb 23, 2022

v0.9.1-rc.10

Feb 23, 2022

v0.9.1-rc.9

Feb 8, 2022

v0.9.1-rc.8

Jan 24, 2022

v0.9.1-rc.7

Jan 23, 2022

v0.9.1-rc.6

Sep 27, 2021

v0.9.1-rc.5

Sep 26, 2021

v0.9.1-rc.4

Sep 26, 2021

v0.9.1-rc.3

Sep 26, 2021

v0.9.1-rc.2

Sep 24, 2021

v0.9.1-rc.1

Sep 24, 2021

v0.9.0-rc.16

Sep 23, 2021

v0.9.0-rc.15

Sep 23, 2021

v0.9.0-rc.14

Sep 23, 2021

v0.9.0-rc.13

Sep 23, 2021

v0.9.0-rc.12

Sep 21, 2021

v0.9.0-rc.11

Sep 21, 2021

v0.9.0-rc.10

Sep 21, 2021

v0.9.0-rc.9

Sep 21, 2021

v0.9.0-rc.8

Sep 21, 2021

v0.9.0-rc.7

Aug 27, 2021

v0.9.0-rc.6

Aug 27, 2021

v0.9.0-rc.5

Aug 27, 2021

v0.9.0-rc.4

Aug 23, 2021

v0.9.0-rc.3

Aug 4, 2021

v0.9.0-rc.2

Aug 3, 2021

v0.9.0-rc.1

Aug 3, 2021

v0.9.0-rc.0

Aug 3, 2021

v0.8.0

Sep 25, 2020

Changes in this version

+ var EnvVarLoggerHideSensitive = "C8Y_LOGGER_HIDE_SENSITIVE"

+ var Logger *logger.Logger

+ func SilenceLogger()

type Application

+ ActiveVersionID string

type ApplicationOptions

+ Type string

type GroupCollection

+ Items []gjson.Result

type OperationCollectionOptions

+ DateFrom string

+ DateTo string

type RequestOptions

+ DryRun bool

+ FormData map[string]io.Reader

+ Header http.Header

+ IgnoreAccept bool

type RoleCollection

+ Items []gjson.Result

type UserService

+ func (s *UserService) GetRole(ctx context.Context, ID string) (*Role, *Response, error)

v0.7.0

Jul 25, 2019

v0.6.0

Jun 8, 2019

Changes in this version

+ const MaximumRetryInterval

+ const MinimumRetryDelay

+ const MinimumRetryInterval

+ const RetryBackoffFactor

+ type Hub struct

+ func (h *Hub) GetActiveChannels() []string

type Message

+ Advice *advice

+ Subscription string

+ Successful bool

type RealtimeClient

+ func (c *RealtimeClient) Disconnect() error

+ func (c *RealtimeClient) WaitForMessage(ID string) chan error

+ func (c *RealtimeClient) WaitForMessages(ids ...string) chan error

v0.6.0-rc.3

May 26, 2019

v0.6.0-rc.2

May 26, 2019

v0.6.0-rc.1

May 25, 2019

v0.6.0-rc.0

Apr 24, 2019

v0.5.0

Apr 16, 2019

Changes in this version

+ const AlarmSeverityCritical

+ const AlarmSeverityMajor

+ const AlarmSeverityMinor

+ const AlarmSeverityWarning

+ const AlarmStatusAcknowledged

+ const AlarmStatusActive

+ const AlarmStatusCleared

+ const ApplicationAvailabilityMarket

+ const ApplicationAvailabilityPrivate

+ const ApplicationTypeApamaCEPRule

+ const ApplicationTypeExternal

+ const ApplicationTypeHosted

+ const ApplicationTypeMicroservice

+ const DeviceFragmentName

+ const EnvironmentApplicationName

+ const EnvironmentBaseURL

+ const EnvironmentBootstrapPassword

+ const EnvironmentBootstrapTenant

+ const EnvironmentBootstrapUsername

+ const EnvironmentMicroserviceIsolation

+ const EnvironmentPassword

+ const EnvironmentTenant

+ const EnvironmentUsername

+ const MINIMUMVERSION

+ const NewDeviceRequestAccepted

+ const NewDeviceRequestPendingAcceptance

+ const NewDeviceRequestWaitingForConnection

+ const OperationStatusExecuting

+ const OperationStatusFailed

+ const OperationStatusPending

+ const OperationStatusSuccessful

+ const RetentionRuleAPI

+ const VERSION

+ func CheckResponse(r *http.Response) error

+ func DecodeJSONBytes(v []byte, dst interface{}) error

+ func DecodeJSONFile(filepath string, dst interface{}) error

+ func DecodeJSONReader(r io.Reader, dst interface{}) error

+ func GetBootstrapUserFromEnvironment() (tenant, username, password string)

+ func GetDateRange(dateInterval string) (string, string)

+ func GetRoundedTime(date *time.Time, unit string) (roundTime time.Time)

+ func GetServiceUserFromEnvironment() (tenant, username, password string)

+ func NewAuthorizationContext(tenant, username, password string) context.Context

+ func NewAuthorizationContextFromRequest(req *http.Request) context.Context

+ func NewBasicAuthString(tenant, username, password string) string

+ func RealtimeAlarms(id ...string) string

+ func RealtimeAlarmsWithChildren(id ...string) string

+ func RealtimeEvents(id ...string) string

+ func RealtimeManagedObjects(id ...string) string

+ func RealtimeMeasurements(id ...string) string

+ func RealtimeOperations(id ...string) string

+ func Upload(client *http.Client, url string, values map[string]io.Reader) (err error)

+ type AcceptedError struct

+ func (*AcceptedError) Error() string

+ type Agent struct

+ func NewAgent(name string) *Agent

+ type AgentConfiguration struct

+ Configuration string

+ type AgentFragment struct

+ AgentFragment struct{}

+ type Alarm struct

+ Count uint64

+ CreationTime *Timestamp

+ FirstOccurrenceTime *Timestamp

+ ID string

+ Item gjson.Result

+ Self string

+ Severity string

+ Source *Source

+ Status string

+ Text string

+ Time *Timestamp

+ Type string

+ type AlarmBuilder struct

+ func NewAlarmBuilder(deviceID string, typeName string, text string) *AlarmBuilder

+ func (b *AlarmBuilder) Set(name string, value interface{}) *AlarmBuilder

+ func (b *AlarmBuilder) SetDeviceID(ID string) *AlarmBuilder

+ func (b *AlarmBuilder) SetSeverityCritical() *AlarmBuilder

+ func (b *AlarmBuilder) SetSeverityMajor() *AlarmBuilder

+ func (b *AlarmBuilder) SetSeverityMinor() *AlarmBuilder

+ func (b *AlarmBuilder) SetSeverityWarning() *AlarmBuilder

+ func (b *AlarmBuilder) SetText(ID string) *AlarmBuilder

+ func (b *AlarmBuilder) SetTimestamp(value *Timestamp) *AlarmBuilder

+ func (b *AlarmBuilder) SetType(ID string) *AlarmBuilder

+ func (b AlarmBuilder) DeviceID() string

+ func (b AlarmBuilder) Get(name string) (interface{}, bool)

+ func (b AlarmBuilder) MarshalJSON() ([]byte, error)

+ func (b AlarmBuilder) Severity() string

+ func (b AlarmBuilder) Text() string

+ func (b AlarmBuilder) Timestamp() Timestamp

+ func (b AlarmBuilder) Type() string

+ type AlarmCollection struct

+ Alarms []Alarm

+ Items []gjson.Result

+ type AlarmCollectionOptions struct

+ DateFrom string

+ DateTo string

+ FragmentType string

+ Resolved bool

+ Severity string

+ Source string

+ Status string

+ Type string

+ WithAssets bool

+ WithDevices bool

+ type AlarmService service

+ func (s *AlarmService) BulkUpdateAlarms(ctx context.Context, status string, opts AlarmUpdateOptions) (*Response, error)

+ func (s *AlarmService) Create(ctx context.Context, body interface{}) (*Alarm, *Response, error)

+ func (s *AlarmService) DeleteAlarms(ctx context.Context, opt *AlarmCollectionOptions) (*Response, error)

+ func (s *AlarmService) GetAlarm(ctx context.Context, ID string) (*Alarm, *Response, error)

+ func (s *AlarmService) GetAlarms(ctx context.Context, opt *AlarmCollectionOptions) (*AlarmCollection, *Response, error)

+ func (s *AlarmService) Update(ctx context.Context, ID string, body AlarmUpdateProperties) (*Alarm, *Response, error)

+ type AlarmUpdateOptions struct

+ DateFrom string

+ DateTo string

+ Resolved bool

+ Severity string

+ Source string

+ Status string

+ type AlarmUpdateProperties struct

+ Severity string

+ Status string

+ Text string

+ type Application struct

+ Availability string

+ ContextPath string

+ ExternalURL string

+ ID string

+ Item gjson.Result

+ Key string

+ Name string

+ Owner *ApplicationOwner

+ RequiredRoles []string

+ ResourcesPassword string

+ ResourcesURL string

+ ResourcesUsername string

+ Self string

+ Type string

+ func NewApplicationMicroservice(name string) *Application

+ type ApplicationCollection struct

+ Applications []Application

+ Items []gjson.Result

+ type ApplicationOptions struct

+ type ApplicationOwner struct

+ Self string

+ Tenant *ApplicationTenantReference

+ type ApplicationReference struct

+ Application *Application

+ Self string

+ type ApplicationReferenceCollection struct

+ References []ApplicationReference

+ Self string

+ type ApplicationService service

+ func (s *ApplicationService) Copy(ctx context.Context, ID string) (*Application, *Response, error)

+ func (s *ApplicationService) Create(ctx context.Context, body *Application) (*Application, *Response, error)

+ func (s *ApplicationService) CreateBinary(ctx context.Context, filename string, ID string) (*Response, error)

+ func (s *ApplicationService) Delete(ctx context.Context, ID string) (*Response, error)

+ func (s *ApplicationService) GetApplication(ctx context.Context, ID string) (*Application, *Response, error)

+ func (s *ApplicationService) GetApplicationUser(ctx context.Context, ID string) (*ApplicationUser, *Response, error)

+ func (s *ApplicationService) GetApplications(ctx context.Context, opt *ApplicationOptions) (*ApplicationCollection, *Response, error)

+ func (s *ApplicationService) GetApplicationsByName(ctx context.Context, name string, opt *ApplicationOptions) (*ApplicationCollection, *Response, error)

+ func (s *ApplicationService) GetApplicationsByOwner(ctx context.Context, tenant string, opt *ApplicationOptions) (*ApplicationCollection, *Response, error)

+ func (s *ApplicationService) GetApplicationsByTenant(ctx context.Context, tenant string, opt *ApplicationOptions) (*ApplicationCollection, *Response, error)

+ func (s *ApplicationService) GetCurrentApplication(ctx context.Context) (*Application, *Response, error)

+ func (s *ApplicationService) GetCurrentApplicationSubscriptions(ctx context.Context) (*ApplicationSubscriptions, *Response, error)

+ func (s *ApplicationService) Update(ctx context.Context, ID string, body *Application) (*Application, *Response, error)

+ func (s *ApplicationService) UpdateCurrentApplication(ctx context.Context, ID string, body *Application) (*Application, *Response, error)

+ type ApplicationSubscriptions struct

+ Item gjson.Result

+ Users []ServiceUser

+ type ApplicationTenantReference struct

+ ID string

+ type ApplicationUser struct

+ Password string

+ Tenant string

+ Username string

+ type AuditRecord struct

+ Activity string

+ Application string

+ CreationTime *Timestamp

+ ID string

+ Item gjson.Result

+ Self string

+ Severity string

+ Source *Source

+ Text string

+ Time *Timestamp

+ Type string

+ User string

+ type AuditRecordCollection struct

+ AuditRecords []AuditRecord

+ Items []gjson.Result

+ type AuditRecordCollectionOptions struct

+ Application string

+ DateFrom string

+ DateTo string

+ Revert bool

+ Type string

+ User string

+ type AuditService service

+ func (s *AuditService) Create(ctx context.Context, body interface{}) (*AuditRecord, *Response, error)

+ func (s *AuditService) DeleteAuditRecords(ctx context.Context, opt *AuditRecordCollectionOptions) (*Response, error)

+ func (s *AuditService) GetAuditRecord(ctx context.Context, ID string) (*AuditRecord, *Response, error)

+ func (s *AuditService) GetAuditRecords(ctx context.Context, opt *AuditRecordCollectionOptions) (*AuditRecordCollection, *Response, error)

+ type BaseResponse struct

+ Next *string

+ Self *string

+ Statistics *Statistics

+ type BinaryFragment struct

+ BinaryFragment string

+ type BinaryObjectOptions struct

+ FragmentType string

+ Ids []string

+ Type string

+ type ChildDevices struct

+ References []ManagedObjectReference

+ Self string

+ type Client struct

+ Alarm *AlarmService

+ Application *ApplicationService

+ Audit *AuditService

+ BaseURL *url.URL

+ BootstrapUser ServiceUser

+ Context *ContextService

+ DeviceCredentials *DeviceCredentialsService

+ Event *EventService

+ Identity *IdentityService

+ Inventory *InventoryService

+ Measurement *MeasurementService

+ Microservice *MicroserviceService

+ Operation *OperationService

+ Password string

+ Realtime *RealtimeClient

+ Retention *RetentionRuleService

+ ServiceUsers []ServiceUser

+ Tenant *TenantService

+ TenantName string

+ TenantOptions *TenantOptionsService

+ UseTenantInUsername bool

+ User *UserService

+ UserAgent string

+ Username string

+ func NewClient(httpClient *http.Client, baseURL string, tenant string, username string, ...) *Client

+ func NewClientFromEnvironment(httpClient *http.Client, skipRealtimeClient bool) *Client

+ func NewClientUsingBootstrapUserFromEnvironment(httpClient *http.Client, baseURL string, skipRealtimeClient bool) *Client

+ func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) (*Response, error)

+ func (c *Client) NewRealtimeClientFromServiceUser(tenant string) *RealtimeClient

+ func (c *Client) NewRequest(method, path string, query string, body interface{}) (*http.Request, error)

+ func (c *Client) Noop()

+ func (c *Client) SendRequest(ctx context.Context, options RequestOptions) (*Response, error)

+ func (c *Client) SetAuthorization(req *http.Request)

+ func (c *Client) SetJSONItems(resp *Response, v interface{}) error

+ type ConfigurationFragment struct

+ C8yConfiguration AgentConfiguration

+ type ContextAuthTokenKey string

+ func GetContextAuthTokenKey() ContextAuthTokenKey

+ type ContextService service

+ func (s *ContextService) BootstrapUserFromEnvironment() context.Context

+ func (s *ContextService) ClientUser() context.Context

+ func (s *ContextService) ServiceUserContext(tenant string, skipUpdateServiceUsers bool) context.Context

+ func (s *ContextService) ServiceUserFromEnvironment() context.Context

+ func (s *ContextService) ServiceUserFromRequest(req *http.Request) context.Context

+ type CurrentTenant struct

+ AllowCreateTenants bool

+ CustomProperties interface{}

+ DomainName string

+ Name string

+ type Device struct

+ func NewDevice(name string) *Device

+ type DeviceCredentials struct

+ ID string

+ Password string

+ Self string

+ TenantID string

+ Username string

+ type DeviceCredentialsService service

+ func (s *DeviceCredentialsService) Create(ctx context.Context, ID string) (*NewDeviceRequest, *Response, error)

+ func (s *DeviceCredentialsService) CreateDeviceCredentials(ctx context.Context, ID string) (*DeviceCredentials, *Response, error)

+ func (s *DeviceCredentialsService) Delete(ctx context.Context, ID string) (*Response, error)

+ func (s *DeviceCredentialsService) GetNewDeviceRequest(ctx context.Context, ID string) (*NewDeviceRequest, *Response, error)

+ func (s *DeviceCredentialsService) GetNewDeviceRequests(ctx context.Context, opt *AlarmCollectionOptions) (*NewDeviceRequestCollection, *Response, error)

+ func (s *DeviceCredentialsService) PollNewDeviceRequest(ctx context.Context, deviceID string, interval time.Duration, ...) (<-chan struct{}, <-chan error)

+ func (s *DeviceCredentialsService) Update(ctx context.Context, ID string, status string) (*NewDeviceRequest, *Response, error)

+ type DeviceFragment struct

+ DeviceFragment struct{}

+ type EmptyFragment struct

+ type Error struct

+ Code string

+ ErrorMessage string

+ Field string

+ Information string

+ Message string

+ Resource string

+ func (e *Error) Error() string

+ type ErrorResponse struct

+ Block ...

+ DocumentationURL string

+ Errors []Error

+ Message string

+ Response *http.Response

+ func (r *ErrorResponse) Error() string

+ type Event struct

+ ID string

+ Item gjson.Result

+ Self string

+ Source *Source

+ Text string

+ Time *Timestamp

+ Type string

+ type EventBinary struct

+ Item gjson.Result

+ Length int64

+ Self string

+ Source string

+ Type string

+ type EventBuilder struct

+ func NewEventBuilder(deviceID string, typeName string, text string) *EventBuilder

+ func (b *EventBuilder) Set(name string, value interface{}) *EventBuilder

+ func (b *EventBuilder) SetDeviceID(ID string) *EventBuilder

+ func (b *EventBuilder) SetText(text string) *EventBuilder

+ func (b *EventBuilder) SetTimestamp(value *Timestamp) *EventBuilder

+ func (b *EventBuilder) SetType(name string) *EventBuilder

+ func (b EventBuilder) DeviceID() string

+ func (b EventBuilder) Get(name string) (interface{}, bool)

+ func (b EventBuilder) MarshalJSON() ([]byte, error)

+ func (b EventBuilder) Text() string

+ func (b EventBuilder) Timestamp() Timestamp

+ func (b EventBuilder) Type() string

+ type EventCollection struct

+ Events []Event

+ Items []gjson.Result

+ type EventCollectionOptions struct

+ DateFrom string

+ DateTo string

+ FragmentType string

+ Source string

+ Type string

+ type EventService service

+ func (s *EventService) Create(ctx context.Context, body interface{}) (*Event, *Response, error)

+ func (s *EventService) CreateBinary(ctx context.Context, filename string, ID string) (*EventBinary, *Response, error)

+ func (s *EventService) Delete(ctx context.Context, ID string) (*Response, error)

+ func (s *EventService) DeleteBinary(ctx context.Context, ID string) (*Response, error)

+ func (s *EventService) DeleteEvents(ctx context.Context, opt *EventCollectionOptions) (*Response, error)

+ func (s *EventService) DownloadBinary(ctx context.Context, ID string) (filepath string, err error)

+ func (s *EventService) GetEvent(ctx context.Context, ID string) (*Event, *Response, error)

+ func (s *EventService) GetEvents(ctx context.Context, opt *EventCollectionOptions) (*EventCollection, *Response, error)

+ func (s *EventService) Update(ctx context.Context, ID string, body interface{}) (*Event, *Response, error)

+ func (s *EventService) UpdateBinary(ctx context.Context, ID, filename string) (*EventBinary, *Response, error)

+ type FragmentName string

+ func NewFragmentNameSeries(names ...string) []FragmentName

+ type Group struct

+ DevicePermissions map[string]interface{}

+ ID uint64

+ Name string

+ Roles *RoleReferenceCollection

+ Self string

+ func (g *Group) GetID() string

+ type GroupCollection struct

+ Groups []Group

+ Self string

+ type GroupOptions struct

+ type GroupReference struct

+ Group *Group

+ Self string

+ type GroupReferenceCollection struct

+ References []GroupReference

+ Self string

+ type Identity struct

+ ExternalID string

+ Item gjson.Result

+ ManagedObject IdentityReference

+ Self string

+ Type string

+ type IdentityOptions struct

+ ExternalID string

+ Type string

+ type IdentityReference struct

+ ID string

+ Self string

+ type IdentityService service

+ func (s *IdentityService) Create(ctx context.Context, ID string, identityType string, externalID string) (*Identity, *Response, error)

+ func (s *IdentityService) Delete(ctx context.Context, identityType, externalID string) (*Response, error)

+ func (s *IdentityService) GetExternalID(ctx context.Context, identityType string, externalID string) (*Identity, *Response, error)

+ type InventoryService service

+ func (s *InventoryService) Create(ctx context.Context, body interface{}) (*ManagedObject, *Response, error)

+ func (s *InventoryService) CreateBinary(ctx context.Context, filename string, properties interface{}) (*ManagedObject, *Response, error)

+ func (s *InventoryService) CreateDevice(ctx context.Context, name string) (*ManagedObject, *Response, error)

+ func (s *InventoryService) Delete(ctx context.Context, ID string) (*Response, error)

+ func (s *InventoryService) DeleteBinary(ctx context.Context, ID string) (*Response, error)

+ func (s *InventoryService) DownloadBinary(ctx context.Context, ID string) (filepath string, err error)

+ func (s *InventoryService) ExpandCollection(ctx context.Context, col *ManagedObjectCollection, maxPages int) (out *ManagedObjectCollection)

+ func (s *InventoryService) GetBinaries(ctx context.Context, opt *BinaryObjectOptions) (*ManagedObjectCollection, *Response, error)

+ func (s *InventoryService) GetChildDevices(ctx context.Context, id string, opt *PaginationOptions) (*ManagedObjectReferencesCollection, *Response, error)

+ func (s *InventoryService) GetDevices(ctx context.Context, paging *PaginationOptions) (*ManagedObjectCollection, *Response, error)

+ func (s *InventoryService) GetDevicesByName(ctx context.Context, name string, paging *PaginationOptions) (*ManagedObjectCollection, *Response, error)

+ func (s *InventoryService) GetManagedObject(ctx context.Context, ID string, opt *ManagedObjectOptions) (*ManagedObject, *Response, error)

+ func (s *InventoryService) GetManagedObjects(ctx context.Context, opt *ManagedObjectOptions) (*ManagedObjectCollection, *Response, error)

+ func (s *InventoryService) GetSupportedMeasurements(ctx context.Context, id string) (*SupportedMeasurements, *Response, error)

+ func (s *InventoryService) GetSupportedSeries(ctx context.Context, id string) (*SupportedSeries, *Response, error)

+ func (s *InventoryService) Update(ctx context.Context, ID string, body interface{}) (*ManagedObject, *Response, error)

+ func (s *InventoryService) UpdateBinary(ctx context.Context, ID, filename string) (*ManagedObject, *Response, error)

+ type Kpi struct

+ Fragment string

+ Series string

+ type ManagedObject struct

+ C8yConfiguration *AgentConfiguration

+ ChildDevices *ChildDevices

+ DeviceParents *ParentDevices

+ ID string

+ Item gjson.Result

+ Kpi *Kpi

+ Name string

+ Owner string

+ Self string

+ Type string

+ type ManagedObjectCollection struct

+ Items []gjson.Result

+ ManagedObjects []ManagedObject

+ func (s *ManagedObjectCollection) All() error

+ type ManagedObjectOptions struct

+ FragmentType string

+ Ids []string

+ Query string

+ Text string

+ Type string

+ WithParents bool

+ type ManagedObjectReference struct

+ ManagedObject ManagedObject

+ Self string

+ type ManagedObjectReferencesCollection struct

+ References []ManagedObjectReference

+ type Measurement struct

+ ID string

+ Item gjson.Result

+ Self string

+ Source *Source

+ Time *Timestamp

+ Type string

+ type MeasurementAggregateValue struct

+ Max Number

+ Min Number

+ type MeasurementCollection struct

+ Items []gjson.Result

+ Measurements []Measurement

+ type MeasurementCollectionOptions struct

+ DateFrom string

+ DateTo string

+ FragmentType string

+ Revert bool

+ Source string

+ Type string

+ ValueFragmentSeries string

+ ValueFragmentType string

+ type MeasurementRepresentation struct

+ Fragments []FragmentName

+ Source MeasurementSource

+ Timestamp time.Time

+ Type string

+ ValueFragmentTypes []ValueFragmentType

+ func NewSimpleMeasurementRepresentation(opt SimpleMeasurementOptions) (*MeasurementRepresentation, error)

+ func (m MeasurementRepresentation) MarshalJSON() ([]byte, error)

+ type MeasurementSerieDefinition struct

+ Name string

+ Type string

+ Unit string

+ type MeasurementSeriesAggregateGroup struct

+ DateFrom time.Time

+ DateTo time.Time

+ Series []MeasurementSerieDefinition

+ Truncated bool

+ Values []MeasurementSeriesAggregateValueGroup

+ func (d *MeasurementSeriesAggregateGroup) UnmarshalJSON(data []byte) error

+ type MeasurementSeriesAggregateValueGroup struct

+ Timestamp time.Time

+ Values []MeasurementAggregateValue

+ type MeasurementSeriesGroup struct

+ DateFrom time.Time

+ DateTo time.Time

+ DeviceID string

+ Series []MeasurementSerieDefinition

+ Truncated bool

+ Values []MeasurementSeriesValueGroup

+ func (d *MeasurementSeriesGroup) MarshalCSV(delimiter string) ([]byte, error)

+ func (d *MeasurementSeriesGroup) UnmarshalJSON(data []byte) error

+ type MeasurementSeriesOptions struct

+ AggregationType string

+ DateFrom string

+ DateTo string

+ Revert bool

+ Source string

+ Variables []string

+ type MeasurementSeriesValueGroup struct

+ Timestamp time.Time

+ Values []Number

+ type MeasurementService service

+ func (s *MeasurementService) Create(ctx context.Context, body MeasurementRepresentation) (*Measurement, *Response, error)

+ func (s *MeasurementService) CreateMeasurements(ctx context.Context, body *Measurements) (*Measurements, *Response, error)

+ func (s *MeasurementService) Delete(ctx context.Context, ID string) (*Response, error)

+ func (s *MeasurementService) DeleteMeasurements(ctx context.Context, opt *MeasurementCollectionOptions) (*Response, error)

+ func (s *MeasurementService) GetMeasurement(ctx context.Context, ID string) (*Measurement, *Response, error)

+ func (s *MeasurementService) GetMeasurementSeries(ctx context.Context, opt *MeasurementSeriesOptions) (*MeasurementSeriesGroup, *Response, error)

+ func (s *MeasurementService) GetMeasurements(ctx context.Context, opt *MeasurementCollectionOptions) (*MeasurementCollection, *Response, error)

+ func (s *MeasurementService) NewMeasurementSourceByName(ctx context.Context, name string) (*MeasurementSource, error)

+ type MeasurementSource struct

+ ID string

+ Name string

+ type Measurements struct

+ Items []gjson.Result

+ Measurements []MeasurementRepresentation

+ type Message struct

+ Channel string

+ ClientID string

+ Extension interface{}

+ ID string

+ Payload RealtimeData

+ type MetaMessage struct

+ Advice *advice

+ ConnectionType string

+ Error string

+ MinimumVersion string

+ Subscription string

+ Successful bool

+ SupportedConnectionTypes []string

+ Timestamp string

+ Version string

+ type MicroserviceService service

+ func (s *MicroserviceService) GetServiceUsers() (*ApplicationSubscriptions, error)

+ func (s *MicroserviceService) SetServiceUsers() error

+ type NewDeviceRequest struct

+ ID string

+ Item gjson.Result

+ Self string

+ Status string

+ type NewDeviceRequestCollection struct

+ Items []gjson.Result

+ NewDeviceRequests []NewDeviceRequest

+ type NewDeviceRequestOptions struct

+ type Number struct

+ func NewNumber(value string) *Number

+ func (s *Number) IsNull() bool

+ func (s *Number) MarshalJSON() ([]byte, error)

+ func (s *Number) SimpleFloat64() float64

+ type Operation struct

+ CreationTime *Timestamp

+ Description string

+ DeviceID string

+ DeviceName string

+ EventID string

+ FailureReason string

+ ID string

+ Item gjson.Result

+ Self string

+ Status string

+ type OperationBuilder struct

+ func NewOperationAgentUpdateConfiguration(deviceID string, configuration string) *OperationBuilder

+ func NewOperationBuilder(deviceID string) *OperationBuilder

+ func (b *OperationBuilder) Set(name string, value interface{}) *OperationBuilder

+ func (b *OperationBuilder) SetDeviceID(ID string) *OperationBuilder

+ func (b OperationBuilder) DeviceID() string

+ func (b OperationBuilder) Get(name string) (interface{}, bool)

+ func (b OperationBuilder) MarshalJSON() ([]byte, error)

+ type OperationCollection struct

+ Items []gjson.Result

+ Operations []Operation

+ type OperationCollectionOptions struct

+ AgentID string

+ DeviceID string

+ Status string

+ type OperationService service

+ func (s *OperationService) Create(ctx context.Context, body interface{}) (*Operation, *Response, error)

+ func (s *OperationService) DeleteOperations(ctx context.Context, opt *OperationCollectionOptions) (*Response, error)

+ func (s *OperationService) GetOperation(ctx context.Context, ID string) (*Operation, *Response, error)

+ func (s *OperationService) GetOperations(ctx context.Context, opt *OperationCollectionOptions) (*OperationCollection, *Response, error)

+ func (s *OperationService) Update(ctx context.Context, ID string, body *OperationUpdateOptions) (*Operation, *Response, error)

+ type OperationUpdateOptions struct

+ FailureReason string

+ Status string

+ type PaginationOptions struct

+ PageSize int

+ WithTotalPages bool

+ func NewPaginationOptions(pageSize int) *PaginationOptions

+ type ParentDevices struct

+ References []ManagedObjectReference

+ Self string

+ type RealtimeClient struct

+ func NewRealtimeClient(host string, wsDialer *websocket.Dialer, tenant, username, password string) *RealtimeClient

+ func (c *RealtimeClient) Close() error

+ func (c *RealtimeClient) Connect() error

+ func (c *RealtimeClient) IsConnected() bool

+ func (c *RealtimeClient) Subscribe(pattern string, out chan<- *Message) error

+ func (c *RealtimeClient) TenantName() string

+ func (c *RealtimeClient) Unsubscribe(pattern string) error

+ func (c *RealtimeClient) UnsubscribeAll() (errs []error)

+ func (c *RealtimeClient) WaitForConnection() error

+ type RealtimeData struct

+ Data json.RawMessage

+ Item gjson.Result

+ RealtimeAction string

+ type RequestOptions struct

+ Accept string

+ Body interface{}

+ ContentType string

+ Host string

+ Method string

+ Path string

+ Query interface{}

+ ResponseData interface{}

+ type Response struct

+ JSON *gjson.Result

+ JSONData *string

+ func (r *Response) DecodeJSON(v interface{}) error

+ type RetentionRule struct

+ DataType string

+ Editable bool

+ FragmentType string

+ ID string

+ MaximumAge int64

+ Self string

+ Source string

+ Type string

+ type RetentionRuleCollection struct

+ RetentionRules []RetentionRule

+ type RetentionRuleService service

+ func (s *RetentionRuleService) Create(ctx context.Context, body RetentionRule) (*RetentionRule, *Response, error)

+ func (s *RetentionRuleService) Delete(ctx context.Context, ID string) (*Response, error)

+ func (s *RetentionRuleService) GetRetentionRule(ctx context.Context, ID string) (*RetentionRule, *Response, error)

+ func (s *RetentionRuleService) GetRetentionRules(ctx context.Context, opt *PaginationOptions) (*RetentionRuleCollection, *Response, error)

+ func (s *RetentionRuleService) Update(ctx context.Context, ID string, body RetentionRule) (*RetentionRule, *Response, error)

+ type Role struct

+ ID string

+ Name string

+ Self string

+ type RoleCollection struct

+ Roles []Role

+ Self string

+ type RoleOptions struct

+ type RoleReference struct

+ Role *Role

+ Self string

+ type RoleReferenceCollection struct

+ References []RoleReference

+ Self string

+ type ServiceUser struct

+ Password string

+ Tenant string

+ Username string

+ func DecodeBasicAuth(auth string, host string) (*ServiceUser, error)

+ type SimpleMeasurementOptions struct

+ FragmentType []string

+ SourceID string

+ Timestamp *time.Time

+ Type string

+ Unit string

+ Value interface{}

+ ValueFragmentSeries string

+ ValueFragmentType string

+ type Source struct

+ ID string

+ Self string

+ func NewSource(id string) *Source

+ type Statistics struct

+ CurrentPage *int

+ PageSize *int

+ TotalPages *int

+ type SupportedMeasurements struct

+ SupportedMeasurements []string

+ type SupportedOperationsFragment struct

+ SupportedOperations []string

+ type SupportedSeries struct

+ SupportedSeries []string

+ type Tenant struct

+ AdminEmail string

+ AdminName string

+ AdminPassword string

+ AllowCreateTenants bool

+ Applications *ApplicationReferenceCollection

+ Company string

+ ContactName string

+ ContactPhone string

+ CustomProperties interface{}

+ Domain string

+ ID string

+ OwnedApplications *ApplicationReferenceCollection

+ Parent string

+ Self string

+ SendPasswordResetEmail bool

+ Status string

+ StorageLimitPerDevice int64

+ func NewTenant(company, domain string) *Tenant

+ type TenantCollection struct

+ Tenants []Tenant

+ type TenantOption struct

+ Category string

+ Item gjson.Result

+ Key string

+ Value string

+ type TenantOptionCollection struct

+ Items []gjson.Result

+ Options []TenantOption

+ type TenantOptionsService service

+ func (s *TenantOptionsService) Create(ctx context.Context, body *TenantOption) (*TenantOption, *Response, error)

+ func (s *TenantOptionsService) Delete(ctx context.Context, category, key string) (*Response, error)

+ func (s *TenantOptionsService) GetOption(ctx context.Context, category, key string) (*TenantOption, *Response, error)

+ func (s *TenantOptionsService) GetOptions(ctx context.Context, opt *PaginationOptions) (*TenantOptionCollection, *Response, error)

+ func (s *TenantOptionsService) GetOptionsForCategory(ctx context.Context, category string) (map[string]string, *Response, error)

+ func (s *TenantOptionsService) GetSystemOption(ctx context.Context, category, key string) (*TenantOption, *Response, error)

+ func (s *TenantOptionsService) GetSystemOptions(ctx context.Context, opt *PaginationOptions) (*TenantOptionCollection, *Response, error)

+ func (s *TenantOptionsService) Update(ctx context.Context, category, key string, value string) (*TenantOption, *Response, error)

+ func (s *TenantOptionsService) UpdateEditability(ctx context.Context, category, key string, editable bool) (*TenantOption, *Response, error)

+ func (s *TenantOptionsService) UpdateOptions(ctx context.Context, category string, body map[string]string) (map[string]string, *Response, error)

+ type TenantService service

+ func (s *TenantService) AddApplicationReference(ctx context.Context, tenantID string, appSelfReference string) (*ApplicationReference, *Response, error)

+ func (s *TenantService) Create(ctx context.Context, body *Tenant) (*Tenant, *Response, error)

+ func (s *TenantService) Delete(ctx context.Context, ID string) (*Response, error)

+ func (s *TenantService) DeleteApplicationReference(ctx context.Context, tenantID string, applicationID string) (*Response, error)

+ func (s *TenantService) GetAllTenantsStatisticsSummary(ctx context.Context, opt *TenantStatisticsOptions) ([]TenantUsageStatisticsSummaryExtended, *Response, error)

+ func (s *TenantService) GetApplicationReferences(ctx context.Context, tenantID string, opts *PaginationOptions) (*ApplicationReferenceCollection, *Response, error)

+ func (s *TenantService) GetCurrentTenant(ctx context.Context) (*CurrentTenant, *Response, error)

+ func (s *TenantService) GetTenant(ctx context.Context, ID string) (*Tenant, *Response, error)

+ func (s *TenantService) GetTenantStatistics(ctx context.Context, opt *TenantStatisticsOptions) (*TenantUsageStatisticsCollection, *Response, error)

+ func (s *TenantService) GetTenantStatisticsSummary(ctx context.Context, opt *TenantSummaryOptions) (*TenantSummary, *Response, error)

+ func (s *TenantService) GetTenants(ctx context.Context, opt *PaginationOptions) (*TenantCollection, *Response, error)

+ func (s *TenantService) Update(ctx context.Context, ID string, body *Tenant) (*Tenant, *Response, error)

+ type TenantStatisticsOptions struct

+ DateFrom string

+ DateTo string

+ type TenantSummary struct

+ Day string

+ DeviceCount int64

+ DeviceEndpointCount int64

+ DeviceRequestCount int64

+ DeviceWithChildrenCount int64

+ RequestCount int64

+ Self string

+ StorageSize int64

+ SubscribedApplications []string

+ type TenantSummaryOptions struct

+ DateFrom string

+ DateTo string

+ type TenantUsageStatisticsCollection struct

+ UsageStatistics []TenantSummary

+ type TenantUsageStatisticsSummary struct

+ DeviceCount int64

+ DeviceEndpointCount int64

+ DeviceRequestCount int64

+ DeviceWithChildrenCount int64

+ RequestCount int64

+ StorageSize int64

+ SubscribedApplications []string

+ type TenantUsageStatisticsSummaryExtended struct

+ AlarmsCreatedCount int64

+ AlarmsUpdatedCount int64

+ CreationTime Timestamp

+ DeviceCount int64

+ DeviceEndpointCount int64

+ DeviceRequestCount int64

+ DeviceWithChildrenCount int64

+ EventsCreatedCount int64

+ EventsUpdatedCount int64

+ InventoriesCreatedCount int64

+ InventoriesUpdateCount int64

+ MeasurementsCreatedCount int64

+ ParentTenantID string

+ PeakDeviceCount int64

+ PeakDeviceWithChildrenCount int64

+ PeakStorageSize int64

+ RequestCount int64

+ StorageSize int64

+ SubscribedApplications []string

+ TenantCompany int64

+ TenantDomain string

+ TenantID string

+ TotalResourceCreateAndUpdateCount int64

+ type Timestamp struct

+ func NewTimestamp(value ...time.Time) *Timestamp

+ func (t *Timestamp) Equal(u Timestamp) bool

+ func (t *Timestamp) String() string

+ func (t *Timestamp) UnmarshalJSON(data []byte) (err error)

+ type User struct

+ CustomProperties interface{}

+ DevicePermissions map[string]interface{}

+ Email string

+ Enabled bool

+ FirstName string

+ Groups *GroupReferenceCollection

+ ID string

+ Item gjson.Result

+ LastName string

+ Password string

+ Phone string

+ Roles *RoleReferenceCollection

+ Self string

+ Username string

+ func NewUser(username string, email string, password string) *User

+ func (u *User) SetEmail(value string) *User

+ func (u *User) SetEnabled(value bool) *User

+ func (u *User) SetFirstName(value string) *User

+ func (u *User) SetLastName(value string) *User

+ func (u *User) SetPhone(value string) *User

+ type UserCollection struct

+ Items []gjson.Result

+ Users []User

+ type UserOptions struct

+ Groups []string

+ OnlyDevices bool

+ Owner string

+ Username string

+ WithSubusersCount bool

+ type UserReference struct

+ Self string

+ User *User

+ type UserReferenceCollection struct

+ References []UserReference

+ Self string

+ type UserService service

+ func (s *UserService) AddUserToGroup(ctx context.Context, user *User, groupID uint64) (*UserReference, *Response, error)

+ func (s *UserService) AssignRoleToGroup(ctx context.Context, groupID uint64, roleSelfReference string) (*RoleReference, *Response, error)

+ func (s *UserService) AssignRoleToUser(ctx context.Context, username string, roleSelfReference string) (*RoleReference, *Response, error)

+ func (s *UserService) Create(ctx context.Context, body *User) (*User, *Response, error)

+ func (s *UserService) CreateGroup(ctx context.Context, body *Group) (*Group, *Response, error)

+ func (s *UserService) Delete(ctx context.Context, ID string) (*Response, error)

+ func (s *UserService) DeleteGroup(ctx context.Context, ID uint64) (*Response, error)

+ func (s *UserService) GetCurrentUser(ctx context.Context) (*User, *Response, error)

+ func (s *UserService) GetGroup(ctx context.Context, ID uint64) (*Group, *Response, error)

+ func (s *UserService) GetGroupByName(ctx context.Context, name string) (*Group, *Response, error)

+ func (s *UserService) GetGroups(ctx context.Context, opt *GroupOptions) (*GroupCollection, *Response, error)

+ func (s *UserService) GetGroupsByUser(ctx context.Context, username string, opt *GroupOptions) (*GroupReferenceCollection, *Response, error)

+ func (s *UserService) GetRoles(ctx context.Context, opt *RoleOptions) (*RoleCollection, *Response, error)

+ func (s *UserService) GetRolesByGroup(ctx context.Context, groupID uint64, opt *RoleOptions) (*RoleReferenceCollection, *Response, error)

+ func (s *UserService) GetRolesByUser(ctx context.Context, username string, opt *RoleOptions) (*RoleReferenceCollection, *Response, error)

+ func (s *UserService) GetUser(ctx context.Context, ID string) (*User, *Response, error)

+ func (s *UserService) GetUserByUsername(ctx context.Context, username string) (*User, *Response, error)

+ func (s *UserService) GetUsers(ctx context.Context, opt *UserOptions) (*UserCollection, *Response, error)

+ func (s *UserService) GetUsersByGroup(ctx context.Context, groupID uint64, opt *UserOptions) (*UserReferenceCollection, *Response, error)

+ func (s *UserService) RemoveUserFromGroup(ctx context.Context, username string, groupID uint64) (*Response, error)

+ func (s *UserService) UnassignRoleFromGroup(ctx context.Context, groupID uint64, roleName string) (*Response, error)

+ func (s *UserService) UnassignRoleFromUser(ctx context.Context, username string, roleName string) (*Response, error)

+ func (s *UserService) Update(ctx context.Context, ID string, body *User) (*User, *Response, error)

+ func (s *UserService) UpdateCurrentUser(ctx context.Context, body *User) (*User, *Response, error)

+ func (s *UserService) UpdateGroup(ctx context.Context, ID uint64, body *Group) (*Group, *Response, error)

+ type ValueFragmentSeries struct

+ Name string

+ Unit string

+ Value interface{}

+ type ValueFragmentType struct

+ Name string

+ Values []ValueFragmentSeries

+ func (m ValueFragmentType) MarshalJSON() ([]byte, error)

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