flags

package
v0.0.0-...-13fb019 Latest Latest
Warning

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

 Go to latest Published: Oct 25, 2018 License: Apache-2.0 Imports: 17 Imported by: 3

Documentation

Index

Constants

View Source 
const (
	DefaultMaxBatchDelay = 1 * time.Second
	DefaultMaxBatchSize  = 100
)

Variables

This section is empty.

Functions

This section is empty.

Types

type APIAuthKeyFromFlags 

type APIAuthKeyFromFlags interface {
	// Returns the API authentication key from the command line.
	Make() string
}

APIAuthKeyFromFlags represents command-line flags for specifying an API authentication key for the Turbine Labs API.

func NewAPIAuthKeyFromFlags 

func NewAPIAuthKeyFromFlags(flagset tbnflag.FlagSet, opts ...APIAuthKeyOption) APIAuthKeyFromFlags

NewAPIAuthKeyFromFlags configures the necessary command line flags and returns an APIAuthKeyFromFlags.

type APIAuthKeyOption 

type APIAuthKeyOption func(*apiAuthKeyFromFlags)

APIAuthKeyOption represents an option passed to NewAPIAuthKeyFromFlags.

func APIAuthKeyFlagsOptional 

func APIAuthKeyFlagsOptional() APIAuthKeyOption

APIAuthKeyFlagsOptional allows the caller to specify that the flags created by APIAuthKeyFromFlags are optional.

type APIConfigFromFlags 

type APIConfigFromFlags interface {
	// apihttp.FromFlags constructs an API endpoint
	apihttp.FromFlags

	// APIKey Returns the API authentication key from the command line.
	// Equivalent to calling APIAuthKeyFromFlags().Make()
	APIKey() string

	// APIAuthKeyFromFlags returns the underlying APIAuthKeyFromFlags
	// so that it can potentially be shared between APIConfigFromFlags
	// via the APIConfigSetAPIAuthKeyFromFlags APIConfigOption.
	APIAuthKeyFromFlags() APIAuthKeyFromFlags
}

APIConfigFromFlags represents command-line flags for specifying API authentication, host, port and SSL settings for the Turbine Labs API.

func NewAPIConfigFromFlags 

func NewAPIConfigFromFlags(
	flagset tbnflag.FlagSet,
	opts ...APIConfigOption,
) APIConfigFromFlags

NewAPIConfigFromFlags configures the necessary command line flags and returns an APIConfigFromFlags.

type APIConfigOption 

type APIConfigOption func(*apiConfigFromFlags)

APIConfigOption represents an option passed to NewAPIConfigFromFlags.

func APIConfigMayUseAuthToken 

func APIConfigMayUseAuthToken(cachePath tokencache.PathFromFlags) APIConfigOption

APIConfigMayUseAuthToken indicates that the API Config can use an auth token to authenticate instead of relying on an API key. As a result if this is set API Key becomes optional. If an API Key is set it takes precedence over an auth token found from the TokenCache.

If an APIAuthKeyFromFlags is provided via APIConfigSetAPIAuthKeyFromFlags it may still be considered required depending on the APIAuthKeyFromFlags construction.

Parameters: 

cachePath - this is a file where cached authed token should be read from

func APIConfigSetAPIAuthKeyFromFlags 

func APIConfigSetAPIAuthKeyFromFlags(akff APIAuthKeyFromFlags) APIConfigOption

APIConfigSetAPIAuthKeyFromFlags allows the caller to specify a shared APIAuthKeyFromFlags, likely obtained via the APIConfigFromFlags.APIAuthKeyFromFlags() method.

type ClientFromFlags 

type ClientFromFlags interface {
	Validate() error

	// Make produces a service.All from the provided flags, or an
	// error.
	Make() (service.All, error)

	// MakeAdmin produces a service.Admin from the provided flags,
	// or an error.
	MakeAdmin() (service.Admin, error)
}

ClientFromFlags represents command-line flags specifying configuration of a service.All backed by the Turbine Labs API.

func NewClientFromFlags 

func NewClientFromFlags(clientApp client.App, flagset tbnflag.FlagSet) ClientFromFlags

NewClientFromFlags creates a ServiceFromFlags, which configures the necessary flags to construct a service.All instance.

func NewClientFromFlagsWithSharedAPIConfig 

func NewClientFromFlagsWithSharedAPIConfig(
	clientApp client.App,
	flagset tbnflag.FlagSet,
	apiConfigFromFlags APIConfigFromFlags,
) ClientFromFlags

NewClientFromFlagsWithSharedAPIConfig creates a ClientFromFlags, which configures the necessary flags to construct a service.All instance. The given APIConfigFromFlags is used to obtain the API auth key.

type MockAPIAuthKeyFromFlags 

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

MockAPIAuthKeyFromFlags is a mock of APIAuthKeyFromFlags interface

func NewMockAPIAuthKeyFromFlags 

func NewMockAPIAuthKeyFromFlags(ctrl *gomock.Controller) *MockAPIAuthKeyFromFlags

NewMockAPIAuthKeyFromFlags creates a new mock instance

func (*MockAPIAuthKeyFromFlags) EXPECT 

func (m *MockAPIAuthKeyFromFlags) EXPECT() *MockAPIAuthKeyFromFlagsMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockAPIAuthKeyFromFlags) Make 

func (m *MockAPIAuthKeyFromFlags) Make() string

Make mocks base method

type MockAPIAuthKeyFromFlagsMockRecorder 

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

MockAPIAuthKeyFromFlagsMockRecorder is the mock recorder for MockAPIAuthKeyFromFlags

func (*MockAPIAuthKeyFromFlagsMockRecorder) Make 

func (mr *MockAPIAuthKeyFromFlagsMockRecorder) Make() *gomock.Call

Make indicates an expected call of Make

type MockAPIConfigFromFlags 

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

MockAPIConfigFromFlags is a mock of APIConfigFromFlags interface

func NewMockAPIConfigFromFlags 

func NewMockAPIConfigFromFlags(ctrl *gomock.Controller) *MockAPIConfigFromFlags

NewMockAPIConfigFromFlags creates a new mock instance

func (*MockAPIConfigFromFlags) APIAuthKeyFromFlags 

func (m *MockAPIConfigFromFlags) APIAuthKeyFromFlags() APIAuthKeyFromFlags

APIAuthKeyFromFlags mocks base method

func (*MockAPIConfigFromFlags) APIKey 

func (m *MockAPIConfigFromFlags) APIKey() string

APIKey mocks base method

func (*MockAPIConfigFromFlags) EXPECT 

func (m *MockAPIConfigFromFlags) EXPECT() *MockAPIConfigFromFlagsMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockAPIConfigFromFlags) MakeEndpoint 

func (m *MockAPIConfigFromFlags) MakeEndpoint() (http.Endpoint, error)

MakeEndpoint mocks base method

func (*MockAPIConfigFromFlags) Validate 

func (m *MockAPIConfigFromFlags) Validate() error

Validate mocks base method

type MockAPIConfigFromFlagsMockRecorder 

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

MockAPIConfigFromFlagsMockRecorder is the mock recorder for MockAPIConfigFromFlags

func (*MockAPIConfigFromFlagsMockRecorder) APIAuthKeyFromFlags 

func (mr *MockAPIConfigFromFlagsMockRecorder) APIAuthKeyFromFlags() *gomock.Call

APIAuthKeyFromFlags indicates an expected call of APIAuthKeyFromFlags

func (*MockAPIConfigFromFlagsMockRecorder) APIKey 

func (mr *MockAPIConfigFromFlagsMockRecorder) APIKey() *gomock.Call

APIKey indicates an expected call of APIKey

func (*MockAPIConfigFromFlagsMockRecorder) MakeEndpoint 

func (mr *MockAPIConfigFromFlagsMockRecorder) MakeEndpoint() *gomock.Call

MakeEndpoint indicates an expected call of MakeEndpoint

func (*MockAPIConfigFromFlagsMockRecorder) Validate 

func (mr *MockAPIConfigFromFlagsMockRecorder) Validate() *gomock.Call

Validate indicates an expected call of Validate

type MockClientFromFlags 

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

MockClientFromFlags is a mock of ClientFromFlags interface

func NewMockClientFromFlags 

