shield

Documentation

Index

• type AuthMethod
• type Client
• type Config
• type LocalAuth
• type NetworkClient
  • func NewClient(cfg Config) *NetworkClient
  • func (cli *NetworkClient) Authenticate(auth shield.AuthMethod) error
  • func (cli *NetworkClient) Close() error
  • func (cli *NetworkClient) CreateSchedule(instanceID string, details brokerapi.ProvisionDetails, host string, ...) error
  • func (cli *NetworkClient) DeleteSchedule(instanceID string, details brokerapi.DeprovisionDetails) error
• type NoopClient
  • func (cli *NoopClient) Authenticate(auth shield.AuthMethod) error
  • func (cli *NoopClient) Close() error
  • func (cli *NoopClient) CreateSchedule(instance string, details brokerapi.ProvisionDetails, url string, ...) error
  • func (cli *NoopClient) DeleteSchedule(instance string, details brokerapi.DeprovisionDetails) error
• type TokenAuth

Types

type AuthMethod

type AuthMethod = shield.AuthMethod

type Client

type Client interface {
	io.Closer

	Authenticate(auth shield.AuthMethod) error

	CreateSchedule(instance string, details brokerapi.ProvisionDetails, url string, creds interface{}) error
	DeleteSchedule(instance string, details brokerapi.DeprovisionDetails) error
}

The client interface, also useful for mocking and testing.

type Config

type Config struct {
	Address  string
	Insecure bool

	Agent string

	TenantUUID string
	StoreUUID  string

	Schedule string
	Retain   string

	EnabledOnTargets []string
}

type LocalAuth

type LocalAuth = shield.LocalAuth

type NetworkClient

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

The actual implementation of the client with network connectivity.

func NewClient

func NewClient(cfg Config) *NetworkClient

func (*NetworkClient) Authenticate

func (cli *NetworkClient) Authenticate(auth shield.AuthMethod) error

func (*NetworkClient) Close

func (cli *NetworkClient) Close() error

func (*NetworkClient) CreateSchedule

func (cli *NetworkClient) CreateSchedule(instanceID string, details brokerapi.ProvisionDetails, host string, creds interface{}) error

func (*NetworkClient) DeleteSchedule

func (cli *NetworkClient) DeleteSchedule(instanceID string, details brokerapi.DeprovisionDetails) error

type NoopClient

type NoopClient struct{}

A noop implementation that always returns nil for all methods.

func (*NoopClient) Authenticate

func (cli *NoopClient) Authenticate(auth shield.AuthMethod) error

func (*NoopClient) Close

func (cli *NoopClient) Close() error

func (*NoopClient) CreateSchedule

func (cli *NoopClient) CreateSchedule(instance string, details brokerapi.ProvisionDetails, url string, creds interface{}) error

func (*NoopClient) DeleteSchedule

func (cli *NoopClient) DeleteSchedule(instance string, details brokerapi.DeprovisionDetails) error

type TokenAuth

type TokenAuth = shield.TokenAuth