Help us shape the future of Go! Take the 2026 Go Developer Survey

featureavailability

package
v6.0.1 Latest Latest
Warning

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

Go to latest
Published: Jan 26, 2022 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client interface {
	// [Preview API] Retrieve a listing of all feature flags and their current states for a user
	GetAllFeatureFlags(context.Context, GetAllFeatureFlagsArgs) (*[]FeatureFlag, error)
	// [Preview API] Retrieve information on a single feature flag and its current states
	GetFeatureFlagByName(context.Context, GetFeatureFlagByNameArgs) (*FeatureFlag, error)
	// [Preview API] Retrieve information on a single feature flag and its current states for a user
	GetFeatureFlagByNameAndUserEmail(context.Context, GetFeatureFlagByNameAndUserEmailArgs) (*FeatureFlag, error)
	// [Preview API] Retrieve information on a single feature flag and its current states for a user
	GetFeatureFlagByNameAndUserId(context.Context, GetFeatureFlagByNameAndUserIdArgs) (*FeatureFlag, error)
	// [Preview API] Change the state of an individual feature flag for a name
	UpdateFeatureFlag(context.Context, UpdateFeatureFlagArgs) (*FeatureFlag, error)
}

func NewClient

func NewClient(ctx context.Context, connection *azuredevops.Connection) Client

type ClientImpl

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) GetAllFeatureFlags

func (client *ClientImpl) GetAllFeatureFlags(ctx context.Context, args GetAllFeatureFlagsArgs) (*[]FeatureFlag, error)

[Preview API] Retrieve a listing of all feature flags and their current states for a user

func (*ClientImpl) GetFeatureFlagByName

func (client *ClientImpl) GetFeatureFlagByName(ctx context.Context, args GetFeatureFlagByNameArgs) (*FeatureFlag, error)

[Preview API] Retrieve information on a single feature flag and its current states

func (*ClientImpl) GetFeatureFlagByNameAndUserEmail

func (client *ClientImpl) GetFeatureFlagByNameAndUserEmail(ctx context.Context, args GetFeatureFlagByNameAndUserEmailArgs) (*FeatureFlag, error)

[Preview API] Retrieve information on a single feature flag and its current states for a user

func (*ClientImpl) GetFeatureFlagByNameAndUserId

func (client *ClientImpl) GetFeatureFlagByNameAndUserId(ctx context.Context, args GetFeatureFlagByNameAndUserIdArgs) (*FeatureFlag, error)

[Preview API] Retrieve information on a single feature flag and its current states for a user

func (*ClientImpl) UpdateFeatureFlag

func (client *ClientImpl) UpdateFeatureFlag(ctx context.Context, args UpdateFeatureFlagArgs) (*FeatureFlag, error)

[Preview API] Change the state of an individual feature flag for a name

type FeatureFlag

type FeatureFlag struct {
	Description    *string `json:"description,omitempty"`
	EffectiveState *string `json:"effectiveState,omitempty"`
	ExplicitState  *string `json:"explicitState,omitempty"`
	Name           *string `json:"name,omitempty"`
	Uri            *string `json:"uri,omitempty"`
}

type FeatureFlagPatch

type FeatureFlagPatch struct {
	State *string `json:"state,omitempty"`
}

This is passed to the FeatureFlagController to edit the status of a feature flag

type GetAllFeatureFlagsArgs

type GetAllFeatureFlagsArgs struct {
	// (optional) The email of the user to check
	UserEmail *string
}

Arguments for the GetAllFeatureFlags function

type GetFeatureFlagByNameAndUserEmailArgs

type GetFeatureFlagByNameAndUserEmailArgs struct {
	// (required) The name of the feature to retrieve
	Name *string
	// (required) The email of the user to check
	UserEmail *string
	// (optional) Check if feature exists
	CheckFeatureExists *bool
}

Arguments for the GetFeatureFlagByNameAndUserEmail function

type GetFeatureFlagByNameAndUserIdArgs

type GetFeatureFlagByNameAndUserIdArgs struct {
	// (required) The name of the feature to retrieve
	Name *string
	// (required) The id of the user to check
	UserId *uuid.UUID
	// (optional) Check if feature exists
	CheckFeatureExists *bool
}

Arguments for the GetFeatureFlagByNameAndUserId function

type GetFeatureFlagByNameArgs

type GetFeatureFlagByNameArgs struct {
	// (required) The name of the feature to retrieve
	Name *string
	// (optional) Check if feature exists
	CheckFeatureExists *bool
}

Arguments for the GetFeatureFlagByName function

type UpdateFeatureFlagArgs

type UpdateFeatureFlagArgs struct {
	// (required) State that should be set
	State *FeatureFlagPatch
	// (required) The name of the feature to change
	Name *string
	// (optional)
	UserEmail *string
	// (optional) Checks if the feature exists before setting the state
	CheckFeatureExists *bool
	// (optional)
	SetAtApplicationLevelAlso *bool
}

Arguments for the UpdateFeatureFlag function

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL