clients

Documentation

Index

• Constants
• func ExecuteCommand(cmd exec.Cmd) ([]byte, error)
• func SkipCI(t *testing.T)
• type APICredentials
• type Client
  • func (c *Client) Authenticate(email string, password string) error
• type IClient
  • func NewClient() IClient

Constants

const CliName = "confluent"

CliName is the name of the confluent CLI application

const ConflientUsernameEnvKey = "CONFLUENT_CLOUD_EMAIL"

ConflientUsernameEnvKey is the environment key used to assign the username used by the confluent CLI

const ConfluentPasswordEnvKey = "CONFLUENT_CLOUD_PASSWORD"

ConfluentPasswordEnvKey is the environment key used to assign the password used by the confluent CLI

Functions

func ExecuteCommand

func ExecuteCommand(cmd exec.Cmd) ([]byte, error)

ExecuteCommand Execute command helper method

func SkipCI

func SkipCI(t *testing.T)

SkipCI Used for skipping tests in an environment where credentials for external providers can't be provided

Types

type APICredentials

type APICredentials struct {
	Identifier string `json:"identifier"`
	Key        string `json:"key"`
	Secret     string `json:"secret"`
}

APICredentials is a configuration element for all clients who need API keys to access confluent cloud

type Client

type Client struct {
}

Client is a struct for confluent client

func (*Client) Authenticate

func (c *Client) Authenticate(email string, password string) error

Authenticate a user via the confluent client

type IClient

type IClient interface {
	Authenticate(email string, password string) error
}

IClient interface for confluent client

func NewClient

func NewClient() IClient

NewClient is a factory method for confluent client