client

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
  • func (c *Client) ID() string
  • func (c *Client) WithRegion(r scw.Region) *Client
  • func (c *Client) WithZone(z scw.Zone) *Client
• type Spec
  • func (s *Spec) SetDefaults()
  • func (Spec) Validate() error

Variables

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,
		},
	}
)

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