api

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 27, 2021 License: BSD-3-Clause Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrUnauthorized        = errors.New("unauthorized")
	ErrForbidden           = errors.New("forbidden")
	ErrNotFound            = errors.New("not found")
	ErrMethodNotAllowed    = errors.New("method not allowed")
	ErrTooManyRequests     = errors.New("too many requests")
	ErrInternalServerError = errors.New("internal server error")
	ErrServiceUnavailable  = errors.New("service unavailable")
	ErrRecoveryInitiated   = errors.New("try again later")
)

Errors that are returned by the API.

Functions

func Bool 

func Bool(v bool) (p *bool)

Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.

Types

type BadRequestError 

type BadRequestError struct {
	// contains filtered or unexported fields
}

BadRequestError holds list of errors from http response that represent invalid data submitted by the user.

func NewBadRequestError 

func NewBadRequestError(errors ...string) (err *BadRequestError)

NewBadRequestError constructs a new BadRequestError with provided errors.

func (*BadRequestError) Error 

func (e *BadRequestError) Error() (s string)

func (*BadRequestError) Errors 

func (e *BadRequestError) Errors() (errs []string)

Errors returns a list of error messages.

type BytesService added in v0.2.10 

type BytesService service

BytesService represents Bee's Bytes service

func (*BytesService) Download added in v0.2.10 

func (b *BytesService) Download(ctx context.Context, a swarm.Address) (resp io.ReadCloser, err error)

Download downloads data from the node

func (*BytesService) Upload added in v0.2.10 

func (b *BytesService) Upload(ctx context.Context, data io.Reader, o UploadOptions) (BytesUploadResponse, error)

Upload uploads bytes to the node

type BytesUploadResponse added in v0.2.10 

type BytesUploadResponse struct {
	Reference swarm.Address `json:"reference"`
}

BytesUploadResponse represents Upload's response

type ChunksService added in v0.2.10 

type ChunksService service

ChunksService represents Bee's Chunks service

func (*ChunksService) Download added in v0.2.10 

func (c *ChunksService) Download(ctx context.Context, a swarm.Address, targets string) (resp io.ReadCloser, err error)

Download downloads data from the node

func (*ChunksService) Upload added in v0.2.10 

func (c *ChunksService) Upload(ctx context.Context, data []byte, o UploadOptions) (ChunksUploadResponse, error)

Upload uploads chunks to the node

type ChunksUploadResponse added in v0.2.10 

type ChunksUploadResponse struct {
	Reference swarm.Address `json:"reference"`
}

ChunksUploadResponse represents Upload's response

type Client 

type Client struct {

	// Services that API provides.
	Bytes   *BytesService
	Chunks  *ChunksService
	Files   *FilesService
	Dirs    *DirsService
	Pinning *PinningService
	Tags    *TagsService
	PSS     *PSSService
	SOC     *SOCService
	Postage *PostageService
	// contains filtered or unexported fields
}

Client manages communication with the Bee API.

func NewClient 

func NewClient(baseURL *url.URL, o *ClientOptions) (c *Client)

NewClient constructs a new Client.

type ClientOptions 

type ClientOptions struct {
	HTTPClient *http.Client
}

ClientOptions holds optional parameters for the Client.

type DirsService added in v0.2.18 

type DirsService service

DirsService represents Bee's Dirs service

func (*DirsService) Download added in v0.2.18 

func (s *DirsService) Download(ctx context.Context, a swarm.Address, path string) (resp io.ReadCloser, err error)

Download downloads data from the node

func (*DirsService) Upload added in v0.2.18 

func (s *DirsService) Upload(ctx context.Context, data io.Reader, size int64, o UploadOptions) (resp DirsUploadResponse, err error)

Upload uploads TAR collection to the node

type DirsUploadResponse added in v0.2.18 

type DirsUploadResponse struct {
	Reference swarm.Address `json:"reference"`
}

DirsUploadResponse represents Upload's response

type FilesService added in v0.2.11 

type FilesService service

FilesService represents Bee's Files service

func (*FilesService) Download added in v0.2.11 

func (f *FilesService) Download(ctx context.Context, a swarm.Address) (resp io.ReadCloser, err error)

Download downloads data from the node

func (*FilesService) Upload added in v0.2.11 

func (f *FilesService) Upload(ctx context.Context, name string, data io.Reader, size int64, o UploadOptions) (resp FilesUploadResponse, err error)

Upload uploads files to the node

type FilesUploadResponse added in v0.2.11 

type FilesUploadResponse struct {
	Reference swarm.Address `json:"reference"`
}

FilesUploadResponse represents Upload's response

type PSSService added in v0.5.0 

type PSSService service

PSSService represents Bee's PSS service

