client

package

Go to main page

Versions in this module

v3

v3.4.16

Jan 31, 2025

Changes in this version

type AgentConfiguration

+ NetworkInterface string

type MicroserviceInfo

+ PubTags []string

+ SubTags []string

type RouterConfig

+ AuthenticatePeer *string

+ CaCert *string

+ RequireSsl *string

+ SaslMechanisms *string

+ SslProfile *string

+ TlsCert *string

+ TlsKey *string

v3.4.15

Dec 29, 2024

v3.4.14

Dec 5, 2024

v3.4.13

Nov 25, 2024

Changes in this version

type Client

+ func NewWithRefreshToken(opt Options, refreshToken string) (clt *Client, err error)

+ func SessionLogin(opt Options, token, email, password string) (clt *Client, err error)

+ func (clt *Client) GetRefreshToken() string

+ func (clt *Client) Profile(request WithTokenRequest) (err error, userResponse UserResponse)

+ func (clt *Client) Refresh(request RefreshTokenRequest) (err error)

+ func (clt *Client) SetRefreshToken(token string)

type LoginResponse

+ RefreshToken string

+ type RefreshTokenRequest struct

+ RefreshToken string

type User

+ AccessToken string

+ RefreshToken string

+ type WithTokenRequest struct

+ AccessToken string

v3.4.12

Nov 6, 2024

v3.4.11

Jul 22, 2024

Changes in this version

type MicroserviceInfo

+ CdiDevices []string

+ Platform string

+ RunAsUser string

+ Runtime string

v3.4.10-alpha2

Jul 18, 2024

retracted

v3.4.10-alpha1

Jul 18, 2024

retracted

v3.4.10-alpha0

Jul 18, 2024

v3.4.9

Apr 3, 2024

v3.4.8

Apr 2, 2024

retracted

v3.4.8-beta.6

Apr 3, 2024

retracted

v3.4.8-beta.5

Apr 2, 2024

retracted

v3.4.8-beta.4

Apr 2, 2024

retracted

v3.4.8-beta.3

Apr 2, 2024

retracted

v3.4.8-beta.2

Apr 2, 2024

retracted

v3.4.8-beta.1

Apr 2, 2024

retracted

v3.4.7

Apr 2, 2024

retracted

v3.4.6

Apr 2, 2024

retracted

v3.4.5

Apr 2, 2024

retracted

v3.4.4

Apr 2, 2024

retracted

v3.4.3

Apr 2, 2024

retracted

v3.4.2

Mar 26, 2024

v3.4.1

Mar 26, 2024

retracted

Changes in this version

type LoginRequest

+ Totp string

v3.4.0

Feb 15, 2024

retracted

v3.3.9

Feb 15, 2024

retracted

v3.3.8

Feb 15, 2024

retracted

v3.3.7

Feb 15, 2024

retracted

Changes in this version

type Client

+ func RefreshUserSubscriptionKey(opt Options, email, password string) (clt *Client, err error, userResponse string)

+ func (clt *Client) RefreshUserSubscriptionKeyCtl(request LoginRequest) (err error, subscriptionKey string)

v3.3.6

Feb 15, 2024

retracted

Changes in this version

+ func RefreshUser(opt Options, email, password string) (clt *Client, err error, userResponse UserResponse)

type Client

+ func (clt *Client) RefreshUserCtl(request LoginRequest) (err error, userResponse UserResponse)

+ type UserResponse struct

+ Email string

+ Name string

+ SubscriptionKey string

+ Surname string

v3.3.5

Feb 4, 2024

retracted

v3.3.4

Feb 4, 2024

retracted

Changes in this version

type User

+ SubscriptionKey string

v3.3.3

Feb 4, 2024

retracted

v3.3.2

Feb 3, 2024

retracted

Changes in this version

+ const ControllerPort

+ const ControllerPortString

+ const DefaultRouterName

+ const HTTP

+ const TCP

+ var AgentTypeAgentTypeIDDict = map[string]int

+ var AgentTypeIDAgentTypeDict = map[int]string

+ var IsVerbose bool

+ var RegistryTypeIDRegistryTypeDict = map[int]string

+ var RegistryTypeRegistryTypeIDDict = map[string]int

+ func SetGlobalRetries(retries Retries)

+ func SetVerbosity(verbose bool)

+ func Verbose(msg string)

+ type AgentConfiguration struct

+ AbstractedHardwareEnabled *bool

+ AvailableDiskThreshold *float64

+ BluetoothEnabled *bool

+ CPULimit *int64

+ ChangeFrequency *float64

+ DeviceScanFrequency *float64

+ DiskDirectory *string

+ DiskLimit *int64

+ DockerPruningFrequency *float64

+ DockerURL *string

+ Host *string

+ IsSystem *bool

+ LogDirectory *string

+ LogFileCount *int64

+ LogLevel *string

+ LogLimit *int64

+ MemoryLimit *int64

+ NetworkRouter *string

+ StatusFrequency *float64

+ TimeZone string

+ UpstreamRouters *[]string

+ WatchdogEnabled *bool

+ type AgentInfo struct

+ AbstractedHardwareEnabled bool

+ AvailableDiskThreshold *float64

+ BluetoothEnabled bool

+ CPULimit int64

+ CPUUsage float64

+ CPUViolation string

+ ChangeFrequency float64

+ CreatedTimeRFC3339 string

+ DaemonStatus string

+ Description string

+ DeviceScanFrequency float64

+ DiskDirectory string

+ DiskLimit int64

+ DiskUsage float64

+ DiskViolation string

+ DockerPruningFrequency *float64

+ DockerURL string

+ EdgeRouterPort *int

+ FogType int

+ Host string

+ IPAddress string

+ IPAddressExternal string

+ InterRouterPort *int

+ IsReadyToRollback bool

+ IsReadyToUpgrade bool

+ LastActive int64

+ LastCommandTimeMsUTC int64

+ LastStatusTimeMsUTC int64

+ Latitude float64

+ Location string

+ LogDirectory string

+ LogFileCount int64

+ LogLevel *string

+ LogLimit int64

+ Longitude float64

+ MemoryLimit int64

+ MemoryUsage float64

+ MemoryViolation string

+ MessageSpeed float64

+ MessagingPort *int

+ MicroserviceMessageCount int64

+ MicroserviceStatus string

+ Name string

+ NetworkInterface string

+ NetworkRouter *string

+ ProcessedMessaged int64

+ RepositoryCount int64

+ RepositoryStatus string

+ RouterMode string

+ StatusFrequency float64

+ SystemAvailableDisk float64

+ SystemAvailableMemory float64

+ Tags *[]string

+ TimeZone string

+ Tunnel string

+ UUID string

+ UpdatedTimeRFC3339 string

+ UpstreamRouters *[]string

+ UptimeMs int64

+ Version string

+ WatchdogEnabled bool

+ type AgentListFilter struct

+ Condition string

+ Key string

+ Value string

+ type AgentUpdateRequest struct

+ Description string

+ FogType *int64

+ Latitude float64

+ Location string

+ Longitude float64

+ Name string

+ Tags *[]string

+ UUID string

+ type ApplicationCreateResponse struct

+ ID int

+ type ApplicationInfo struct

+ Description string

+ ID int

+ IsActivated bool

+ IsSystem bool

+ Microservices []MicroserviceInfo

+ Name string

+ Routes []Route

+ UserID int

+ type ApplicationListResponse struct

+ Applications []ApplicationInfo

+ type ApplicationPatchRequest struct

+ Description *string

+ IsActivated *bool

+ IsSystem *bool

+ Name *string

+ type ApplicationRouteCreateRequest struct

+ From string

+ Name string

+ To string

+ type ApplicationTemplate struct

+ Application *ApplicationTemplateInfo

+ Description string

+ Name string

+ Variables []TemplateVariable

+ type ApplicationTemplateCreateRequest = ApplicationTemplate

+ type ApplicationTemplateCreateResponse struct

+ ID int

+ Name string

+ type ApplicationTemplateInfo struct

+ Microservices []interface{}

+ Routes []interface{}

+ type ApplicationTemplateListResponse struct

+ ApplicationTemplates []ApplicationTemplate

+ type ApplicationTemplateMetadataUpdateRequest struct

+ Description *string

+ Name *string

+ type ApplicationTemplateUpdateResponse = ApplicationTemplateCreateResponse

+ type CatalogImage struct

+ AgentTypeID int

+ ContainerImage string

+ type CatalogItemCreateRequest struct

+ Description string

+ Images []CatalogImage

+ Name string

+ RegistryID int

+ type CatalogItemCreateResponse struct

+ ID int

+ type CatalogItemInfo struct

+ Category string

+ Description string

+ ID int

+ Images []CatalogImage

+ Name string

+ RegistryID int

+ type CatalogItemUpdateRequest struct

+ Description string

+ ID int

+ Images []CatalogImage

+ Name string

+ RegistryID int

+ type CatalogListResponse struct

+ CatalogItems []CatalogItemInfo

+ type Client struct

+ func New(opt Options) *Client

+ func NewAndLogin(opt Options, email, password string) (clt *Client, err error)

+ func NewWithToken(opt Options, token string) (clt *Client, err error)

+ func (clt *Client) CreateAgent(request *CreateAgentRequest) (response CreateAgentResponse, err error)

+ func (clt *Client) CreateApplicationFromYAML(file io.Reader) (*ApplicationInfo, error)

+ func (clt *Client) CreateApplicationTemplateFromYAML(file io.Reader) (*ApplicationTemplate, error)

+ func (clt *Client) CreateCatalogItem(request *CatalogItemCreateRequest) (*CatalogItemInfo, error)

+ func (clt *Client) CreateFlow(name, description string) (*FlowInfo, error)

+ func (clt *Client) CreateHTTPEdgeResource(request *EdgeResourceMetadata) error

+ func (clt *Client) CreateMicroserviceFromYAML(file io.Reader) (*MicroserviceInfo, error)

+ func (clt *Client) CreateMicroservicePortMapping(uuid string, portMapping *MicroservicePortMappingInfo) (err error)

+ func (clt *Client) CreateMicroserviceRoute(uuid, destUUID string) (err error)

+ func (clt *Client) CreateRegistry(request *RegistryCreateRequest) (int, error)

+ func (clt *Client) CreateRoute(route *Route) (err error)

+ func (clt *Client) CreateUser(request User) error

+ func (clt *Client) DeleteAgent(uuid string) error

+ func (clt *Client) DeleteApplication(name string) (err error)

+ func (clt *Client) DeleteApplicationTemplate(name string) error

+ func (clt *Client) DeleteCatalogItem(id int) (err error)

+ func (clt *Client) DeleteEdgeResource(name, version string) error

+ func (clt *Client) DeleteFlow(id int) (err error)

+ func (clt *Client) DeleteMicroservice(uuid string) (err error)

+ func (clt *Client) DeleteMicroservicePortMapping(uuid string, portMapping *MicroservicePortMappingInfo) (err error)

+ func (clt *Client) DeleteMicroserviceRoute(uuid, destUUID string) (err error)

+ func (clt *Client) DeleteRegistry(id int) (err error)

+ func (clt *Client) DeleteRoute(appName, name string) (err error)

+ func (clt *Client) GetAccessToken() string

+ func (clt *Client) GetAgentByID(uuid string) (response *AgentInfo, err error)

+ func (clt *Client) GetAgentByName(name string, system bool) (*AgentInfo, error)

+ func (clt *Client) GetAgentProvisionKey(uuid string) (response GetAgentProvisionKeyResponse, err error)

+ func (clt *Client) GetAllApplications() (response *ApplicationListResponse, err error)

+ func (clt *Client) GetAllFlows() (response *FlowListResponse, err error)

+ func (clt *Client) GetAllMicroservicePublicPorts() (response []MicroservicePublicPort, err error)

+ func (clt *Client) GetAllMicroservices() (response *MicroserviceListResponse, err error)

+ func (clt *Client) GetApplicationByName(name string) (application *ApplicationInfo, err error)

+ func (clt *Client) GetApplicationTemplate(name string) (*ApplicationTemplate, error)

+ func (clt *Client) GetBaseURL() string

+ func (clt *Client) GetCatalog() (response *CatalogListResponse, err error)

+ func (clt *Client) GetCatalogItem(id int) (response *CatalogItemInfo, err error)

+ func (clt *Client) GetCatalogItemByName(name string) (*CatalogItemInfo, error)

+ func (clt *Client) GetDefaultRouter() (router Router, err error)

+ func (clt *Client) GetFlowByID(id int) (flow *FlowInfo, err error)

+ func (clt *Client) GetFlowByName(name string) (_ *FlowInfo, err error)

+ func (clt *Client) GetHTTPEdgeResourceByName(name, version string) (response EdgeResourceMetadata, err error)

+ func (clt *Client) GetMicroserviceByID(uuid string) (response *MicroserviceInfo, err error)

+ func (clt *Client) GetMicroserviceByName(appName, name string) (response *MicroserviceInfo, err error)

+ func (clt *Client) GetMicroservicePortMapping(uuid string) (response *MicroservicePortMappingListResponse, err error)

+ func (clt *Client) GetMicroservicesByApplication(application string) (response *MicroserviceListResponse, err error)

+ func (clt *Client) GetMicroservicesPerFlow(flowID int) (response *MicroserviceListResponse, err error)

+ func (clt *Client) GetRetries() Retries

+ func (clt *Client) GetRoute(appName, name string) (route Route, err error)

+ func (clt *Client) GetStatus() (status ControllerStatus, err error)

+ func (clt *Client) GetVersion() string

+ func (clt *Client) GetVersionNumbers() (major, minor, patch int, err error)

+ func (clt *Client) IsApplicationTemplateCapable() error

+ func (clt *Client) IsEdgeResourceCapable() error

+ func (clt *Client) LinkEdgeResource(request LinkEdgeResourceRequest) error

+ func (clt *Client) ListAgents(request ListAgentsRequest) (response ListAgentsResponse, err error)

+ func (clt *Client) ListApplicationTemplates() (*ApplicationTemplateListResponse, error)

+ func (clt *Client) ListEdgeResources() (response ListEdgeResourceResponse, err error)

+ func (clt *Client) ListRegistries() (response RegistryListResponse, err error)

+ func (clt *Client) ListRoutes() (response RouteListResponse, err error)

+ func (clt *Client) Login(request LoginRequest) (err error)

+ func (clt *Client) PatchApplication(name string, request *ApplicationPatchRequest) (*ApplicationInfo, error)

+ func (clt *Client) PatchRoute(appName, name string, route *Route) (err error)

+ func (clt *Client) PruneAgent(uuid string) (err error)

+ func (clt *Client) PutDefaultProxy(address string) (err error)

+ func (clt *Client) PutDefaultRouter(router Router) (err error)

+ func (clt *Client) PutPublicPortHost(protocol Protocol, host string) (err error)

+ func (clt *Client) RebootAgent(uuid string) (err error)

+ func (clt *Client) RollbackAgent(name string) error

+ func (clt *Client) SetAccessToken(token string)

+ func (clt *Client) SetRetries(retries Retries)

+ func (clt *Client) StartApplication(name string) (*ApplicationInfo, error)

+ func (clt *Client) StartFlow(id int) (*FlowInfo, error)

+ func (clt *Client) StopApplication(name string) (*ApplicationInfo, error)

+ func (clt *Client) StopFlow(id int) (*FlowInfo, error)

+ func (clt *Client) UnlinkEdgeResource(request LinkEdgeResourceRequest) error

+ func (clt *Client) UpdateAgent(request *AgentUpdateRequest) (*AgentInfo, error)

+ func (clt *Client) UpdateApplicationFromYAML(name string, file io.Reader) (*ApplicationInfo, error)

