api

package
v1.35.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 16, 2025 License: MPL-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API struct {
	// contains filtered or unexported fields
}

func New 

func New(baseUrl, apiKey string, useragent string, client *http.Client) *API

func (*API) AcceptVpcPeering 

func (api *API) AcceptVpcPeering(ctx context.Context, instanceID int, peeringID string, sleep,
	timeout int) (map[string]any, error)

func (*API) AcceptVpcPeeringWithVpcId 

func (api *API) AcceptVpcPeeringWithVpcId(ctx context.Context, vpcID, peeringID string, sleep,
	timeout int) (map[string]any, error)

func (*API) CreateAlarm 

func (api *API) CreateAlarm(ctx context.Context, instanceID int, params map[string]any) (
	map[string]any, error)

func (*API) CreateAwsEventBridge 

func (api *API) CreateAwsEventBridge(ctx context.Context, instanceID int, params map[string]any) (
	map[string]any, error)

func (*API) CreateCustomDomain 

func (api *API) CreateCustomDomain(ctx context.Context, instanceID int, hostname string) (
	map[string]any, error)

func (*API) CreateFirewallSettings 

func (api *API) CreateFirewallSettings(ctx context.Context, instanceID int, params []map[string]any,
	sleep, timeout int) ([]map[string]any, error)

func (*API) CreateInstance 

func (api *API) CreateInstance(ctx context.Context, params map[string]any) (map[string]any, error)

func (*API) CreateIntegration 

func (api *API) CreateIntegration(ctx context.Context, instanceID int, intType string,
	intName string, params map[string]any) (map[string]any, error)

CreateIntegration enables integration communication, either for logs or metrics.

func (*API) CreateNotification 

func (api *API) CreateNotification(ctx context.Context, instanceID int, params map[string]any) (
	map[string]any, error)

func (*API) CreateVpcInstance 

func (api *API) CreateVpcInstance(ctx context.Context, params map[string]any) (map[string]any, error)

func (*API) CreateWebhook 

func (api *API) CreateWebhook(ctx context.Context, instanceID int, params map[string]any,
	sleep, timeout int) (map[string]any, error)

CreateWebhook - create a webhook for a vhost and a specific qeueu

func (*API) DeleteAlarm 

func (api *API) DeleteAlarm(ctx context.Context, instanceID int, alarmID string) error

func (*API) DeleteAwsEventBridge 

func (api *API) DeleteAwsEventBridge(ctx context.Context, instanceID int, eventbridgeID string) error

func (*API) DeleteCustomDomain 

func (api *API) DeleteCustomDomain(ctx context.Context, instanceID int) (map[string]any, error)

func (*API) DeleteFirewallSettings 

func (api *API) DeleteFirewallSettings(ctx context.Context, instanceID, sleep, timeout int) (
	[]map[string]any, error)

func (*API) DeleteInstance 

func (api *API) DeleteInstance(ctx context.Context, instanceID string, keep_vpc bool) error

func (*API) DeleteIntegration 

func (api *API) DeleteIntegration(ctx context.Context, instanceID int, intType, intID string) error

DeleteIntegration removes log or metric integration.

func (*API) DeleteNotification 

func (api *API) DeleteNotification(ctx context.Context, instanceID int, recipientID string) error

func (*API) DeletePlugin 

func (api *API) DeletePlugin(ctx context.Context, instanceID int, pluginName string,
	sleep, timeout int) error

DeletePlugin: deletes a plugin from an instance.

func (*API) DeleteRabbitMqConfiguration 

func (api *API) DeleteRabbitMqConfiguration() error

func (*API) DeleteVpcInstance 

func (api *API) DeleteVpcInstance(ctx context.Context, vpcID string) error

func (*API) DeleteWebhook 

func (api *API) DeleteWebhook(ctx context.Context, instanceID int, webhookID string, sleep,
	timeout int) error

DeleteWebhook - removes a specific webhook for an instance

func (*API) DisablePlugin 

func (api *API) DisablePlugin(ctx context.Context, instanceID int, pluginName string, sleep,
	timeout int) (map[string]any, error)

DisablePlugin: disables a plugin from an instance. 

func (api *API) DisablePrivatelink(ctx context.Context, instanceID int) error

DisablePrivatelink: Disable the PrivateLink feature

func (*API) DisableVpcConnect 

func (api *API) DisableVpcConnect(ctx context.Context, instanceID int) error

DisableVpcConnect: Disable the VPC Connect feature

func (*API) EnablePlugin 

func (api *API) EnablePlugin(ctx context.Context, instanceID int, pluginName string, sleep,
	timeout int) (map[string]any, error)

EnablePlugin: enable a plugin on an instance. 

func (api *API) EnablePrivatelink(ctx context.Context, instanceID int, params map[string][]any,
	sleep, timeout int) error

EnablePrivatelink: Enable PrivateLink and wait until finished. Need to enable VPC for an instance, if no standalone VPC used. Wait until finished with configureable sleep and timeout.

func (*API) EnableVPC 

func (api *API) EnableVPC(ctx context.Context, instanceID int) error

enableVPC: Enable VPC for an instance Check if the instance already have a standalone VPC

func (*API) EnableVpcConnect 

func (api *API) EnableVpcConnect(ctx context.Context, instanceID int,
	params map[string][]any, sleep, timeout int) error

EnableVpcConnect: Enable VPC Connect and wait until finished. Need to enable VPC for an instance, if no standalone VPC used. Wait until finished with configureable sleep and timeout.

func (*API) InstallPluginCommunity 

func (api *API) InstallPluginCommunity(ctx context.Context, instanceID int, pluginName string,
	sleep, timeout int) (map[string]any, error)

InstallPluginCommunity: install a community plugin on an instance.

func (*API) ListAlarms 

func (api *API) ListAlarms(ctx context.Context, instanceID int) ([]map[string]any, error)

func (*API) ListInstances 

func (api *API) ListInstances(ctx context.Context) ([]map[string]any, error)

func (*API) ListNodes 

func (api *API) ListNodes(ctx context.Context, instanceID int) ([]map[string]any, error)

ListNodes - list all nodes of the cluster

func (*API) ListNotifications 

func (api *API) ListNotifications(ctx context.Context, instanceID int) ([]map[string]any, error)

func (*API) ListPlugins 

func (api *API) ListPlugins(ctx context.Context, instanceID, sleep, timeout int) (
	[]map[string]any, error)

ListPlugins: list plugins from an instance.

func (*API) ListPluginsCommunity 

func (api *API) ListPluginsCommunity(ctx context.Context, instanceID, sleep, timeout int) (
	[]map[string]any, error)

ListPluginsCommunity: list all community plugins for an instance.

func (*API) ListVpcs 

func (api *API) ListVpcs(ctx context.Context) ([]map[string]any, error)

func (*API) ListWebhooks 

func (api *API) ListWebhooks(ctx context.Context, instanceID int) (map[string]any, error)

ListWebhooks - list all webhooks for an instance.

func (*API) PlanTypes 

func (api *API) PlanTypes(old, new string) (string, string, error)

PlanTypes: Fetch if old/new plans are shared/dedicated

func (*API) PostAction 

func (api *API) PostAction(ctx context.Context, instanceID int, nodeName string, action string) (
	map[string]any, error)

PostAction - request an action for the node (e.g. start/stop/restart RabbitMQ)

func (*API) ReadAlarm 

func (api *API) ReadAlarm(ctx context.Context, instanceID int, alarmID string) (
	map[string]any, error)

func (*API) ReadAwsEventBridge 

func (api *API) ReadAwsEventBridge(ctx context.Context, instanceID int, eventbridgeID string) (
	map[string]any, error)

func (*API) ReadAwsEventBridges 

func (api *API) ReadAwsEventBridges(ctx context.Context, instanceID int) (map[string]any, error)

func (*API) ReadCredentials 

func (api *API) ReadCredentials(ctx context.Context, instanceID int) (map[string]any, error)

func (*API) ReadCustomDomain 

func (api *API) ReadCustomDomain(ctx context.Context, instanceID int) (map[string]any, error)

func (*API) ReadFirewallSettings 

func (api *API) ReadFirewallSettings(ctx context.Context, instanceID int) ([]map[string]any, error)

func (*API) ReadInstance 

func (api *API) ReadInstance(ctx context.Context, instanceID string) (map[string]any, error)

func (*API) ReadIntegration 

func (api *API) ReadIntegration(ctx context.Context, instanceID int, intType, intID string) (
	map[string]any, error)

ReadIntegration retrieves a specific logs or metrics integration

func (*API) ReadLavinMQVersions added in v1.32.0 

func (api *API) ReadLavinMQVersions(ctx context.Context, instanceID int) (map[string]any, error)

ReadVersions - Read versions LavinMQ can upgrade to

func (*API) ReadMaintenance added in v1.33.0 

func (api *API) ReadMaintenance(ctx context.Context, instanceID int) (model.Maintenance, error)

func (*API) ReadNode 

func (api *API) ReadNode(ctx context.Context, instanceID int, nodeName string) (
	map[string]any, error)

ReadNode - read out node information of a single node

func (*API) ReadNotification 

func (api *API) ReadNotification(ctx context.Context, instanceID int, recipientID string) (
	map[string]any, error)

func (*API) ReadPlugin 

func (api *API) ReadPlugin(ctx context.Context, instanceID int, pluginName string, sleep,
	timeout int) (map[string]any, error)

ReadPlugin: reads a specific plugin from an instance.

func (*API) ReadPluginCommunity 

func (api *API) ReadPluginCommunity(ctx context.Context, instanceID int, pluginName string, sleep,
	timeout int) (map[string]any, error)

ReadPluginCommunity: reads a specific community plugin from an instance. 

func (api *API) ReadPrivatelink(ctx context.Context, instanceID, sleep, timeout int) (
	map[string]any, error)

ReadPrivatelink: Reads PrivateLink information

func (*API) ReadRabbitMqConfiguration 

func (api *API) ReadRabbitMqConfiguration(ctx context.Context, instanceID, sleep, timeout int) (
	model.RabbitMqConfigResponse, error)

func (*API) ReadVersions 

func (api *API) ReadVersions(ctx context.Context, instanceID int) (map[string]any, error)

ReadVersions - Read versions RabbitMQ and Erlang can upgrade to

func (*API) ReadVpcConnect 

func (api *API) ReadVpcConnect(ctx context.Context, instanceID int) (map[string]any, error)

ReadVpcConnect: Reads VPC Connect information

func (*API) ReadVpcGcpInfo 

func (api *API) ReadVpcGcpInfo(ctx context.Context, instanceID, sleep, timeout int) (
	map[string]any, error)

ReadVpcGcpInfo: reads the VPC info from the API

func (*API) ReadVpcGcpInfoWithVpcId 

func (api *API) ReadVpcGcpInfoWithVpcId(ctx context.Context, vpcID string, sleep, timeout int) (
	map[string]any, error)

ReadVpcGcpInfoWithVpcId: reads the VPC info from the API

func (*API) ReadVpcGcpPeering 

func (api *API) ReadVpcGcpPeering(ctx context.Context, instanceID, sleep, timeout int) (
	map[string]any, error)

ReadVpcGcpPeering: reads the VPC peering from the API

func (*API) ReadVpcGcpPeeringWithVpcId 

func (api *API) ReadVpcGcpPeeringWithVpcId(ctx context.Context, vpcID string, sleep, timeout int) (
	map[string]any, error)

func (*API) ReadVpcInfo 

func (api *API) ReadVpcInfo(ctx context.Context, instanceID int) (map[string]any, error)

func (*API) ReadVpcInfoWithVpcId 

func (api *API) ReadVpcInfoWithVpcId(ctx context.Context, vpcID string) (map[string]any, error)

