README.md

PrivateConnection

(PrivateConnection)

Available Operations

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

Create

Creates a new private connection. Upon successful completion of the request, a private connection is scheduled for creation. To query the private connection status, use the endpoints for the workspace group and workspace (if provided).

Example Usage

package main

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

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

    ctx := context.Background()
    res, err := s.PrivateConnection.Create(ctx, shared.PrivateConnectionCreate{
        AllowList: singlestoresamplesdk.String("my-allow-list"),
        ServiceName: singlestoresamplesdk.String("My private link"),
        Type: shared.PrivateConnectionCreateTypeInbound.ToPointer(),
        WorkspaceGroupID: "68af2f46-0000-1000-9000-3f6f5365d878",
    })
    if err != nil {
        log.Fatal(err)
    }

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

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	shared.PrivateConnectionCreate	✔️	The request object to use for the request.

Response

*operations.CreatePrivateConnectionResponse, error

Delete

Deletes a private connection for the specified connection ID. Upon successful completion, a private connection is scheduled for deletion.

Example Usage

package main

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

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


    var connectionID string = "8db863f6-ef9b-413a-8a70-cb816b33de6b"

    ctx := context.Background()
    res, err := s.PrivateConnection.Delete(ctx, connectionID)
    if err != nil {
        log.Fatal(err)
    }

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

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
connectionID	string	✔️	ID of the private connection

Response

*operations.DeletePrivateConnectionResponse, error

Get

Returns private connection information for the specified connection ID, in JSON format. You must specify the connection ID in the API call.

Example Usage

package main

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

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


    var connectionID string = "b18d8d81-fd7b-4764-a31e-475cb1f36591"

    var fields *string = "Optional"

    ctx := context.Background()
    res, err := s.PrivateConnection.Get(ctx, connectionID, fields)
    if err != nil {
        log.Fatal(err)
    }

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

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
connectionID	string	✔️	ID of the private connection
fields	*string	➖	Comma-separated values list that correspond to the filtered fields for returned entities

Response

*operations.GetPrivateConnectionResponse, error

Update

Updates a private connection. You must specify the connection ID in the API call.

Example Usage

package main

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

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


    updatePrivateConnection := shared.UpdatePrivateConnection{
        AllowList: singlestoresamplesdk.String("my-allow-list"),
    }

    var connectionID string = "d0905bf4-aa77-4f20-8e77-54c352acfe54"

    ctx := context.Background()
    res, err := s.PrivateConnection.Update(ctx, updatePrivateConnection, connectionID)
    if err != nil {
        log.Fatal(err)
    }

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

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
updatePrivateConnection	shared.UpdatePrivateConnection	✔️	Here's a sample of JSON data sent in the request body to the API.
connectionID	string	✔️	ID of the private connection

Response

*operations.UpdatePrivateConnectionResponse, error