client

package

v1.0.0 Latest Latest Go to latest Published: Feb 16, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/scaleway/cq-source-scaleway

Links

Documentation ¶

Index ¶

Variables
func New(_ context.Context, logger zerolog.Logger, s specs.Source, opts source.Options) (schema.ClientMeta, error)
func RegionMultiplex(meta schema.ClientMeta) []schema.ClientMeta
func RegionMultiplexExcept(except ...scw.Region) schema.Multiplexer
func RegionMultiplexSelective(list ...scw.Region) schema.Multiplexer
func RegionMultiplexService(service string) schema.Multiplexer
func ResolveClientRegion(_ context.Context, meta schema.ClientMeta, r *schema.Resource, c schema.Column) error
func ResolveClientZone(_ context.Context, meta schema.ClientMeta, r *schema.Resource, c schema.Column) error
func TestHelper(t *testing.T, table *schema.Table, createServices func(*mux.Router) error)
func ZoneMultiplex(meta schema.ClientMeta) []schema.ClientMeta
func ZoneMultiplexExcept(except ...scw.Zone) schema.Multiplexer
func ZoneMultiplexSelective(list ...scw.Zone) schema.Multiplexer
func ZoneMultiplexService(service string) schema.Multiplexer
type Client
type Spec
- func (s *Spec) SetDefaults()
- func (Spec) Validate() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ZonePK = schema.Column{
		Name:     "zone",
		Type:     schema.TypeString,
		Resolver: ResolveClientZone,
		CreationOptions: schema.ColumnCreationOptions{
			PrimaryKey: true,
		},
	}

	RegionPK = schema.Column{
		Name:     "region",
		Type:     schema.TypeString,
		Resolver: ResolveClientRegion,
		CreationOptions: schema.ColumnCreationOptions{
			PrimaryKey: true,
		},
	}
)

View Source

var TestOrgID = "DECAF000-CAFE-0000-0000-000000000000"

Functions ¶

func New ¶

func New(_ context.Context, logger zerolog.Logger, s specs.Source, opts source.Options) (schema.ClientMeta, error)

func RegionMultiplex ¶

func RegionMultiplex(meta schema.ClientMeta) []schema.ClientMeta

func RegionMultiplexExcept ¶

func RegionMultiplexExcept(except ...scw.Region) schema.Multiplexer

func RegionMultiplexSelective ¶

func RegionMultiplexSelective(list ...scw.Region) schema.Multiplexer

func RegionMultiplexService ¶

func RegionMultiplexService(service string) schema.Multiplexer

func ResolveClientRegion ¶

func ResolveClientRegion(_ context.Context, meta schema.ClientMeta, r *schema.Resource, c schema.Column) error

func ResolveClientZone ¶

func ResolveClientZone(_ context.Context, meta schema.ClientMeta, r *schema.Resource, c schema.Column) error

func TestHelper ¶

func TestHelper(t *testing.T, table *schema.Table, createServices func(*mux.Router) error)

func ZoneMultiplex ¶

func ZoneMultiplex(meta schema.ClientMeta) []schema.ClientMeta

func ZoneMultiplexExcept ¶

func ZoneMultiplexExcept(except ...scw.Zone) schema.Multiplexer

func ZoneMultiplexSelective ¶

func ZoneMultiplexSelective(list ...scw.Zone) schema.Multiplexer

func ZoneMultiplexService ¶

func ZoneMultiplexService(service string) schema.Multiplexer

Types ¶

type Client ¶

type Client struct {
	Logger    zerolog.Logger
	SCWClient *scw.Client
	Backend   backend.Backend
	OrgID     string
	Region    scw.Region
	Zone      scw.Zone

	Spec Spec
	// contains filtered or unexported fields
}

func (*Client) ID ¶

func (c *Client) ID() string

func (*Client) WithRegion ¶

func (c *Client) WithRegion(r scw.Region) *Client

func (*Client) WithZone ¶

func (c *Client) WithZone(z scw.Zone) *Client

type Spec ¶

type Spec struct {
	Regions []scw.Region `json:"regions,omitempty"`
	Zones   []scw.Zone   `json:"zones,omitempty"`

	// Optional
	Timeout int64 `json:"timeout_secs,omitempty"`
}

func (*Spec) SetDefaults ¶

func (s *Spec) SetDefaults()

func (Spec) Validate ¶

func (Spec) Validate() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL