api

package
v1.16.2 Latest Latest
Warning

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

 Go to latest Published: Apr 26, 2024 License: MPL-2.0 Imports: 9 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultFirewallSettings 

func DefaultFirewallSettings() map[string]interface{}

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(instanceID int, peeringID string, sleep, timeout int) (map[string]interface{}, error)

func (*API) AcceptVpcPeeringWithVpcId added in v1.6.0 

func (api *API) AcceptVpcPeeringWithVpcId(vpcID, peeringID string, sleep, timeout int) (map[string]interface{}, error)

func (*API) CreateAlarm 

func (api *API) CreateAlarm(instanceID int, params map[string]interface{}) (map[string]interface{}, error)

func (*API) CreateAwsEventBridge added in v1.11.0 

func (api *API) CreateAwsEventBridge(instanceID int, params map[string]interface{}) (map[string]interface{}, error)

func (*API) CreateCustomDomain added in v1.5.0 

func (api *API) CreateCustomDomain(instanceID int, hostname string) (map[string]interface{}, error)

func (*API) CreateFirewallSettings 

func (api *API) CreateFirewallSettings(instanceID int, params []map[string]interface{}, sleep,
	timeout int) ([]map[string]interface{}, error)

func (*API) CreateInstance 

func (api *API) CreateInstance(params map[string]interface{}) (map[string]interface{}, error)

func (*API) CreateIntegration added in v1.3.0 

func (api *API) CreateIntegration(instanceID int, intType string, intName string, params map[string]interface{}) (map[string]interface{}, error)

CreateIntegration enables integration communication, either for logs or metrics.

func (*API) CreateNotification 

func (api *API) CreateNotification(instanceID int, params map[string]interface{}) (map[string]interface{}, error)

func (*API) CreateVpcInstance added in v1.6.0 

func (api *API) CreateVpcInstance(params map[string]interface{}) (map[string]interface{}, error)

func (*API) CreateWebhook added in v1.3.4 

func (api *API) CreateWebhook(instanceID int, params map[string]interface{},
	sleep, timeout int) (map[string]interface{}, error)

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

func (*API) DefaultRmqVersion 

func (api *API) DefaultRmqVersion() (map[string]interface{}, error)

func (*API) DeleteAlarm 

func (api *API) DeleteAlarm(instanceID int, params map[string]interface{}) error

func (*API) DeleteAwsEventBridge added in v1.11.0 

func (api *API) DeleteAwsEventBridge(instanceID int, eventbridgeID string) error

func (*API) DeleteCustomDomain added in v1.5.0 

func (api *API) DeleteCustomDomain(instanceID int) (map[string]interface{}, error)

func (*API) DeleteFirewallSettings 

func (api *API) DeleteFirewallSettings(instanceID, sleep, timeout int) ([]map[string]interface{}, error)

func (*API) DeleteInstance 

func (api *API) DeleteInstance(instanceID string, keep_vpc bool) error

func (*API) DeleteIntegration added in v1.3.0 

func (api *API) DeleteIntegration(instanceID int, intType, intID string) error

DeleteIntegration removes log or metric integration.

func (*API) DeleteNotification 

func (api *API) DeleteNotification(instanceID int, recipientID string) error

func (*API) DeletePlugin added in v1.3.2 

func (api *API) DeletePlugin(instanceID int, pluginName string, sleep, timeout int) error

DeletePlugin: deletes a plugin from an instance.

func (*API) DeleteRabbitMqConfiguration added in v1.8.1 

func (api *API) DeleteRabbitMqConfiguration() error

func (*API) DeleteVpcInstance added in v1.6.0 

func (api *API) DeleteVpcInstance(vpcID string) error

func (*API) DeleteWebhook added in v1.3.4 

func (api *API) DeleteWebhook(instanceID int, webhookID string, sleep, timeout int) error

DeleteWebhook - removes a specific webhook for an instance

func (*API) DisablePlugin 

func (api *API) DisablePlugin(instanceID int, pluginName string, sleep, timeout int) (
	map[string]interface{}, error)

DisablePlugin: disables a plugin from an instance. 

func (api *API) DisablePrivatelink(instanceID int) error

DisablePrivatelink: Disable the PrivateLink feature

func (*API) DisableVpcConnect added in v1.14.0 

func (api *API) DisableVpcConnect(instanceID int) error

DisableVpcConnect: Disable the VPC Connect feature

