legacyclientconfig

Documentation

Overview

Package legacyclientconfig provides api command helpers and validators to write compatibility tests for legacy client config apis

Index

• func DefaultGetClientConfigCommand(version core.RuntimeVersion, opts ...CfgClientConfigArgsOption) *core.Command
• func DefaultStoreClientConfigCommand(version core.RuntimeVersion, opts ...CfgClientConfigArgsOption) *core.Command
• func NewGetClientConfigCommand(inputOpts *GetClientConfigInputOptions, ...) (*core.Command, error)
• func NewStoreClientConfigCommand(inputOpts *StoreClientConfigInputOptions, ...) (*core.Command, error)
• type CfgClientConfigArgs
• type CfgClientConfigArgsOption
  • func WithCLIDiscoverySources(version core.RuntimeVersion, sources []types.PluginDiscoveryOpts) CfgClientConfigArgsOption
  • func WithClientConfigOpts(cf *types.ClientConfigOpts) CfgClientConfigArgsOption
  • func WithDefaultCLIDiscoverySource(version core.RuntimeVersion) CfgClientConfigArgsOption
  • func WithDefaultContextAndServer(version core.RuntimeVersion) CfgClientConfigArgsOption
  • func WithDefaultFeatureFlags() CfgClientConfigArgsOption
  • func WithDefaultServer(version core.RuntimeVersion) CfgClientConfigArgsOption
  • func WithError(e string) CfgClientConfigArgsOption
  • func WithFeatureFlags(features map[string]types.FeatureMap) CfgClientConfigArgsOption
  • func WithRuntimeVersion(v core.RuntimeVersion) CfgClientConfigArgsOption
  • func WithValidationStrategy(vs core.ValidationStrategy) CfgClientConfigArgsOption
• type GetClientConfigInputOptions
• type GetClientConfigOutputOptions
• type StoreClientConfigInputOptions
• type StoreClientConfigOutputOptions

Functions

func DefaultGetClientConfigCommand

func DefaultGetClientConfigCommand(version core.RuntimeVersion, opts ...CfgClientConfigArgsOption) *core.Command

DefaultGetClientConfigCommand creates a GetClientConfig Command with default input and output options

func DefaultStoreClientConfigCommand

func DefaultStoreClientConfigCommand(version core.RuntimeVersion, opts ...CfgClientConfigArgsOption) *core.Command

DefaultStoreClientConfigCommand creates a StoreClientConfig Command with default input and output options

func NewGetClientConfigCommand

func NewGetClientConfigCommand(inputOpts *GetClientConfigInputOptions, outputOpts *GetClientConfigOutputOptions) (*core.Command, error)

NewGetClientConfigCommand constructs a command to make a call to GetClientConfig API Input Parameter: inputOpts has all input parameters which are required for Runtime GetClientConfig API Input Parameter: outputOpts has details about expected output from Runtime GetClientConfig API call Return: command to execute or error if any validations fails for GetClientConfigInputOptions or GetClientConfigOutputOptions This method does validate the input parameters GetClientConfigInputOptions or GetClientConfigOutputOptions based on Runtime API Version For more details about supported parameters refer to GetClientConfigInputOptions or GetClientConfigOutputOptions definition (and ClientConfigOpts struct, which is embedded)

func NewStoreClientConfigCommand

func NewStoreClientConfigCommand(inputOpts *StoreClientConfigInputOptions, outputOpts *StoreClientConfigOutputOptions) (*core.Command, error)

NewStoreClientConfigCommand constructs a command to make a call to StoreClientConfig API Input Parameter: inputOpts has all input parameters which are required for Runtime StoreClientConfig API Input Parameter: outputOpts has details about expected output from Runtime StoreClientConfig API call Return: command to execute or error if any validations fails for StoreClientConfigInputOptions or StoreClientConfigOutputOptions This method does validate the input parameters StoreClientConfigInputOptions or StoreClientConfigOutputOptions based on Runtime API Version For more details about supported parameters refer to SetContextInputOptions or StoreClientConfigOutputOptions definition (and ClientConfigOpts struct, which is embedded)

Types

type CfgClientConfigArgs

type CfgClientConfigArgs struct {
	*core.RuntimeAPIVersion
	ClientConfigOpts   *types.ClientConfigOpts
	ValidationStrategy core.ValidationStrategy
	Error              string
}

CfgClientConfigArgs used to build the arguments for client config commands

type CfgClientConfigArgsOption

type CfgClientConfigArgsOption func(*CfgClientConfigArgs)

func WithCLIDiscoverySources

func WithCLIDiscoverySources(version core.RuntimeVersion, sources []types.PluginDiscoveryOpts) CfgClientConfigArgsOption

WithCLIDiscoverySources used to build the cli discovery sources arguments for client config commands

func WithClientConfigOpts

func WithClientConfigOpts(cf *types.ClientConfigOpts) CfgClientConfigArgsOption

func WithDefaultCLIDiscoverySource

func WithDefaultCLIDiscoverySource(version core.RuntimeVersion) CfgClientConfigArgsOption

WithDefaultCLIDiscoverySource used to build the default cli discovery sources arguments for client config commands

func WithDefaultContextAndServer

func WithDefaultContextAndServer(version core.RuntimeVersion) CfgClientConfigArgsOption

WithDefaultContextAndServer used to build the default server and context arguments for client config commands

func WithDefaultFeatureFlags

func WithDefaultFeatureFlags() CfgClientConfigArgsOption

WithDefaultFeatureFlags used to build the default feature flags arguments for client config commands

func WithDefaultServer

func WithDefaultServer(version core.RuntimeVersion) CfgClientConfigArgsOption

WithDefaultServer used to build the default server arguments for client config commands

func WithError

func WithError(e string) CfgClientConfigArgsOption

func WithFeatureFlags

func WithFeatureFlags(features map[string]types.FeatureMap) CfgClientConfigArgsOption

WithFeatureFlags used to build the feature flags arguments for client config commands

func WithRuntimeVersion

func WithRuntimeVersion(v core.RuntimeVersion) CfgClientConfigArgsOption

func WithValidationStrategy

func WithValidationStrategy(vs core.ValidationStrategy) CfgClientConfigArgsOption

type GetClientConfigInputOptions

type GetClientConfigInputOptions struct {
	*core.RuntimeAPIVersion // required
}

GetClientConfigInputOptions used to generate GetClientConfig command

type GetClientConfigOutputOptions

type GetClientConfigOutputOptions struct {
	*core.RuntimeAPIVersion                         // required
	ClientConfigOpts        *types.ClientConfigOpts // required
	ValidationStrategy      core.ValidationStrategy // Type of validation to be performed i.e. exact or partial. default is partial
	Error                   string                  // expected error message could be the sub string of actual error message
}

GetClientConfigOutputOptions used to generate GetClientConfig command

type StoreClientConfigInputOptions

type StoreClientConfigInputOptions struct {
	*core.RuntimeAPIVersion                         // required
	ClientConfigOpts        *types.ClientConfigOpts // required
}

StoreClientConfigInputOptions used to generate StoreClientConfig command

type StoreClientConfigOutputOptions

type StoreClientConfigOutputOptions struct {
	*core.RuntimeAPIVersion                         // required
	ValidationStrategy      core.ValidationStrategy // Type of validation to be performed i.e. exact or partial. default is partial
	Error                   string                  // expected error message could be the sub string of actual error message
}

StoreClientConfigOutputOptions used to generate StoreClientConfig command