+ func (clt *Client) UpdateApplicationTemplateFromYAML(name string, file io.Reader) (*ApplicationTemplate, error)

+ func (clt *Client) UpdateApplicationTemplateMetadata(name string, newMeta *ApplicationTemplateMetadataUpdateRequest) error

+ func (clt *Client) UpdateCatalogItem(request *CatalogItemUpdateRequest) (*CatalogItemInfo, error)

+ func (clt *Client) UpdateFlow(request *FlowUpdateRequest) (*FlowInfo, error)

+ func (clt *Client) UpdateHTTPEdgeResource(name string, request *EdgeResourceMetadata) error

+ func (clt *Client) UpdateMicroserviceFromYAML(uuid string, file io.Reader) (*MicroserviceInfo, error)

+ func (clt *Client) UpdateMicroserviceRoutes(uuid string, currentRoutes, newRoutes []string) (err error)

+ func (clt *Client) UpdateRegistry(request RegistryUpdateRequest) error

+ func (clt *Client) UpdateRoute(route *Route) (err error)

+ func (clt *Client) UpdateUserPassword(request UpdateUserPasswordRequest) (err error)

+ func (clt *Client) UpgradeAgent(name string) error

+ type ConflictError struct

+ func NewConflictError(msg string) (err *ConflictError)

+ func (err *ConflictError) Error() string

+ type ControllerStatus struct

+ Status string

+ UptimeSeconds float64

+ Versions ControllerVersions

+ type ControllerVersions struct

+ Controller string

+ EcnViewer string

+ type CreateAgentRequest struct

+ type CreateAgentResponse struct

+ UUID string

+ type EdgeResourceDisplay struct

+ Color string

+ Icon string

+ Name string

+ type EdgeResourceMetadata struct

+ Custom map[string]interface{}

+ Description string

+ Display *EdgeResourceDisplay

+ Interface HTTPEdgeResource

+ InterfaceProtocol string

+ Name string

+ OrchestrationTags []string

+ Version string

+ type Error struct

+ func NewError(msg string) (err *Error)

+ func (err *Error) Error() string

+ type FlowCreateRequest struct

+ Description string

+ Name string

+ type FlowCreateResponse struct

+ ID int

+ Name string

+ type FlowInfo struct

+ Description string

+ ID int

+ IsActivated bool

+ IsSystem bool

+ Name string

+ UserID int

+ type FlowListResponse struct

+ Flows []FlowInfo

+ type FlowUpdateRequest struct

+ Description *string

+ ID int

+ IsActivated *bool

+ IsSystem *bool

+ Name *string

+ type GetAgentProvisionKeyResponse struct

+ ExpireTimeMsUTC int64

+ Key string

+ type HTTPEdgeResource struct

+ Endpoints []HTTPEndpoint

+ type HTTPEndpoint struct

+ Method string

+ Name string

+ URL string

+ type HTTPError struct

+ Code int

+ func NewHTTPError(message string, code int) (err *HTTPError)

+ func (err *HTTPError) Error() string

+ type InputError struct

+ func NewInputError(message string) (err *InputError)

+ func (err *InputError) Error() string

+ type InternalError struct

+ func NewInternalError(message string) (err *InternalError)

+ func (err *InternalError) Error() string

+ type LinkEdgeResourceRequest struct

+ AgentUUID string

+ EdgeResourceName string

+ EdgeResourceVersion string

+ type ListAgentsRequest struct

+ Filters []AgentListFilter

+ System bool

+ type ListAgentsResponse struct

+ Agents []AgentInfo

+ type ListEdgeResourceResponse struct

+ EdgeResources []EdgeResourceMetadata

+ type LoginRequest struct

+ Email string

+ Password string

+ type LoginResponse struct

+ AccessToken string

+ type MicroserviceCreateResponse struct

+ UUID string

+ type MicroserviceEnvironmentInfo struct

+ Key string

+ Value string

+ type MicroserviceExtraHost struct

+ Address string

+ Name string

+ Value string

+ type MicroserviceInfo struct

+ AgentUUID string

+ Application string

+ ApplicationID int

+ CatalogItemID int

+ Commands []string

+ Config string

+ Delete bool

+ DeleteWithCleanup bool

+ Env []MicroserviceEnvironmentInfo

+ ExtraHosts []MicroserviceExtraHost

+ FlowID int

+ Images []CatalogImage

+ LogSize int

+ Name string

+ Ports []MicroservicePortMappingInfo

+ RegistryID int

+ RootHostAccess bool

+ Status MicroserviceStatusInfo

+ UUID string

+ UserID int

+ Volumes []MicroserviceVolumeMappingInfo

+ type MicroserviceListResponse struct

+ Microservices []MicroserviceInfo

+ type MicroservicePortMappingInfo struct

+ External int64

+ Internal int64

+ Protocol string

+ Proxy *MicroserviceProxyPortInfo

+ Public *MicroservicePublicPortInfo

+ type MicroservicePortMappingListResponse struct

+ PortMappings []MicroservicePortMappingInfo

+ type MicroserviceProxyPortInfo struct

+ Host string

+ Port int64

+ Protocol string

+ type MicroservicePublicPort struct

+ MicroserviceUUID string

+ PublicPort PublicPort

+ type MicroservicePublicPortInfo struct

+ Enabled bool

+ Links []string

+ Protocol string

+ Router *MicroservicePublicPortRouterInfo

+ Schemes []string

+ type MicroservicePublicPortRouterInfo struct

+ Host string

+ Port int64

+ type MicroserviceStatusInfo struct

+ CPUUsage float64

+ ContainerID string

+ ErrorMessage string

+ MemoryUsage float64

+ OperatingDuration int64

+ Percentage float64

+ StartTime int64

+ Status string

+ type MicroserviceVolumeMappingInfo struct

+ AccessMode string

+ ContainerDestination string

+ HostDestination string

+ Type string

+ type NotFoundError struct

+ func NewNotFoundError(msg string) (err *NotFoundError)

+ func (err *NotFoundError) Error() string

+ type NotSupportedError struct

+ func NewNotSupportedError(capability string) (err *NotSupportedError)

+ func (err *NotSupportedError) Error() string

+ type Options struct

+ BaseURL *url.URL

+ Retries *Retries

+ Timeout int

+ type Protocol = string

+ type PublicPort struct

+ Port int

+ Protocol string

+ Queue string

+ type RegistryCreateRequest struct

+ Certificate string

+ Email string

+ IsPublic bool

+ Password string

+ RequiresCert bool

+ URL string

+ Username string

+ type RegistryCreateResponse struct

+ ID int

+ type RegistryInfo struct

+ Certificate string

+ Email string

+ ID int

+ IsPublic bool

+ IsSecure bool

+ RequiresCert bool

+ URL string

+ Username string

+ type RegistryListResponse struct

+ Registries []RegistryInfo

+ type RegistryUpdateRequest struct

+ Certificate *string

+ Email *string

+ ID int

+ IsPublic *bool

+ Password *string

+ RequiresCert *bool

+ URL *string

+ Username *string

+ type Retries struct

+ CustomMessage map[string]int

+ Timeout int

+ var GlobalRetriesPolicy Retries

+ type Route struct

+ Application string

+ DestMicroserviceUUID string

+ From string

+ Name string

+ SourceMicroserviceUUID string

+ To string

+ type RouteListResponse struct

+ Routes []Route

+ type Router struct

+ Host string

+ type RouterConfig struct

+ EdgeRouterPort *int

+ InterRouterPort *int

+ MessagingPort *int

+ RouterMode *string

+ type TemplateVariable struct

+ DefaultValue interface{}

+ Description string

+ Key string

+ Value interface{}

+ type UpdateConfigRequest struct

+ Key string

+ Value string

+ type UpdateUserPasswordRequest struct

+ NewPassword string

+ OldPassword string

+ type User struct

+ Email string

+ Name string

+ Password string

+ Surname string

Other modules containing this package

github.com/datasance/iofog-go-sdk

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