func (*API) EnablePlugin 

func (api *API) EnablePlugin(instanceID int, pluginName string, sleep, timeout int) (
	map[string]interface{}, error)

EnablePlugin: enable a plugin on an instance. 

func (api *API) EnablePrivatelink(instanceID int, params map[string][]interface{},
	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 added in v1.14.0 

func (api *API) EnableVPC(instanceID int) error

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

func (*API) EnableVpcConnect added in v1.14.0 

func (api *API) EnableVpcConnect(instanceID int, params map[string][]interface{},
	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 added in v1.14.0 

func (api *API) InstallPluginCommunity(instanceID int, pluginName string, sleep, timeout int) (
	map[string]interface{}, error)

InstallPluginCommunity: install a community plugin on an instance.

func (*API) ListInstances added in v1.5.0 

func (api *API) ListInstances() ([]map[string]interface{}, error)

func (*API) ListPlugins added in v1.14.0 

func (api *API) ListPlugins(instanceID, sleep, timeout int) ([]map[string]interface{}, error)

ListPlugins: list plugins from an instance.

func (*API) ListPluginsCommunity added in v1.14.0 

func (api *API) ListPluginsCommunity(instanceID, sleep, timeout int) ([]map[string]interface{}, error)

ListPluginsCommunity: list all community plugins for an instance.

func (*API) ListVpcs added in v1.6.0 

func (api *API) ListVpcs() ([]map[string]interface{}, error)

func (*API) ListWebhooks added in v1.16.2 

func (api *API) ListWebhooks(instanceID int) (map[string]interface{}, error)

ListWebhooks - list all webhooks for an instance.

func (*API) PlanTypes added in v1.12.0 

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

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

func (*API) PostAction added in v1.7.0 

func (api *API) PostAction(instanceID int, nodeName string, action string) (map[string]interface{}, error)

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

func (*API) ReadAlarm 

func (api *API) ReadAlarm(instanceID int, alarmID string) (map[string]interface{}, error)

func (*API) ReadAlarms 

func (api *API) ReadAlarms(instanceID int) ([]map[string]interface{}, error)

func (*API) ReadAwsEventBridge added in v1.11.0 

func (api *API) ReadAwsEventBridge(instanceID int, eventbridgeID string) (map[string]interface{}, error)

func (*API) ReadAwsEventBridges added in v1.11.0 

func (api *API) ReadAwsEventBridges(instanceID int) (map[string]interface{}, error)

func (*API) ReadCredentials 

func (api *API) ReadCredentials(id int) (map[string]interface{}, error)

func (*API) ReadCustomDomain added in v1.5.0 

func (api *API) ReadCustomDomain(instanceID int) (map[string]interface{}, error)

func (*API) ReadFirewallSettings 

func (api *API) ReadFirewallSettings(instanceID int) ([]map[string]interface{}, error)

func (*API) ReadInstance 

func (api *API) ReadInstance(instanceID string) (map[string]interface{}, error)

func (*API) ReadInstances 

func (api *API) ReadInstances() ([]map[string]interface{}, error)

TODO: Rename to ListInstances

func (*API) ReadIntegration added in v1.3.0 

func (api *API) ReadIntegration(instanceID int, intType, intID string) (map[string]interface{}, error)

ReadIntegration retrieves a specific logs or metrics integration

func (*API) ReadNode added in v1.7.0 

func (api *API) ReadNode(instanceID int, nodeName string) (map[string]interface{}, error)

ReadNode - read out node information of a single node

func (*API) ReadNodes added in v1.3.1 

func (api *API) ReadNodes(instanceID int) ([]map[string]interface{}, error)

ReadNodes - read out node information of the cluster

func (*API) ReadNotification 

func (api *API) ReadNotification(instanceID int, recipientID string) (map[string]interface{}, error)

func (*API) ReadNotifications added in v1.1.1 

func (api *API) ReadNotifications(instanceID int) ([]map[string]interface{}, error)

func (*API) ReadPlugin 

func (api *API) ReadPlugin(instanceID int, pluginName string, sleep, timeout int) (
	map[string]interface{}, error)

ReadPlugin: reads a specific plugin from an instance.

func (*API) ReadPluginCommunity 

func (api *API) ReadPluginCommunity(instanceID int, pluginName string, sleep, timeout int) (
	map[string]interface{}, error)

ReadPluginCommunity: reads a specific community plugin from an instance. 

func (api *API) ReadPrivatelink(instanceID, sleep, timeout int) (map[string]interface{}, error)

ReadPrivatelink: Reads PrivateLink information

func (*API) ReadRabbitMqConfiguration added in v1.8.1 

func (api *API) ReadRabbitMqConfiguration(instanceID, sleep, timeout int) (map[string]interface{}, error)

func (*API) ReadVersions added in v1.7.0 

func (api *API) ReadVersions(instanceID int) (map[string]interface{}, error)

ReadVersions - Read versions RabbitMQ and Erlang can upgrade to

func (*API) ReadVpcConnect added in v1.14.0 

func (api *API) ReadVpcConnect(instanceID int) (map[string]interface{}, error)

ReadVpcConnect: Reads VPC Connect information

func (*API) ReadVpcGcpInfo added in v1.5.3 

func (api *API) ReadVpcGcpInfo(instanceID, sleep, timeout int) (map[string]interface{}, error)

ReadVpcGcpInfo: reads the VPC info from the API

func (*API) ReadVpcGcpInfoWithVpcId added in v1.6.0 

func (api *API) ReadVpcGcpInfoWithVpcId(vpcID string, sleep, timeout int) (
	map[string]interface{}, error)

ReadVpcGcpInfoWithVpcId: reads the VPC info from the API

func (*API) ReadVpcGcpPeering added in v1.5.3 

func (api *API) ReadVpcGcpPeering(instanceID, sleep, timeout int) (
	map[string]interface{}, error)

ReadVpcGcpPeering: reads the VPC peering from the API

func (*API) ReadVpcGcpPeeringWithVpcId added in v1.6.0 

func (api *API) ReadVpcGcpPeeringWithVpcId(vpcID string, sleep, timeout int) (
	map[string]interface{}, error)

func (*API) ReadVpcInfo 

func (api *API) ReadVpcInfo(instanceID int) (map[string]interface{}, error)

func (*API) ReadVpcInfoWithVpcId added in v1.6.0 

func (api *API) ReadVpcInfoWithVpcId(vpcID string) (map[string]interface{}, error)

func (*API) ReadVpcInstance added in v1.6.0 

func (api *API) ReadVpcInstance(vpcID string) (map[string]interface{}, error)

func (*API) ReadVpcPeeringRequest 

func (api *API) ReadVpcPeeringRequest(instanceID int, peeringID string) (map[string]interface{}, error)

func (*API) ReadVpcPeeringRequestWithVpcId added in v1.6.0 

func (api *API) ReadVpcPeeringRequestWithVpcId(vpcID, peeringID string) (map[string]interface{}, error)

func (*API) ReadWebhook added in v1.3.4 

func (api *API) ReadWebhook(instanceID int, webhookID string, sleep, timeout int) (
	map[string]interface{}, error)

ReadWebhook - retrieves a specific webhook for an instance

func (*API) RemoveVpcGcpPeering added in v1.5.3 

func (api *API) RemoveVpcGcpPeering(instanceID int, peerID string) error

RemoveVpcGcpPeering: removes a VPC peering from an instance.

func (*API) RemoveVpcGcpPeeringWithVpcId added in v1.6.0 

func (api *API) RemoveVpcGcpPeeringWithVpcId(vpcID, peerID string) error

RemoveVpcGcpPeeringWithVpcId: removes the VPC peering from the API

func (*API) RemoveVpcPeering 

func (api *API) RemoveVpcPeering(instanceID int, peeringID string, sleep, timeout int) error

func (*API) RemoveVpcPeeringWithVpcId added in v1.6.0 

func (api *API) RemoveVpcPeeringWithVpcId(vpcID, peeringID string, sleep, timeout int) error

func (*API) RequestVpcGcpPeering added in v1.5.3 

func (api *API) RequestVpcGcpPeering(instanceID int, params map[string]interface{},
	waitOnStatus bool, sleep, timeout int) (map[string]interface{}, error)

RequestVpcGcpPeering: requests a VPC peering from an instance.

func (*API) RequestVpcGcpPeeringWithVpcId added in v1.6.0 

func (api *API) RequestVpcGcpPeeringWithVpcId(vpcID string, params map[string]interface{},
	waitOnStatus bool, sleep, timeout int) (map[string]interface{}, error)

RequestVpcGcpPeeringWithVpcId: requests a VPC peering from an instance.

func (*API) ResizeDisk added in v1.9.0 

func (api *API) ResizeDisk(instanceID int, params map[string]interface{}, sleep, timeout int) (map[string]interface{}, error)

func (*API) RotateApiKey added in v1.13.0 

func (api *API) RotateApiKey(instanceID int) error

func (*API) RotatePassword added in v1.13.0 

func (api *API) RotatePassword(instanceID int) error

func (*API) UninstallPluginCommunity added in v1.14.0 

func (api *API) UninstallPluginCommunity(instanceID int, pluginName string, sleep, timeout int) (
	map[string]interface{}, error)

UninstallPluginCommunity: uninstall a community plugin from an instance.

func (*API) UpdateAlarm 

func (api *API) UpdateAlarm(instanceID int, params map[string]interface{}) error

func (*API) UpdateCustomDomain added in v1.5.0 

func (api *API) UpdateCustomDomain(instanceID int, hostname string) (map[string]interface{}, error)

func (*API) UpdateFirewallSettings 

func (api *API) UpdateFirewallSettings(instanceID int, params []map[string]interface{},
	sleep, timeout int) ([]map[string]interface{}, error)

func (*API) UpdateInstance 

func (api *API) UpdateInstance(instanceID string, params map[string]interface{}) error

func (*API) UpdateIntegration added in v1.3.0 

func (api *API) UpdateIntegration(instanceID int, intType, intID string, params map[string]interface{}) error

UpdateIntegration updated the integration with new information

func (*API) UpdateNotification 

func (api *API) UpdateNotification(instanceID int, recipientID string, params map[string]interface{}) error

func (*API) UpdatePlugin 

func (api *API) UpdatePlugin(instanceID int, pluginName string, enabled bool, sleep, timeout int) (
	map[string]interface{}, error)

UpdatePlugin: updates a plugin from an instance.

func (*API) UpdatePluginCommunity 

func (api *API) UpdatePluginCommunity(instanceID int, pluginName string, enabled bool,
	sleep, timeout int) (map[string]interface{}, error)

UpdatePluginCommunity: updates a community plugin from an instance. 

func (api *API) UpdatePrivatelink(instanceID int, params map[string][]interface{}) error

UpdatePrivatelink: Update allowed principals or subscriptions

func (*API) UpdateRabbitMqConfiguration added in v1.8.1 

func (api *API) UpdateRabbitMqConfiguration(instanceID int, params map[string]interface{},
	sleep, timeout int) error

func (*API) UpdateVpcConnect added in v1.14.0 

func (api *API) UpdateVpcConnect(instanceID int, params map[string][]interface{}) error

UpdateVpcConnect: Update allowlist for the VPC Connect

func (*API) UpdateVpcGcpPeering added in v1.5.3 

func (api *API) UpdateVpcGcpPeering(instanceID int, sleep, timeout int) (
	map[string]interface{}, error)

UpdateVpcGcpPeering: updates a VPC peering from an instance.

func (*API) UpdateVpcGcpPeeringWithVpcId added in v1.6.0 

func (api *API) UpdateVpcGcpPeeringWithVpcId(vpcID string, sleep, timeout int) (
	map[string]interface{}, error)

UpdateVpcGcpPeeringWithVpcId: updates the VPC peering from the API

func (*API) UpdateVpcInstance added in v1.6.0 

func (api *API) UpdateVpcInstance(vpcID string, params map[string]interface{}) error

func (*API) UpdateWebhook added in v1.16.2 

func (api *API) UpdateWebhook(instanceID int, webhookID string, params map[string]interface{},
	sleep, timeout int) error

UpdateWebhook - updates a specific webhook for an instance

func (*API) UpgradeRabbitMQ added in v1.7.0 

func (api *API) UpgradeRabbitMQ(instanceID int) (string, error)

UpgradeRabbitMQ - Upgrade to latest possible versions for both RabbitMQ and Erlang.

func (*API) UrlInformation 

func (api *API) UrlInformation(url string) map[string]interface{}

func (*API) ValidatePlan added in v1.12.0 

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

ValidatePlan: Check with backend if plan is valid

func (*API) ValidateRegion added in v1.12.0 

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

ValidateRegion: Check with backend if region is valid

type Plan added in v1.12.0 

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

type Region added in v1.12.0 

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

Source Files

View all Source files

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.