projectvariable

Documentation

Overview

Package projectvariable set implements functionality related to project variables

Index

• type GetProjectVariableSetsInput
• type GetProjectVariablesInput
• type PatchProjectVariablesInput
• type Service
  • func NewService(logger logger.Logger, dbClient *db.Client, ...) Service
• type SetProjectVariablesInput

Types

type GetProjectVariableSetsInput

type GetProjectVariableSetsInput struct {
	// Sort specifies the field to sort on and direction
	Sort *db.ProjectVariableSetSortableField
	// PaginationOptions supports cursor based pagination
	PaginationOptions *pagination.Options
	// The project ID to filter by
	ProjectID string
	// Latest specifies if the latest variable set should be returned
	Latest *bool
	// VariableID is the ID of the variable to filter by
	VariableID *string
	// RevisionSearch is the revision to search for
	RevisionSearch *string
}

GetProjectVariableSetsInput is the input for querying a list of variable sets

type GetProjectVariablesInput

type GetProjectVariablesInput struct {
	// Sort specifies the field to sort on and direction
	Sort *db.ProjectVariableSortableField
	// PaginationOptions supports cursor based pagination
	PaginationOptions *pagination.Options
	// ProjectID is the project ID to filter by
	ProjectID string
	// The project variable set ID to filter by
	ProjectVariableSetID *string
	// PipelineType is the pipeline type to filter by
	PipelineType *models.PipelineType
	// VariableKey is the key of the variable to filter by
	VariableKey *string
	// EnvironmentScopes are the environments to filter by
	EnvironmentScopes []string
	// CreatedAtTimeRangeEnd is the end of the created at time range to filter by (inclusive)
	CreatedAtTimeRangeEnd *time.Time
	// ExcludeVariableIDs is a list of variable IDs to exclude
	ExcludeVariableIDs []string
	// Search is used to search for a variable by key
	Search *string
}

GetProjectVariablesInput is the input for querying a list of variables

type PatchProjectVariablesInput

type PatchProjectVariablesInput struct {
	ProjectID         string
	RemoveVariableIDs []string
	CreateVariables   []*models.ProjectVariable
	ReplaceVariables  []*models.ProjectVariable
}

PatchProjectVariablesInput is the input for modifying project variables

type Service

type Service interface {
	GetProjectVariableSetByID(ctx context.Context, id string) (*models.ProjectVariableSet, error)
	GetProjectVariableSetByPRN(ctx context.Context, prn string) (*models.ProjectVariableSet, error)
	GetProjectVariableSetsByIDs(ctx context.Context, idList []string) ([]*models.ProjectVariableSet, error)
	GetProjectVariableSets(ctx context.Context, input *GetProjectVariableSetsInput) (*db.ProjectVariableSetsResult, error)
	GetProjectVariableByID(ctx context.Context, id string) (*models.ProjectVariable, error)
	GetProjectVariableByPRN(ctx context.Context, prn string) (*models.ProjectVariable, error)
	GetProjectVariablesByIDs(ctx context.Context, idList []string) ([]*models.ProjectVariable, error)
	GetProjectVariables(ctx context.Context, input *GetProjectVariablesInput) (*db.ProjectVariablesResult, error)
	SetProjectVariables(ctx context.Context, input *SetProjectVariablesInput) (*models.ProjectVariableSet, error)
	PatchProjectVariables(ctx context.Context, input *PatchProjectVariablesInput) (*models.ProjectVariableSet, error)
}

Service implements all variable set related functionality

func NewService

func NewService(
	logger logger.Logger,
	dbClient *db.Client,
	activityService activityevent.Service,
	limitChecker limits.LimitChecker,
) Service

NewService returns an instance of Service

type SetProjectVariablesInput

type SetProjectVariablesInput struct {
	ProjectID string
	Variables []*models.ProjectVariable
}

SetProjectVariablesInput is the input for replacing all the variables in a single operation