func (*API) ReadVpcInstance 

func (api *API) ReadVpcInstance(ctx context.Context, vpcID string) (map[string]any, error)

func (*API) ReadVpcPeeringRequest 

func (api *API) ReadVpcPeeringRequest(ctx context.Context, instanceID int, peeringID string) (
	map[string]any, error)

func (*API) ReadVpcPeeringRequestWithVpcId 

func (api *API) ReadVpcPeeringRequestWithVpcId(ctx context.Context, vpcID, peeringID string) (
	map[string]any, error)

func (*API) ReadWebhook 

func (api *API) ReadWebhook(ctx context.Context, instanceID int, webhookID string, sleep,
	timeout int) (map[string]any, error)

ReadWebhook - retrieves a specific webhook for an instance

func (*API) RemoveVpcGcpPeering 

func (api *API) RemoveVpcGcpPeering(ctx context.Context, instanceID int, peerID string) error

RemoveVpcGcpPeering: removes a VPC peering from an instance.

func (*API) RemoveVpcGcpPeeringWithVpcId 

func (api *API) RemoveVpcGcpPeeringWithVpcId(ctx context.Context, vpcID, peerID string) error

RemoveVpcGcpPeeringWithVpcId: removes the VPC peering from the API

func (*API) RemoveVpcPeering 

func (api *API) RemoveVpcPeering(ctx context.Context, instanceID int, peeringID string,
	sleep, timeout int) error

func (*API) RemoveVpcPeeringWithVpcId 

func (api *API) RemoveVpcPeeringWithVpcId(ctx context.Context, vpcID, peeringID string, sleep,
	timeout int) error

func (*API) RequestVpcGcpPeering 

func (api *API) RequestVpcGcpPeering(ctx context.Context, instanceID int, params map[string]any,
	waitOnStatus bool, sleep, timeout int) (map[string]any, error)

RequestVpcGcpPeering: requests a VPC peering from an instance.

func (*API) RequestVpcGcpPeeringWithVpcId 

func (api *API) RequestVpcGcpPeeringWithVpcId(ctx context.Context, vpcID string,
	params map[string]any, waitOnStatus bool, sleep, timeout int) (map[string]any, error)

RequestVpcGcpPeeringWithVpcId: requests a VPC peering from an instance.

func (*API) ResizeDisk 

func (api *API) ResizeDisk(ctx context.Context, instanceID int, params map[string]any,
	sleep, timeout int) (map[string]any, error)

func (*API) RotateApiKey 

func (api *API) RotateApiKey(ctx context.Context, instanceID int) error

func (*API) RotatePassword 

func (api *API) RotatePassword(ctx context.Context, instanceID int) error

func (*API) SetMaintenance added in v1.33.0 

func (api *API) SetMaintenance(ctx context.Context, instanceID int, data model.Maintenance) error

func (*API) UninstallPluginCommunity 

func (api *API) UninstallPluginCommunity(ctx context.Context, instanceID int, pluginName string,
	sleep, timeout int) (map[string]any, error)

UninstallPluginCommunity: uninstall a community plugin from an instance.

func (*API) UpdateAlarm 

func (api *API) UpdateAlarm(ctx context.Context, instanceID int, params map[string]any) error

func (*API) UpdateCustomDomain 

func (api *API) UpdateCustomDomain(ctx context.Context, instanceID int, hostname string) (
	map[string]any, error)

func (*API) UpdateFirewallSettings 

func (api *API) UpdateFirewallSettings(ctx context.Context, instanceID int, params []map[string]any,
	sleep, timeout int) ([]map[string]any, error)

func (*API) UpdateInstance 

func (api *API) UpdateInstance(ctx context.Context, instanceID string, params map[string]any) error

func (*API) UpdateIntegration 

func (api *API) UpdateIntegration(ctx context.Context, instanceID int, intType, intID string,
	params map[string]any) error

UpdateIntegration updated the integration with new information

func (*API) UpdateNotification 

func (api *API) UpdateNotification(ctx context.Context, instanceID int, recipientID string,
	params map[string]any) error

