Developer-friendly & type-safe Go SDK specifically catered to leverage sfc API.
Important
This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.
To add the SDK as a dependency to your project:
go get github.com/sfcompute/sfc-go-sdkpackage main
import (
"context"
sfc "github.com/sfcompute/sfc-go-sdk"
"github.com/sfcompute/sfc-go-sdk/models/operations"
"log"
"os"
)
func main() {
ctx := context.Background()
s := sfc.New(
sfc.WithSecurity(os.Getenv("SFC_BEARER_AUTH")),
)
res, err := s.Capacities.List(ctx, operations.ListCapacitiesRequest{
Workspace: "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
ID: []string{
"cap_k3R-nX9vLm7Qp2Yw5Jd8F",
},
StartingAfter: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
EndingBefore: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
})
if err != nil {
log.Fatal(err)
}
if res.ListCapacitiesResponse != nil {
for {
// handle items
res, err = res.Next()
if err != nil {
// handle error
}
if res == nil {
break
}
}
}
}This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
BearerAuth |
http | HTTP Bearer | SFC_BEARER_AUTH |
You can configure it using the WithSecurity option when initializing the SDK client instance. For example:
package main
import (
"context"
sfc "github.com/sfcompute/sfc-go-sdk"
"github.com/sfcompute/sfc-go-sdk/models/operations"
"log"
"os"
)
func main() {
ctx := context.Background()
s := sfc.New(
sfc.WithSecurity(os.Getenv("SFC_BEARER_AUTH")),
)
res, err := s.Capacities.List(ctx, operations.ListCapacitiesRequest{
Workspace: "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
ID: []string{
"cap_k3R-nX9vLm7Qp2Yw5Jd8F",
},
StartingAfter: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
EndingBefore: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
})
if err != nil {
log.Fatal(err)
}
if res.ListCapacitiesResponse != nil {
for {
// handle items
res, err = res.Next()
if err != nil {
// handle error
}
if res == nil {
break
}
}
}
}Available methods
- List - List capacities
- Create - Create capacity
- Fetch - Get capacity
- Delete - Delete capacity
- Update - Update capacity
- List - List deployments
- Create - Create deployment
- GetDeployment - Get deployment
- Delete - Delete deployment
- PatchDeployment - Update deployment
- List - List images
- StartUpload - Create image
- Fetch - Get image
- Delete - Delete image
- CompleteUpload - Complete image upload
- Download - Download image
- UploadPart - Get upload part URL
- List - List node templates
- Create - Create node template
- Fetch - Get node template
- Delete - Delete node template
- List - List nodes
- Create - Create node
- Fetch - Get node
- Delete - Delete node
- GetLogsForNode - Get node logs
- GetSSHInfoForNode - Get node SSH info
- TerminateNode - Terminate node
- List - List procurements
- Create - Create procurement
- GetProcurement - Get procurement
- Delete - Delete procurement
- PatchProcurement - Update procurement
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a Next method that can be called to pull down the next group of results. If the
return value of Next is nil, then there are no more pages to be fetched.
Here's an example of one such pagination call:
package main
import (
"context"
sfc "github.com/sfcompute/sfc-go-sdk"
"github.com/sfcompute/sfc-go-sdk/models/operations"
"log"
"os"
)
func main() {
ctx := context.Background()
s := sfc.New(
sfc.WithSecurity(os.Getenv("SFC_BEARER_AUTH")),
)
res, err := s.Capacities.List(ctx, operations.ListCapacitiesRequest{
Workspace: "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
ID: []string{
"cap_k3R-nX9vLm7Qp2Yw5Jd8F",
},
StartingAfter: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
EndingBefore: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
})
if err != nil {
log.Fatal(err)
}
if res.ListCapacitiesResponse != nil {
for {
// handle items
res, err = res.Next()
if err != nil {
// handle error
}
if res == nil {
break
}
}
}
}Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:
package main
import (
"context"
sfc "github.com/sfcompute/sfc-go-sdk"
"github.com/sfcompute/sfc-go-sdk/models/operations"
"github.com/sfcompute/sfc-go-sdk/retry"
"log"
"models/operations"
"os"
)
func main() {
ctx := context.Background()
s := sfc.New(
sfc.WithSecurity(os.Getenv("SFC_BEARER_AUTH")),
)
res, err := s.Capacities.List(ctx, operations.ListCapacitiesRequest{
Workspace: "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
ID: []string{
"cap_k3R-nX9vLm7Qp2Yw5Jd8F",
},
StartingAfter: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
EndingBefore: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
}, operations.WithRetries(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}))
if err != nil {
log.Fatal(err)
}
if res.ListCapacitiesResponse != nil {
for {
// handle items
res, err = res.Next()
if err != nil {
// handle error
}
if res == nil {
break
}
}
}
}If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:
package main
import (
"context"
sfc "github.com/sfcompute/sfc-go-sdk"
"github.com/sfcompute/sfc-go-sdk/models/operations"
"github.com/sfcompute/sfc-go-sdk/retry"
"log"
"os"
)
func main() {
ctx := context.Background()
s := sfc.New(
sfc.WithRetryConfig(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}),
sfc.WithSecurity(os.Getenv("SFC_BEARER_AUTH")),
)
res, err := s.Capacities.List(ctx, operations.ListCapacitiesRequest{
Workspace: "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
ID: []string{
"cap_k3R-nX9vLm7Qp2Yw5Jd8F",
},
StartingAfter: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
EndingBefore: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
})
if err != nil {
log.Fatal(err)
}
if res.ListCapacitiesResponse != nil {
for {
// handle items
res, err = res.Next()
if err != nil {
// handle error
}
if res == nil {
break
}
}
}
}Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.
By Default, an API error will return apierrors.APIError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.
For example, the List function may return the following errors:
| Error Type | Status Code | Content Type |
|---|---|---|
| apierrors.UnauthorizedError | 401 | application/json |
| apierrors.UnprocessableEntityError | 422 | application/json |
| apierrors.InternalServerError | 500 | application/json |
| apierrors.APIError | 4XX, 5XX | */* |
package main
import (
"context"
"errors"
sfc "github.com/sfcompute/sfc-go-sdk"
"github.com/sfcompute/sfc-go-sdk/models/apierrors"
"github.com/sfcompute/sfc-go-sdk/models/operations"
"log"
"os"
)
func main() {
ctx := context.Background()
s := sfc.New(
sfc.WithSecurity(os.Getenv("SFC_BEARER_AUTH")),
)
res, err := s.Capacities.List(ctx, operations.ListCapacitiesRequest{
Workspace: "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
ID: []string{
"cap_k3R-nX9vLm7Qp2Yw5Jd8F",
},
StartingAfter: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
EndingBefore: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
})
if err != nil {
var e *apierrors.UnauthorizedError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *apierrors.UnprocessableEntityError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *apierrors.InternalServerError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *apierrors.APIError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
}
}The default server can be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:
package main
import (
"context"
sfc "github.com/sfcompute/sfc-go-sdk"
"github.com/sfcompute/sfc-go-sdk/models/operations"
"log"
"os"
)
func main() {
ctx := context.Background()
s := sfc.New(
sfc.WithServerURL("https://api.sfcompute.com"),
sfc.WithSecurity(os.Getenv("SFC_BEARER_AUTH")),
)
res, err := s.Capacities.List(ctx, operations.ListCapacitiesRequest{
Workspace: "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
ID: []string{
"cap_k3R-nX9vLm7Qp2Yw5Jd8F",
},
StartingAfter: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
EndingBefore: sfc.Pointer("capc_gqXR7s0Kj5mHvE2wNpLc4Q"),
})
if err != nil {
log.Fatal(err)
}
if res.ListCapacitiesResponse != nil {
for {
// handle items
res, err = res.Next()
if err != nil {
// handle error
}
if res == nil {
break
}
}
}
}The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:
type HTTPClient interface {
Do(req *http.Request) (*http.Response, error)
}The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.
import (
"net/http"
"time"
"github.com/sfcompute/sfc-go-sdk"
)
var (
httpClient = &http.Client{Timeout: 30 * time.Second}
sdkClient = sfc.New(sfc.WithClient(httpClient))
)This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.
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.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.