func NewMockClientFromFlags(ctrl *gomock.Controller) *MockClientFromFlags

NewMockClientFromFlags creates a new mock instance

func (*MockClientFromFlags) EXPECT 

func (m *MockClientFromFlags) EXPECT() *MockClientFromFlagsMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockClientFromFlags) Make 

func (m *MockClientFromFlags) Make() (service.All, error)

Make mocks base method

func (*MockClientFromFlags) MakeAdmin 

func (m *MockClientFromFlags) MakeAdmin() (service.Admin, error)

MakeAdmin mocks base method

func (*MockClientFromFlags) Validate 

func (m *MockClientFromFlags) Validate() error

Validate mocks base method

type MockClientFromFlagsMockRecorder 

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

MockClientFromFlagsMockRecorder is the mock recorder for MockClientFromFlags

func (*MockClientFromFlagsMockRecorder) Make 

func (mr *MockClientFromFlagsMockRecorder) Make() *gomock.Call

Make indicates an expected call of Make

func (*MockClientFromFlagsMockRecorder) MakeAdmin 

func (mr *MockClientFromFlagsMockRecorder) MakeAdmin() *gomock.Call

MakeAdmin indicates an expected call of MakeAdmin

func (*MockClientFromFlagsMockRecorder) Validate 

func (mr *MockClientFromFlagsMockRecorder) Validate() *gomock.Call

Validate indicates an expected call of Validate

type MockProxyFromFlags 

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

MockProxyFromFlags is a mock of ProxyFromFlags interface

func NewMockProxyFromFlags 

func NewMockProxyFromFlags(ctrl *gomock.Controller) *MockProxyFromFlags

NewMockProxyFromFlags creates a new mock instance

func (*MockProxyFromFlags) EXPECT 

func (m *MockProxyFromFlags) EXPECT() *MockProxyFromFlagsMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockProxyFromFlags) Name 

func (m *MockProxyFromFlags) Name() string

Name mocks base method

func (*MockProxyFromFlags) Ref 

func (m *MockProxyFromFlags) Ref(arg0 service.ZoneRef) service.ProxyRef

Ref mocks base method

type MockProxyFromFlagsMockRecorder 

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

MockProxyFromFlagsMockRecorder is the mock recorder for MockProxyFromFlags

func (*MockProxyFromFlagsMockRecorder) Name 

func (mr *MockProxyFromFlagsMockRecorder) Name() *gomock.Call

Name indicates an expected call of Name

func (*MockProxyFromFlagsMockRecorder) Ref 

func (mr *MockProxyFromFlagsMockRecorder) Ref(arg0 interface{}) *gomock.Call

Ref indicates an expected call of Ref

type MockStatsClientFromFlags 

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

MockStatsClientFromFlags is a mock of StatsClientFromFlags interface

func NewMockStatsClientFromFlags 

func NewMockStatsClientFromFlags(ctrl *gomock.Controller) *MockStatsClientFromFlags

NewMockStatsClientFromFlags creates a new mock instance

func (*MockStatsClientFromFlags) APIKey 

func (m *MockStatsClientFromFlags) APIKey() string

APIKey mocks base method

func (*MockStatsClientFromFlags) EXPECT 

func (m *MockStatsClientFromFlags) EXPECT() *MockStatsClientFromFlagsMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockStatsClientFromFlags) Make 

func (m *MockStatsClientFromFlags) Make(arg0 *log.Logger) (stats.StatsService, error)

Make mocks base method

func (*MockStatsClientFromFlags) Validate 

func (m *MockStatsClientFromFlags) Validate() error

Validate mocks base method

type MockStatsClientFromFlagsMockRecorder 

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

MockStatsClientFromFlagsMockRecorder is the mock recorder for MockStatsClientFromFlags

func (*MockStatsClientFromFlagsMockRecorder) APIKey 

func (mr *MockStatsClientFromFlagsMockRecorder) APIKey() *gomock.Call

APIKey indicates an expected call of APIKey

func (*MockStatsClientFromFlagsMockRecorder) Make 

func (mr *MockStatsClientFromFlagsMockRecorder) Make(arg0 interface{}) *gomock.Call