func (*PSSService) SendMessage added in v0.5.0 

func (p *PSSService) SendMessage(ctx context.Context, nodeAddress swarm.Address, nodePublicKey string, topic string, prefix int, data io.Reader, batchID string) error

Sends a PSS message to a recipienct with a specific topic

type PinnedChunk added in v0.2.19 

type PinnedChunk struct {
	Address    swarm.Address `json:"address"`
	PinCounter int           `json:"pinCounter"`
}

PinnedChunk represents pinned chunk

type PinnedChunks added in v0.2.19 

type PinnedChunks struct {
	Chunks []PinnedChunk `json:"chunks"`
}

PinnedChunks represents pinned chunks

type PinningService added in v0.2.19 

type PinningService service

PinningService represents Bee's Pin service

func (*PinningService) PinBytes added in v0.4.1 

func (p *PinningService) PinBytes(ctx context.Context, a swarm.Address) error

PinBytes pins chunks for bytes upload

func (*PinningService) PinBzz added in v0.4.1 

func (p *PinningService) PinBzz(ctx context.Context, a swarm.Address) error

PinBzz pins chunks for bzz upload

func (*PinningService) PinChunk added in v0.2.19 

func (p *PinningService) PinChunk(ctx context.Context, a swarm.Address) error

PinChunk pins chunk

func (*PinningService) PinFiles added in v0.4.1 

func (p *PinningService) PinFiles(ctx context.Context, a swarm.Address) error

PinFiles pins chunks for files upload

func (*PinningService) PinnedChunk added in v0.2.19 

func (p *PinningService) PinnedChunk(ctx context.Context, a swarm.Address) (resp PinnedChunk, err error)

PinnedChunk gets pinned chunk

func (*PinningService) PinnedChunks added in v0.2.19 

func (p *PinningService) PinnedChunks(ctx context.Context) (resp PinnedChunks, err error)

PinnedChunks gets pinned chunks

func (*PinningService) UnpinBytes added in v0.4.1 

func (p *PinningService) UnpinBytes(ctx context.Context, a swarm.Address) error

UnpinBytes unpins chunks for bytes upload

func (*PinningService) UnpinBzz added in v0.4.1 

func (p *PinningService) UnpinBzz(ctx context.Context, a swarm.Address) error

UnpinBzz unpins chunks for bzz upload

func (*PinningService) UnpinChunk added in v0.2.19 

func (p *PinningService) UnpinChunk(ctx context.Context, a swarm.Address) error

UnpinChunk unpins chunk

func (*PinningService) UnpinFiles added in v0.4.1 

func (p *PinningService) UnpinFiles(ctx context.Context, a swarm.Address) error

UnpinFiles unpins chunks for files upload

type PostageService added in v0.5.5 

type PostageService service

PostageService represents Bee's Postage service

func (*PostageService) CreatePostageBatch added in v0.5.5 

func (p *PostageService) CreatePostageBatch(ctx context.Context, amount int64, depth uint64, label string) (string, error)

Sends a create postage request to a node that returns the bactchID

type SOCService added in v0.5.0 

type SOCService service

PSSService represents Bee's PSS service

func (*SOCService) UploadSOC added in v0.5.0 

func (p *SOCService) UploadSOC(ctx context.Context, owner, ID, signature string, data io.Reader, batchID string) (*SocResponse, error)

Sends a PSS message to a recipienct with a specific topic

type SocResponse added in v0.5.5 

type SocResponse struct {
	Reference swarm.Address
}

type TagResponse added in v0.3.7 

type TagResponse struct {
	Total     int64         `json:"total"`
	Split     int64         `json:"split"`
	Seen      int64         `json:"seen"`
	Stored    int64         `json:"stored"`
	Sent      int64         `json:"sent"`
	Synced    int64         `json:"synced"`
	Uid       uint32        `json:"uid"`
	Name      string        `json:"name"`
	Address   swarm.Address `json:"address"`
	StartedAt time.Time     `json:"startedAt"`
}

type TagsService added in v0.3.7 

type TagsService service

TagsService represents Bee's Tag service

func (*TagsService) CreateTag added in v0.3.7 

func (p *TagsService) CreateTag(ctx context.Context) (resp TagResponse, err error)

CreateTag creates new tag

func (*TagsService) GetTag added in v0.3.7 

func (p *TagsService) GetTag(ctx context.Context, tagUID uint32) (resp TagResponse, err error)

GetTag gets a new tag

func (*TagsService) WaitSync added in v0.5.6 

func (p *TagsService) WaitSync(ctx context.Context, tagUID uint32) (err error)

type UploadOptions added in v0.3.5 

type UploadOptions struct {
	Pin     bool
	Tag     uint32
	BatchID string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.