ionos-cloud/sdk-go-dbaas-postgres

IONOS Cloud SDK Go for Database as a Service Postgres

Go API client for ionoscloud

An enterprise-grade Database is provided as a Service (DBaaS) solution that can be managed through a browser-based "Data Center Designer" (DCD) tool or via an easy to use API.

The API allows you to create additional database clusters or modify existing ones. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 0.0.1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./ionoscloud"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.ionos.com/databases/postgresql

Class	Method	HTTP request	Description
BackupsApi	ClusterBackupsGet	Get /clusters/{clusterId}/backups	List backups of cluster
BackupsApi	ClustersBackupsFindById	Get /clusters/backups/{backupId}	Fetch a cluster backup
BackupsApi	ClustersBackupsGet	Get /clusters/backups	List cluster backups
ClustersApi	ClusterPostgresVersionsGet	Get /clusters/{clusterId}/postgresversions	List PostgreSQL versions
ClustersApi	ClustersDelete	Delete /clusters/{clusterId}	Delete a cluster
ClustersApi	ClustersFindById	Get /clusters/{clusterId}	Fetch a cluster
ClustersApi	ClustersGet	Get /clusters	List clusters
ClustersApi	ClustersPatch	Patch /clusters/{clusterId}	Patch a cluster
ClustersApi	ClustersPost	Post /clusters	Create a cluster
ClustersApi	PostgresVersionsGet	Get /clusters/postgresversions	List PostgreSQL versions
LogsApi	ClusterLogsGet	Get /clusters/{clusterId}/logs	Get logs of your cluster
MetadataApi	InfosVersionGet	Get /infos/version	Get the current API version
MetadataApi	InfosVersionsGet	Get /infos/versions	Fetch all API versions
RestoresApi	ClusterRestorePost	Post /clusters/{clusterId}/restore	In-place restore of a cluster

Documentation For Models

• APIVersion
• BackupLocation
• BackupMetadata
• BackupResponse
• ClusterBackup
• ClusterBackupList
• ClusterBackupListAllOf
• ClusterList
• ClusterListAllOf
• ClusterLogs
• ClusterLogsInstances
• ClusterLogsMessages
• ClusterProperties
• ClusterResponse
• Connection
• CreateClusterProperties
• CreateClusterRequest
• CreateRestoreRequest
• DBUser
• DayOfTheWeek
• ErrorMessage
• ErrorResponse
• Location
• MaintenanceWindow
• Metadata
• Pagination
• PaginationLinks
• PatchClusterProperties
• PatchClusterRequest
• PostgresVersionList
• PostgresVersionListData
• ResourceType
• State
• StorageType
• SynchronizationMode

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

License

SDK Go DBaaS Postgres is under the Apache 2.0 License.