Make indicates an expected call of Make

func (*MockStatsClientFromFlagsMockRecorder) Validate 

func (mr *MockStatsClientFromFlagsMockRecorder) Validate() *gomock.Call

Validate indicates an expected call of Validate

type MockZoneFromFlags 

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

MockZoneFromFlags is a mock of ZoneFromFlags interface

func NewMockZoneFromFlags 

func NewMockZoneFromFlags(ctrl *gomock.Controller) *MockZoneFromFlags

NewMockZoneFromFlags creates a new mock instance

func (*MockZoneFromFlags) EXPECT 

func (m *MockZoneFromFlags) EXPECT() *MockZoneFromFlagsMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockZoneFromFlags) Name 

func (m *MockZoneFromFlags) Name() string

Name mocks base method

func (*MockZoneFromFlags) Ref 

func (m *MockZoneFromFlags) Ref() service.ZoneRef

Ref mocks base method

type MockZoneFromFlagsMockRecorder 

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

MockZoneFromFlagsMockRecorder is the mock recorder for MockZoneFromFlags

func (*MockZoneFromFlagsMockRecorder) Name 

func (mr *MockZoneFromFlagsMockRecorder) Name() *gomock.Call

Name indicates an expected call of Name

func (*MockZoneFromFlagsMockRecorder) Ref 

func (mr *MockZoneFromFlagsMockRecorder) Ref() *gomock.Call

Ref indicates an expected call of Ref

type ProxyFromFlags 

type ProxyFromFlags interface {
	Name() string
	Ref(service.ZoneRef) service.ProxyRef
}

ProxyFromFlags installs flags to obtain a proxy from a proxy name

func NewProxyFromFlags 

func NewProxyFromFlags(flagset tbnflag.FlagSet) ProxyFromFlags

NewProxyFromFlags installs a ProxyFromFlags into the given flagset

type StatsClientFromFlags 

type StatsClientFromFlags interface {
	Validate() error

	// Make constructs a statsapi.StatsService using the given Logger.
	Make(*log.Logger) (statsapi.StatsService, error)

	// APIKey returns the API Key used to construct the statsapi.StatsService.
	APIKey() string
}

StatsClientFromFlags validates and constructs a a statsapi.StatsService from command line flags.

func NewStatsClientFromFlags 

func NewStatsClientFromFlags(
	clientApp client.App,
	pfs tbnflag.FlagSet,
	options ...StatsClientOption,
) StatsClientFromFlags

type StatsClientOption 

type StatsClientOption func(*statsClientFromFlags)

StatsClientOption represents an option passed to NewStatsClientFromFlags.

func StatsClientWithAPIConfigFromFlags 

func StatsClientWithAPIConfigFromFlags(apiConfigFromFlags APIConfigFromFlags) StatsClientOption

StatsClientWithAPIConfigFromFlags configures NewStatsClientFromFlags to use a shared APIConfigFromFlags rather than creating its own.

func StatsClientWithExecutorFromFlags 

func StatsClientWithExecutorFromFlags(execFromFlags executor.FromFlags) StatsClientOption

StatsClientWithExecutorFromFlags configures NewStatsClientFromFlags to use a shared executor.FromFlags rather than creating its own.

type ZoneFromFlags 

type ZoneFromFlags interface {
	Name() string
	Ref() service.ZoneRef
}

ZoneFromFlags represents command-line flags for specifying a Turbine Labs API zone name, which is used to resolve a zone.

func NewZoneFromFlags 

func NewZoneFromFlags(flagset tbnflag.FlagSet, opts ...ZoneFromFlagsFlagOptions) ZoneFromFlags

NewZoneFromFlags configures the necessary command line flags to retrieve a zone by zone name.

type ZoneFromFlagsFlagOptions 

type ZoneFromFlagsFlagOptions func(*zoneFromFlags) *zoneFromFlags

ZoneFromFlagsFlagOptions lets you add various options to NewFromFlags

func ZoneFromFlagsNameOptional 

func ZoneFromFlagsNameOptional() ZoneFromFlagsFlagOptions

ZoneFromFlagsNameOptional allows the caller to specify that the zone-name flag is optional

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.