api

README

api-go

A Golang implementation of the Licensing API as defined by the proto repository.

package main

import (
	"google.golang.org/grpc"

	"code.pitz.tech/licensing/api-go"
)

func main() {
	clientConn, err := grpc.Dial("host:port") // grpc.Dial("host:port", dialopts...)
	if err != nil {
		panic(err)
    }
	
	client, err := api.NewClient(api.ClientConfig{
		ClientConn: clientConn,
	})
	if err != nil {
		panic(err)
    }
	
	client.Contributors()
	client.Licenses()
	client.Packages()
	client.Products()
	client.Tokens()
	client.Users()
}

Documentation

Index

• type Client
  • func NewClient(opts ...ClientOption) (*Client, error)
  • func (c *Client) Contributors() contributorsv1.ContributorServiceClient
  • func (c *Client) Licenses() licensesv1.LicenseServiceClient
  • func (c *Client) Packages() packagesv1.PackageServiceClient
  • func (c *Client) Products() productsv1.ProductServiceClient
  • func (c *Client) Tokens() tokensv1.TokenServiceClient
  • func (c *Client) Users() usersv1.UserServiceClient
• type ClientConfig
  • func (c ClientConfig) Apply(dst *ClientConfig)
• type ClientOption
• type ClientOptionFunc
  • func (fn ClientOptionFunc) Apply(config *ClientConfig)

Types

type Client

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

Client encapsulates all operations that can be performed against the service.

func NewClient

func NewClient(opts ...ClientOption) (*Client, error)

NewClient constructs an API client using the provided configuration or list of options.

func (*Client) Contributors

func (c *Client) Contributors() contributorsv1.ContributorServiceClient

func (*Client) Licenses

func (c *Client) Licenses() licensesv1.LicenseServiceClient

func (*Client) Packages

func (c *Client) Packages() packagesv1.PackageServiceClient

func (*Client) Products

func (c *Client) Products() productsv1.ProductServiceClient

func (*Client) Tokens

func (c *Client) Tokens() tokensv1.TokenServiceClient

func (*Client) Users

func (c *Client) Users() usersv1.UserServiceClient

type ClientConfig

type ClientConfig struct {
	ClientConn *grpc.ClientConn
}

ClientConfig defines the bare requirements needed to establish a connection to the target server instance.

func (ClientConfig) Apply

func (c ClientConfig) Apply(dst *ClientConfig)

Apply merges this configuration with the destination configuration. This mechanism uses a last-write-wins approach.

type ClientOption

type ClientOption interface {
	// Apply configures the provided ClientConfig when called.
	Apply(*ClientConfig)
}

ClientOption defines a base abstraction for configuring the client.

type ClientOptionFunc

type ClientOptionFunc func(*ClientConfig)

ClientOptionFunc provides a functional abstraction for configuring the client.

func (ClientOptionFunc) Apply

func (fn ClientOptionFunc) Apply(config *ClientConfig)