spanclient

package module

Go to main page

Versions in this module

v4

v4.1.4

Dec 3, 2020

Changes in this version

type ListCollectionDataOpts

+ Offset optional.String

type ListDeviceDataOpts

+ Offset optional.String

type OutputDataMessage

+ MessageId string

v4.0.10

Nov 14, 2020

v4.0.9

Nov 13, 2020

v4.0.8

Nov 13, 2020

Changes in this version

+ var ContextAPIKey = contextKey("apikey")

+ var ContextAccessToken = contextKey("accesstoken")

+ var ContextBasicAuth = contextKey("basic")

+ var ContextOAuth2 = contextKey("token")

+ func CacheExpires(r *http.Response) time.Time

+ func NewAuthContext(apiToken string) context.Context

+ type APIClient struct

+ CollectionsApi *CollectionsApiService

+ DatadumpApi *DatadumpApiService

+ DevicesApi *DevicesApiService

+ FotaApi *FotaApiService

+ OutputsApi *OutputsApiService

+ SystemApi *SystemApiService

+ func NewAPIClient(cfg *Configuration) *APIClient

+ func (c *APIClient) ChangeBasePath(path string)

+ func (c *APIClient) GetConfig() *Configuration

+ type APIKey struct

+ Key string

+ Prefix string

+ type APIResponse struct

+ Message string

+ Method string

+ Operation string

+ Payload []byte

+ RequestURL string

+ func NewAPIResponse(r *http.Response) *APIResponse

+ func NewAPIResponseWithError(errorMessage string) *APIResponse

+ type BasicAuth struct

+ Password string

+ UserName string

+ type CoApMetadata struct

+ Code string

+ Path string

+ type Collection struct

+ CollectionId string

+ FieldMask FieldMask

+ Firmware CollectionFirmware

+ Tags map[string]string

+ TeamId string

+ type CollectionFirmware struct

+ CurrentFirmwareId string

+ Management CollectionFirmwareFirmwareManagement

+ TargetFirmwareId string

+ type CollectionFirmwareFirmwareManagement string

+ const COLLECTION

+ const DEVICE

+ const DISABLED

+ const UNSPECIFIED

+ type CollectionsApiService service

+ func (a *CollectionsApiService) BroadcastMessage(ctx _context.Context, collectionId string, body SendMessageRequest) (MultiSendMessageResponse, *_nethttp.Response, error)

+ func (a *CollectionsApiService) CreateCollection(ctx _context.Context, body Collection) (Collection, *_nethttp.Response, error)

+ func (a *CollectionsApiService) DeleteCollection(ctx _context.Context, collectionId string) (Collection, *_nethttp.Response, error)

+ func (a *CollectionsApiService) ListCollectionData(ctx _context.Context, collectionId string, ...) (ListDataResponse, *_nethttp.Response, error)

+ func (a *CollectionsApiService) ListCollections(ctx _context.Context) (ListCollectionResponse, *_nethttp.Response, error)

+ func (a *CollectionsApiService) RetrieveCollection(ctx _context.Context, collectionId string) (Collection, *_nethttp.Response, error)

+ func (a *CollectionsApiService) UpdateCollection(ctx _context.Context, collectionId string, body Collection) (Collection, *_nethttp.Response, error)

+ type Configuration struct

+ BasePath string

+ Debug bool

+ DefaultHeader map[string]string

+ HTTPClient *http.Client

+ Host string

+ Scheme string

+ Servers []ServerConfiguration

+ UserAgent string

+ func NewConfiguration() *Configuration

+ func (c *Configuration) AddDefaultHeader(key string, value string)

+ func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

+ type CreateFirmwareRequest struct

+ CollectionId string

+ Filename string

+ Image string

+ Tags map[string]string

+ Version string

+ type DataDumpResponse struct

+ Collections []DumpedCollection

+ type DataStream interface

+ Close func() error

+ Recv func() (OutputDataMessage, error)

+ func NewCollectionDataStream(ctx context.Context, config *Configuration, collectionID string) (DataStream, error)

+ func NewDeviceDataStream(ctx context.Context, config *Configuration, collectionID, deviceID string) (DataStream, error)

+ type DatadumpApiService service

