Skip to content

infra-rdc/rudder-go

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
docs
docs
 
 
internal
internal
 
 
models
models
 
 
src/img
src/img
 
 
types
types
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
USAGE.md
USAGE.md
 
 
apiinfo.go
apiinfo.go
 
 
archives.go
archives.go
 
 
campaigns.go
campaigns.go
 
 
changerequests.go
changerequests.go
 
 
compliance.go
compliance.go
 
 
cve.go
cve.go
 
 
datasources.go
datasources.go
 
 
directives.go
directives.go
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
groups.go
groups.go
 
 
inventories.go
inventories.go
 
 
main.go
main.go
 
 
nodes.go
nodes.go
 
 
openscap.go
openscap.go
 
 
parameters.go
parameters.go
 
 
plugins.go
plugins.go
 
 
rules.go
rules.go
 
 
scaleoutrelay.go
scaleoutrelay.go
 
 
secretmanagement.go
secretmanagement.go
 
 
settings.go
settings.go
 
 
status.go
status.go
 
 
system.go
system.go
 
 
systemupdatecampaigns.go
systemupdatecampaigns.go
 
 
techniques.go
techniques.go
 
 
usermanagement.go
usermanagement.go
 
 

Repository files navigation

Installation

go get -u github.com/infra-rdc/rudder-go

Example Usage

Example

package main

import (
	"context"
	rudder "github.com/infra-rdc/rudder-go"
	"log"
)

func main() {
	s := rudder.New(
		rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.ChangeRequests.ListChangeRequests(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Available Resources and Operations

ChangeRequests

Archives

  • Export - Get a ZIP archive of the requested items and their dependencies
  • Import - Import a ZIP archive of policies into Rudder

Campaigns

Compliance

Cve

DataSources

Directives

Groups

APIInfo

Inventories

Techniques

Nodes

OpenSCAP

Parameters

Plugins

Rules

ScaleOutRelay

SecretManagement

Settings

Status

  • None - Check if Rudder is alive

System

SystemUpdateCampaigns

UserManagement

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Error Object Status Code Content Type
sdkerrors.DeleteParameterResponseBody 500 application/json
sdkerrors.SDKError 4xx-5xx /

Example

package main

import (
	"context"
	"errors"
	rudder "github.com/infra-rdc/rudder-go"
	"github.com/infra-rdc/rudder-go/models/sdkerrors"
	"log"
)

func main() {
	s := rudder.New(
		rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
	)
	var parameterID string = "rudder_file_edit_header"
	ctx := context.Background()
	res, err := s.Parameters.DeleteParameter(ctx, parameterID)
	if err != nil {

		var e *sdkerrors.DeleteParameterResponseBody
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 https://rudder.example.local/rudder/api/latest None

Example

package main

import (
	"context"
	rudder "github.com/infra-rdc/rudder-go"
	"log"
)

func main() {
	s := rudder.New(
		rudder.WithServerIndex(0),
		rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.ChangeRequests.ListChangeRequests(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	rudder "github.com/infra-rdc/rudder-go"
	"log"
)

func main() {
	s := rudder.New(
		rudder.WithServerURL("https://rudder.example.local/rudder/api/latest"),
		rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.ChangeRequests.ListChangeRequests(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Custom HTTP Client

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/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
APITokens apiKey API key

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	rudder "github.com/infra-rdc/rudder-go"
	"log"
)

func main() {
	s := rudder.New(
		rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.ChangeRequests.ListChangeRequests(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Special Types

This SDK defines the following custom types to assist with marshalling and unmarshalling data.

Date

types.Date is a wrapper around time.Time that allows for JSON marshaling a date string formatted as "2006-01-02".

Usage

d1 := types.NewDate(time.Now()) // returns *types.Date

d2 := types.DateFromTime(time.Now()) // returns types.Date

d3, err := types.NewDateFromString("2019-01-01") // returns *types.Date, error

d4, err := types.DateFromString("2019-01-01") // returns types.Date, error

d5 := types.MustNewDateFromString("2019-01-01") // returns *types.Date and panics on error

d6 := types.MustDateFromString("2019-01-01") // returns types.Date and panics on error

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!

Contact

Julien Briault - @ju_hnny5

About

Golang SDK for Rudder (rudder.io)

Topics

golang rudder

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages