examples

Documentation

Overview

Package examples contains fake client with the same interface as real client to overcome import-cycle problem to allow real E2E examples for apis in this package

Index

• type FakeClient
  • func NewClient(_ string, _ string) *FakeClient
  • func (c *FakeClient) AuthorizationsAPI() api.AuthorizationsAPI
  • func (c *FakeClient) BucketsAPI() api.BucketsAPI
  • func (c *FakeClient) Close()
  • func (c *FakeClient) DeleteAPI() api.DeleteAPI
  • func (c *FakeClient) Health(_ context.Context) (*domain.HealthCheck, error)
  • func (c *FakeClient) LabelsAPI() api.LabelsAPI
  • func (c *FakeClient) Options() *Options
  • func (c *FakeClient) OrganizationsAPI() api.OrganizationsAPI
  • func (c *FakeClient) QueryAPI(_ string) api.QueryAPI
  • func (c *FakeClient) Ready(_ context.Context) (bool, error)
  • func (c *FakeClient) ServerURL() string
  • func (c *FakeClient) Setup(_ context.Context, _, _, _, _ string, _ int) (*domain.OnboardingResponse, error)
  • func (c *FakeClient) TasksAPI() api.TasksAPI
  • func (c *FakeClient) UsersAPI() api.UsersAPI
  • func (c *FakeClient) WriteAPI(_, _ string) api.WriteAPI
  • func (c *FakeClient) WriteAPIBlocking(_, _ string) api.WriteAPIBlocking
• type Options
  • func (o *Options) SetBatchSize(_ uint) *Options

Types

type FakeClient

type FakeClient struct {
}

FakeClient emulates Client for allowing using client in api examples

func NewClient

func NewClient(_ string, _ string) *FakeClient

NewClient returns new FakeClient

func (*FakeClient) AuthorizationsAPI

func (c *FakeClient) AuthorizationsAPI() api.AuthorizationsAPI

AuthorizationsAPI returns nil

func (*FakeClient) BucketsAPI

func (c *FakeClient) BucketsAPI() api.BucketsAPI

BucketsAPI returns nil

func (*FakeClient) Close

func (c *FakeClient) Close()

Close does nothing

func (*FakeClient) DeleteAPI

func (c *FakeClient) DeleteAPI() api.DeleteAPI

DeleteAPI returns nil

func (*FakeClient) Health

func (c *FakeClient) Health(_ context.Context) (*domain.HealthCheck, error)

Health does nothing

func (*FakeClient) LabelsAPI

func (c *FakeClient) LabelsAPI() api.LabelsAPI

LabelsAPI returns nil

func (*FakeClient) Options

func (c *FakeClient) Options() *Options

Options returns nil

func (*FakeClient) OrganizationsAPI

func (c *FakeClient) OrganizationsAPI() api.OrganizationsAPI

OrganizationsAPI returns nil

func (*FakeClient) QueryAPI

func (c *FakeClient) QueryAPI(_ string) api.QueryAPI

QueryAPI returns nil

func (*FakeClient) Ready

func (c *FakeClient) Ready(_ context.Context) (bool, error)

Ready does nothing

func (*FakeClient) ServerURL

func (c *FakeClient) ServerURL() string

ServerURL returns empty server URL

func (*FakeClient) Setup

func (c *FakeClient) Setup(_ context.Context, _, _, _, _ string, _ int) (*domain.OnboardingResponse, error)

Setup does nothing

func (*FakeClient) TasksAPI

func (c *FakeClient) TasksAPI() api.TasksAPI

TasksAPI returns nil

func (*FakeClient) UsersAPI

func (c *FakeClient) UsersAPI() api.UsersAPI

UsersAPI returns nil

func (*FakeClient) WriteAPI

func (c *FakeClient) WriteAPI(_, _ string) api.WriteAPI

WriteAPI does nothing

func (*FakeClient) WriteAPIBlocking

func (c *FakeClient) WriteAPIBlocking(_, _ string) api.WriteAPIBlocking

WriteAPIBlocking does nothing

type Options

type Options struct {
}

Options is fake options to satisfy Client interface

func (*Options) SetBatchSize

func (o *Options) SetBatchSize(_ uint) *Options

SetBatchSize to emulate fake options