+ func (a *DatadumpApiService) DataDump(ctx _context.Context, body map[string]interface{}) (DataDumpResponse, *_nethttp.Response, error)

+ type Device struct

+ CollectionId string

+ DeviceId string

+ Firmware FirmwareMetadata

+ Imei string

+ Imsi string

+ Network NetworkMetadata

+ Tags map[string]string

+ type DevicesApiService service

+ func (a *DevicesApiService) CreateDevice(ctx _context.Context, collectionId string, body Device) (Device, *_nethttp.Response, error)

+ func (a *DevicesApiService) DeleteDevice(ctx _context.Context, collectionId string, deviceId string) (Device, *_nethttp.Response, error)

+ func (a *DevicesApiService) ListDeviceData(ctx _context.Context, collectionId string, deviceId string, ...) (ListDataResponse, *_nethttp.Response, error)

+ func (a *DevicesApiService) ListDevices(ctx _context.Context, collectionId string) (ListDevicesResponse, *_nethttp.Response, error)

+ func (a *DevicesApiService) RetrieveDevice(ctx _context.Context, collectionId string, deviceId string) (Device, *_nethttp.Response, error)

+ func (a *DevicesApiService) SendMessage(ctx _context.Context, collectionId string, deviceId string, ...) (map[string]interface{}, *_nethttp.Response, error)

+ func (a *DevicesApiService) UpdateDevice(ctx _context.Context, existingCollectionId string, deviceId string, ...) (Device, *_nethttp.Response, error)

+ type DumpedCollection struct

+ Collection Collection

+ Devices []DumpedDevice

+ Outputs []Output

+ type DumpedDevice struct

+ Device Device

+ type FieldMask struct

+ Imei bool

+ Imsi bool

+ Location bool

+ Msisdn bool

+ type Firmware struct

+ CollectionId string

+ Created string

+ Filename string

+ ImageId string

+ Length int32

+ Sha256 string

+ Tags map[string]string

+ Version string

+ type FirmwareMetadata struct

+ CurrentFirmwareId string

+ FirmwareVersion string

+ Manufacturer string

+ ModelNumber string

+ SerialNumber string

+ State string

+ StateMessage string

+ TargetFirmwareId string

+ type FirmwareUsageResponse struct

+ Current []string

+ ImageId string

+ Targeted []string

+ type FotaApiService service

+ func (a *FotaApiService) ClearFirmwareError(ctx _context.Context, collectionId string, deviceId string) (map[string]interface{}, *_nethttp.Response, error)

+ func (a *FotaApiService) CreateFirmware(ctx _context.Context, collectionId string, body CreateFirmwareRequest) (Firmware, *_nethttp.Response, error)

+ func (a *FotaApiService) DeleteFirmware(ctx _context.Context, collectionId string, imageId string) (Firmware, *_nethttp.Response, error)

+ func (a *FotaApiService) FirmwareUsage(ctx _context.Context, collectionId string, imageId string) (FirmwareUsageResponse, *_nethttp.Response, error)

+ func (a *FotaApiService) ListFirmware(ctx _context.Context, collectionId string) (ListFirmwareResponse, *_nethttp.Response, error)

+ func (a *FotaApiService) RetrieveFirmware(ctx _context.Context, collectionId string, imageId string) (Firmware, *_nethttp.Response, error)

+ func (a *FotaApiService) UpdateFirmware(ctx _context.Context, collectionId string, imageId string, body Firmware) (Firmware, *_nethttp.Response, error)

+ type GenericOpenAPIError struct

+ func (e GenericOpenAPIError) Body() []byte

+ func (e GenericOpenAPIError) Error() string

+ func (e GenericOpenAPIError) Model() interface{}

+ type ListCollectionDataOpts struct

+ End optional.String

+ Limit optional.Int32

+ Start optional.String

+ type ListCollectionResponse struct

+ Collections []Collection

+ type ListDataResponse struct

+ Data []OutputDataMessage

+ type ListDeviceDataOpts struct

+ End optional.String

+ Limit optional.Int32

+ Start optional.String

+ type ListDevicesResponse struct

+ Devices []Device

+ type ListFirmwareResponse struct

+ Images []Firmware

+ type ListOutputResponse struct

+ CollectionId string

+ Outputs []Output

+ type MessageSendResult struct

+ DeviceId string

+ Message string

+ type MultiSendMessageResponse struct

+ Errors []MessageSendResult

+ Failed int32

+ Sent int32

+ type NetworkMetadata struct

+ AllocatedAt string

+ AllocatedIp string

+ CellId string

+ type Output struct

+ CollectionId string

+ Config OutputConfig

+ Enabled bool

+ OutputId string

+ Tags map[string]string

+ Type OutputType

+ type OutputConfig struct

+ AsIsPayload bool

+ BasicAuthPass string

+ BasicAuthUser string

+ ClientId string

+ CustomHeaderName string

+ CustomHeaderValue string

+ DisableCertCheck bool

+ Endpoint string

+ EventName string

+ Host string

+ Key string

+ Password string

+ Port int32

+ TopicName string

+ Url string

+ Username string

+ type OutputDataMessage struct

+ CoapMetaData CoApMetadata

+ Device Device

+ Payload string

+ Received string

+ Transport string

+ Type OutputDataMessageOutputMessageType

+ UdpMetaData UdpMetadata

+ func (d *OutputDataMessage) PayloadBytes() ([]byte, error)

+ type OutputDataMessageOutputMessageType string

+ const DATA

+ const KEEPALIVE

+ const UNKNOWN

+ type OutputLogEntry struct

+ Message string

+ Repeated int32

+ Time string

+ type OutputLogs struct

+ Logs []OutputLogEntry

+ type OutputStatus struct

+ CollectionId string

+ Enabled bool

+ ErrorCount int32

+ Forwarded int32

+ OutputId string

+ Received int32

+ Retransmits int32

+ type OutputType string

+ const IFTTT

+ const MQTT

+ const UDP

+ const UNDEFINED

+ const WEBHOOK

+ type OutputsApiService service

+ func (a *OutputsApiService) CreateOutput(ctx _context.Context, collectionId string, body Output) (Output, *_nethttp.Response, error)

+ func (a *OutputsApiService) DeleteOutput(ctx _context.Context, collectionId string, outputId string) (Output, *_nethttp.Response, error)

+ func (a *OutputsApiService) ListOutputs(ctx _context.Context, collectionId string) (ListOutputResponse, *_nethttp.Response, error)

+ func (a *OutputsApiService) Logs(ctx _context.Context, collectionId string, outputId string) (OutputLogs, *_nethttp.Response, error)

+ func (a *OutputsApiService) RetrieveOutput(ctx _context.Context, collectionId string, outputId string) (Output, *_nethttp.Response, error)

+ func (a *OutputsApiService) Status(ctx _context.Context, collectionId string, outputId string) (OutputStatus, *_nethttp.Response, error)

+ func (a *OutputsApiService) UpdateOutput(ctx _context.Context, collectionId string, outputId string, body Output) (Output, *_nethttp.Response, error)

+ type ProtobufAny struct

+ TypeUrl string

+ Value string

+ type RuntimeError struct

+ Code int32

+ Details []ProtobufAny

+ Error string

+ Message string

+ type RuntimeStreamError struct

+ Details []ProtobufAny

+ GrpcCode int32

+ HttpCode int32

+ HttpStatus string

+ Message string

+ type SendMessageRequest struct

+ CoapPath string

+ CollectionId string

+ DeviceId string

+ Payload string

+ Port int32

+ Transport string

+ type ServerConfiguration struct

+ Description string

+ Url string

+ Variables map[string]ServerVariable

+ type ServerVariable struct

+ DefaultValue string

+ Description string

+ EnumValues []string

+ type SystemApiService service

+ func (a *SystemApiService) GetSystemInfo(ctx _context.Context) (SystemInfoResponse, *_nethttp.Response, error)

+ type SystemInfoResponse struct

+ BuildDate string

+ DefaultFieldMask FieldMask

+ ForcedFieldMask FieldMask

+ ReleaseName string

+ Version string

+ type UdpMetadata struct

+ LocalPort int32

+ RemotePort int32

+ type UpdateDeviceRequest struct

+ CollectionId string

+ DeviceId string

+ ExistingCollectionId string

+ Firmware FirmwareMetadata

+ Imei string

+ Imsi string

+ Tags map[string]string

Other modules containing this package

github.com/lab5e/spanclient-go

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