func (*API) UpdatePlugin 

func (api *API) UpdatePlugin(ctx context.Context, instanceID int, pluginName string, enabled bool,
	sleep, timeout int) (map[string]any, error)

UpdatePlugin: updates a plugin from an instance.

func (*API) UpdatePluginCommunity 

func (api *API) UpdatePluginCommunity(ctx context.Context, instanceID int, pluginName string,
	enabled bool, sleep, timeout int) (map[string]any, error)

UpdatePluginCommunity: updates a community plugin from an instance. 

func (api *API) UpdatePrivatelink(ctx context.Context, instanceID int, params map[string][]any) error

UpdatePrivatelink: Update allowed principals or subscriptions

func (*API) UpdateRabbitMqConfiguration 

func (api *API) UpdateRabbitMqConfiguration(ctx context.Context, instanceID int,
	params model.RabbitMqConfigRequest, sleep, timeout int) error

func (*API) UpdateVpcConnect 

func (api *API) UpdateVpcConnect(ctx context.Context, instanceID int,
	params map[string][]any) error

UpdateVpcConnect: Update allowlist for the VPC Connect

func (*API) UpdateVpcGcpPeering 

func (api *API) UpdateVpcGcpPeering(ctx context.Context, instanceID int, sleep, timeout int) (
	map[string]any, error)

UpdateVpcGcpPeering: updates a VPC peering from an instance.

func (*API) UpdateVpcGcpPeeringWithVpcId 

func (api *API) UpdateVpcGcpPeeringWithVpcId(ctx context.Context, vpcID string, sleep, timeout int) (
	map[string]any, error)

func (*API) UpdateVpcInstance 

func (api *API) UpdateVpcInstance(ctx context.Context, vpcID string, params map[string]any) error

func (*API) UpdateWebhook 

func (api *API) UpdateWebhook(ctx context.Context, instanceID int, webhookID string,
	params map[string]any, sleep, timeout int) error

UpdateWebhook - updates a specific webhook for an instance

func (*API) UpgradeLavinMQ added in v1.32.0 

func (api *API) UpgradeLavinMQ(ctx context.Context, instanceID int, new_version string) (
	string, error)

UpgradeLavinMQ - Upgrade to latest possible version or a specific available version

func (*API) UpgradeRabbitMQ 

func (api *API) UpgradeRabbitMQ(ctx context.Context, instanceID int, current_version,
	new_version string) (string, error)

UpgradeRabbitMQ - Upgrade to latest possible version or a specific available version

func (*API) UpgradeToLatestLavinMQVersion added in v1.32.0 

func (api *API) UpgradeToLatestLavinMQVersion(ctx context.Context, instanceID int) (string, error)

func (*API) UpgradeToLatestVersion added in v1.31.0 

func (api *API) UpgradeToLatestVersion(ctx context.Context, instanceID int) (string, error)

func (*API) UpgradeToSpecificLavinMQVersion added in v1.32.0 

func (api *API) UpgradeToSpecificLavinMQVersion(ctx context.Context, instanceID int, version string) (
	string, error)

func (*API) UpgradeToSpecificVersion added in v1.31.0 

func (api *API) UpgradeToSpecificVersion(ctx context.Context, instanceID int, version string) (
	string, error)

func (*API) UrlInformation 

func (api *API) UrlInformation(url string) map[string]any

func (*API) ValidatePlan 

func (api *API) ValidatePlan(name string) error

ValidatePlan: Check with backend if plan is valid

func (*API) ValidateRegion 

func (api *API) ValidateRegion(region string) error

ValidateRegion: Check with backend if region is valid

type Plan 

type Plan struct {
	Name    string `json:"name"`
	Backend string `json:"backend"`
	Shared  bool   `json:"shared"`
}

type Region 

type Region struct {
	Provider string `json:"provider"`
	Region   string `json:"region"`
}

Source Files

View all Source files

Directories

Path Synopsis
models
instance
instance/configuration

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.