https://github.com/speakeasy-sdks/singlestore-sample-sdk
A Go SDK for accessing the SingleStore-Management-API
https://github.com/speakeasy-sdks/singlestore-sample-sdk
api golang management sdk singlestore
Last synced: about 1 year ago
JSON representation
A Go SDK for accessing the SingleStore-Management-API
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/singlestore-sample-sdk
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-10-11T21:22:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T19:18:42.000Z (about 2 years ago)
- Last Synced: 2025-04-11T23:47:11.752Z (about 1 year ago)
- Topics: api, golang, management, sdk, singlestore
- Language: Go
- Homepage: https://docs.singlestore.com/cloud/reference/management-api/
- Size: 170 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Golang SDK for Singlestore Management API
## SDK Installation
```bash
go get github.com/speakeasy-sdks/singlestore-sample-sdk
```
## SDK Example Usage
```go
package main
import (
"context"
"log"
singlestoresamplesdk "github.com/speakeasy-sdks/singlestore-sample-sdk"
"github.com/speakeasy-sdks/singlestore-sample-sdk/pkg/models/operations"
)
func main() {
s := singlestoresamplesdk.New(
singlestoresamplesdk.WithSecurity("api-auth-key"),
)
endTime := ""
startTime := ""
aggregateBy := operations.ListBillingUsageAggregateByHour
metric := 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](docs/sdks/billing/README.md)
* [List](docs/sdks/billing/README.md#list) - Lists the compute and storage usage of a organization
### [Organizations](docs/sdks/organizations/README.md)
* [Get](docs/sdks/organizations/README.md#get) - Gets information about the current organization
### [PrivateConnection](docs/sdks/privateconnection/README.md)
* [Create](docs/sdks/privateconnection/README.md#create) - Creates a new private connection
* [Delete](docs/sdks/privateconnection/README.md#delete) - Deletes a private connection
* [Get](docs/sdks/privateconnection/README.md#get) - Gets information about a private connection
* [Update](docs/sdks/privateconnection/README.md#update) - Updates a private connection
### [Regions](docs/sdks/regions/README.md)
* [List](docs/sdks/regions/README.md#list) - Lists all of the regions for the user that support workspaces
### [Stages](docs/sdks/stages/README.md)
* [Create](docs/sdks/stages/README.md#create) - Creates a new folder or uploads a file
* [Delete](docs/sdks/stages/README.md#delete) - Deletes a file or folder
* [Get](docs/sdks/stages/README.md#get) - Gets information about a folder or downloads a file
* [Update](docs/sdks/stages/README.md#update) - Modifies a file or folder in Stages
### [WorkspaceGroups](docs/sdks/workspacegroups/README.md)
* [Create](docs/sdks/workspacegroups/README.md#create) - Creates a new workspace group
* [CreateStorage](docs/sdks/workspacegroups/README.md#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](docs/sdks/workspacegroups/README.md#delete) - Terminates a workspace group
* [Get](docs/sdks/workspacegroups/README.md#get) - Gets information about a workspace group
* [GetPrivateConnection](docs/sdks/workspacegroups/README.md#getprivateconnection) - Gets private connection information for a workspace group
* [GetRecoveryBackup](docs/sdks/workspacegroups/README.md#getrecoverybackup) - Gets information about which regions you can setup as a disaster recovery backup
* [GetStorageStatus](docs/sdks/workspacegroups/README.md#getstoragestatus) - Gets information about the storage DR status of the workspace group
* [List](docs/sdks/workspacegroups/README.md#list) - Lists the workspace groups the user can access
* [Update](docs/sdks/workspacegroups/README.md#update) - Updates a workspace group
* [UpdateFailback](docs/sdks/workspacegroups/README.md#updatefailback) - Starts failback to the primary region
* [UpdateFailover](docs/sdks/workspacegroups/README.md#updatefailover) - Starts failover to the secondary region
* [UpdateStartFailoverTestMode](docs/sdks/workspacegroups/README.md#updatestartfailovertestmode) - Starts Failover test mode
* [UpdateStopFailoverTestMode](docs/sdks/workspacegroups/README.md#updatestopfailovertestmode) - Stops Failover test mode
### [Workspaces](docs/sdks/workspaces/README.md)
* [Create](docs/sdks/workspaces/README.md#create) - Creates a new workspace
* [CreateResume](docs/sdks/workspaces/README.md#createresume) - Resumes a workspace
* [CreateStorage](docs/sdks/workspaces/README.md#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](docs/sdks/workspaces/README.md#createsuspend) - Suspends a workspace
* [Delete](docs/sdks/workspaces/README.md#delete) - Terminates a workspace
* [Get](docs/sdks/workspaces/README.md#get) - Gets information about a workspace
* [GetOutbound](docs/sdks/workspaces/README.md#getoutbound) - Gets the outbound allow list for a workspace
* [GetPrivateConnection](docs/sdks/workspaces/README.md#getprivateconnection) - Gets private connection information for a workspace
* [GetRecoveryBackup](docs/sdks/workspaces/README.md#getrecoverybackup) - Gets information about which regions you can setup as a disaster recovery backup
* [GetStorageStatus](docs/sdks/workspaces/README.md#getstoragestatus) - Gets information about the storage DR status of the group in which the provided workspace belongs to
* [List](docs/sdks/workspaces/README.md#list) - Lists the workspaces the user can access
* [Update](docs/sdks/workspaces/README.md#update) - Updates information about a workspace
* [UpdateFailback](docs/sdks/workspaces/README.md#updatefailback) - Starts failback to the primary region
* [UpdateFailover](docs/sdks/workspaces/README.md#updatefailover) - Starts failover to the secondary region
* [UpdateStartFailoverTestMode](docs/sdks/workspaces/README.md#updatestartfailovertestmode) - Starts Failover test mode
* [UpdateStopFailoverTestMode](docs/sdks/workspaces/README.md#updatestopfailovertestmode) - Stops Failover test mode
# Dev Containers
Experience our SDK in an enhanced sandbox environment. Try it now in **GitHub Codespaces**!
* [Explore Dev Containers](.devcontainer/README.md)
# 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](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)