singlestoresamplesdk

README

Golang SDK for Singlestore Management API

SDK Installation

go get github.com/speakeasy-sdks/singlestore-sample-sdk

SDK Example Usage

package main

import (
	"context"
	singlestoresamplesdk "github.com/speakeasy-sdks/singlestore-sample-sdk"
	"github.com/speakeasy-sdks/singlestore-sample-sdk/pkg/models/operations"
	"github.com/speakeasy-sdks/singlestore-sample-sdk/pkg/models/shared"
	"log"
)

func main() {
	s := singlestoresamplesdk.New(
		singlestoresamplesdk.WithSecurity(""),
	)

	var endTime string = "Bicycle"

	var startTime string = "Metal"

	var aggregateBy *operations.ListBillingUsageAggregateBy = operations.ListBillingUsageAggregateByHour

	var metric *operations.ListBillingUsageMetric = operations.ListBillingUsageMetricComputeCredit

	ctx := context.Background()
	res, err := s.Billing.List(ctx, endTime, startTime, aggregateBy, metric)
	if err != nil {
		log.Fatal(err)
	}

	if res.BillingUsage != nil {
		// handle response
	}
}

Available Resources and Operations

Billing

• List - Lists the compute and storage usage of a organization

Organizations

• Get - Gets information about the current organization

PrivateConnection

• Create - Creates a new private connection
• Delete - Deletes a private connection
• Get - Gets information about a private connection
• Update - Updates a private connection

Regions

• List - Lists all of the regions for the user that support workspaces

Stages

• Create - Creates a new folder or uploads a file
• Delete - Deletes a file or folder
• Get - Gets information about a folder or downloads a file
• Update - Modifies a file or folder in Stages

WorkspaceGroups

• Create - Creates a new workspace group
• CreateStorage - Sets up Storage DR for the workspace group. Backup region and selected databases to be replicated are provided as part of the request.
• Delete - Terminates a workspace group
• Get - Gets information about a workspace group
• GetPrivateConnection - Gets private connection information for a workspace group
• GetRecoveryBackup - Gets information about which regions you can setup as a disaster recovery backup
• GetStorageStatus - Gets information about the storage DR status of the workspace group
• List - Lists the workspace groups the user can access
• Update - Updates a workspace group
• UpdateFailback - Starts failback to the primary region
• UpdateFailover - Starts failover to the secondary region
• UpdateStartFailoverTestMode - Starts Failover test mode
• UpdateStopFailoverTestMode - Stops Failover test mode

Workspaces

• Create - Creates a new workspace
• CreateResume - Resumes a workspace
• CreateStorage - Sets up Storage DR for the workspace group of the provided workspace. Backup region and selected databases to be replicated are provided as part of the request.
• CreateSuspend - Suspends a workspace
• Delete - Terminates a workspace
• Get - Gets information about a workspace
• GetOutbound - Gets the outbound allow list for a workspace
• GetPrivateConnection - Gets private connection information for a workspace
• GetRecoveryBackup - Gets information about which regions you can setup as a disaster recovery backup
• GetStorageStatus - Gets information about the storage DR status of the group in which the provided workspace belongs to
• List - Lists the workspaces the user can access
• Update - Updates information about a workspace
• UpdateFailback - Starts failback to the primary region
• UpdateFailover - Starts failover to the secondary region
• UpdateStartFailoverTestMode - Starts Failover test mode
• UpdateStopFailoverTestMode - Stops Failover test mode

Dev Containers

Experience our SDK in an enhanced sandbox environment. Try it now in GitHub Codespaces!

• Explore Dev Containers

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

Documentation

Index

• Variables
• func Bool(b bool) *bool
• func Float32(f float32) *float32
• func Float64(f float64) *float64
• func Int(i int) *int
• func Int64(i int64) *int64
• func String(s string) *string
• type HTTPClient
• type SDKOption
  • func WithClient(client HTTPClient) SDKOption
  • func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
  • func WithSecurity(apiKeyAuth string) SDKOption
  • func WithServerIndex(serverIndex int) SDKOption
  • func WithServerURL(serverURL string) SDKOption
  • func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption
• type Singlestore
  • func New(opts ...SDKOption) *Singlestore

Variables

var ServerList = []string{
	"https://api.singlestore.com",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func String

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient provides an interface for suplying the SDK with a custom HTTP client

type SDKOption

type SDKOption func(*Singlestore)

func WithClient

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithRetryConfig

func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption

func WithSecurity

func WithSecurity(apiKeyAuth string) SDKOption

func WithServerIndex

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters

type Singlestore

type Singlestore struct {
	// Operations related to billing
	Billing *billing
	// Operations related to organizations
	Organizations     *organizations
	PrivateConnection *privateConnection
	// Operations related to regions
	Regions *regions
	// Operations related to stages
	Stages          *stages
	WorkspaceGroups *workspaceGroups
	// Operations related to workspaces
	Workspaces *workspaces
	// contains filtered or unexported fields
}

Singlestore - SingleStore Management API: The `Management` API can be used to create and manage workspaces, workspace groups, private connections, etc. SingleStore recommends reading the [`Management` API Overview](https://docs.singlestore.com/managed-service/en/reference/management-api.html) before getting started with the API reference.

All the URLs referenced in this API documentation use the `https://api.singlestore.com` service endpoint as their base.

func New

func New(opts ...SDKOption) *Singlestore

New creates a new instance of the SDK with the provided options