api

Documentation

Index

• type Client
  • func NewClient(ctx context.Context, conf *ClientConfig) (Client, error)
• type ClientConfig

Types

type Client

type Client interface {
	// GatewayClient defines GetEvaluation and RegisterEvents methods.
	protogateway.GatewayClient

	// Close tears down the connection.
	Close() error
}

Client is the client interface for the Bucketeer APIGateway service.

func NewClient

func NewClient(ctx context.Context, conf *ClientConfig) (Client, error)

NewClient creates a new Client.

NewClient returns error if failed to dial gRPC.

type ClientConfig

type ClientConfig struct {
	// APIKey is the key to use the Bucketeer APIGateway service.
	APIKey string

	// Host is the host name of the target service, e.g. api-dev.bucketeer.jp.
	Host string

	// Port is the port number of the target service, e.g. 443.
	Port int
}

ClientConfig is the config for Client.