client

Documentation

Overview

Package client provides methods to interact with Feature and FeatureGate resources

Index

• type FeatureGateClient
  • func NewFeatureGateClient(options ...Option) (*FeatureGateClient, error)
  • func (f *FeatureGateClient) ActivateFeature(ctx context.Context, featureName, featureGateName string) error
  • func (f *FeatureGateClient) DeactivateFeature(ctx context.Context, featureName, featureGateName string) error
  • func (f *FeatureGateClient) GetFeature(ctx context.Context, featureName string) (*configv1alpha1.Feature, error)
  • func (f *FeatureGateClient) GetFeatureGate(ctx context.Context, featureGateName string) (*configv1alpha1.FeatureGate, error)
• type Option
  • func WithClient(cl client.Client) Option

Types

type FeatureGateClient

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

FeatureGateClient defines methods to interact with FeatureGate resources

func NewFeatureGateClient

func NewFeatureGateClient(options ...Option) (*FeatureGateClient, error)

NewFeatureGateClient returns an instance of FeatureGateClient.

func (*FeatureGateClient) ActivateFeature

func (f *FeatureGateClient) ActivateFeature(ctx context.Context, featureName, featureGateName string) error

ActivateFeature activates a Feature

func (*FeatureGateClient) DeactivateFeature

func (f *FeatureGateClient) DeactivateFeature(ctx context.Context, featureName, featureGateName string) error

DeactivateFeature deactivates a Feature

func (*FeatureGateClient) GetFeature

func (f *FeatureGateClient) GetFeature(ctx context.Context, featureName string) (*configv1alpha1.Feature, error)

GetFeature fetches the Feature

func (*FeatureGateClient) GetFeatureGate

func (f *FeatureGateClient) GetFeatureGate(ctx context.Context, featureGateName string) (*configv1alpha1.FeatureGate, error)

GetFeatureGate fetches the FeatureGate

type Option

type Option func(*FeatureGateClient) *FeatureGateClient

Option is FeatureGateClient Option definition

func WithClient

func WithClient(cl client.Client) Option

WithClient function is for setting the passed in client when creating FeatureGateClient