plank

package module

Go to main page

Versions in this module

v4

v4.2.1

Nov 2, 2023

v4.2.0

Nov 2, 2023

v4.1.2

Sep 14, 2023

Changes in this version

type Client

+ func (c *Client) UpsertPipelineUsingOrca(p Pipeline, id, traceparent string) error

v4.1.1

Aug 25, 2023

v4.1.0

Aug 24, 2022

Changes in this version

type Application

+ RepoProjectKey string

+ RepoSlug string

+ RepoType string

type Pipeline

+ Roles []string

v4.0.0

May 13, 2021

Changes in this version

+ const ApplicationContextJson

+ const ApplicationJson

+ const SpinFiatAccountHeader

+ const SpinFiatUserHeader

+ var DefaultURLs = map[string]string

+ type Application struct

+ AppMetadata map[string]interface{}

+ DataSources *DataSourcesType

+ Description string

+ Email string

+ Name string

+ Notifications NotificationsType

+ Permissions *PermissionsType

+ User string

+ func (a Application) MarshalJSON() ([]byte, error)

+ type Authorization struct

+ Authorizations []string

+ Name string

+ type Client struct

+ ArmoryEndpoints bool

+ FiatUser string

+ URLs map[string]string

+ UseGate bool

+ func New(opts ...ClientOption) *Client

+ func (c *Client) ArmoryEndpointsEnabled() bool

+ func (c *Client) CreateApplication(a *Application, traceparent string) error

+ func (c *Client) CreateTask(app, desc, traceparent string, payload interface{}) (*TaskRefResponse, error)

+ func (c *Client) Delete(url, traceparent string) error

+ func (c *Client) DeleteApplication(name, traceparent string) error

+ func (c *Client) DeletePipeline(p Pipeline, traceparent string) error

+ func (c *Client) DeletePipelineByName(app, pipeline, traceparent string) error

+ func (c *Client) DeleteWithRetry(url, traceparent string) error

+ func (c *Client) DisableARmoryEndpoints()

+ func (c *Client) EnableArmoryEndpoints()

+ func (c *Client) Execute(application, pipeline, traceparent string) (*PipelineRef, error)

+ func (c *Client) Get(url, traceparent string, dest interface{}) error

+ func (c *Client) GetApplication(name, traceparent string) (*Application, error)

+ func (c *Client) GetApplicationNotifications(appName, traceparent string) (*NotificationsType, error)

+ func (c *Client) GetApplications(traceparent string) (*[]Application, error)

+ func (c *Client) GetPipelines(app, traceparent string) ([]Pipeline, error)

+ func (c *Client) GetTask(refURL, traceparent string) (*ExecutionStatusResponse, error)

+ func (c *Client) GetUser(name, traceparent string) (*User, error)

+ func (c *Client) GetWithRetry(url, traceparent string, dest interface{}) error

+ func (c *Client) HasAppWriteAccess(username, app, traceparent string) (bool, error)

+ func (c *Client) IsAdmin(username, traceparent string) (bool, error)

+ func (c *Client) Patch(url, traceparent string, contentType ContentType, body interface{}, ...) error

+ func (c *Client) PatchWithRetry(url, traceparent string, contentType ContentType, body interface{}, ...) error

+ func (c *Client) PollTaskStatus(refURL, traceparent string) (*ExecutionStatusResponse, error)

+ func (c *Client) Post(url, traceparent string, contentType ContentType, body interface{}, ...) error

+ func (c *Client) PostWithRetry(url, traceparent string, contentType ContentType, body interface{}, ...) error

+ func (c *Client) Put(url, traceparent string, contentType ContentType, body interface{}, ...) error

+ func (c *Client) PutWithRetry(url, traceparent string, contentType ContentType, body interface{}, ...) error

+ func (c *Client) RequestWithRetry(f RequestFunction) error

+ func (c *Client) ResyncFiat(traceparent string) error

+ func (c *Client) UpdateApplication(app Application, traceparent string) error

+ func (c *Client) UpdateApplicationNotifications(notifications NotificationsType, appName, traceparent string) error

+ func (c *Client) UpdatePermissions(appName, traceparent string, permissions *PermissionsType) error

+ func (c *Client) UpsertPipeline(p Pipeline, id, traceparent string) error

+ func (c *Client) UseGateEndpoints()

+ func (c *Client) UseServiceEndpoints()

+ func (c *Client) UserRoles(username, traceparent string) ([]string, error)

+ type ClientOption func(*Client)

+ func WithClient(client *http.Client) ClientOption

+ func WithFiatUser(user string) ClientOption

+ func WithMaxRetries(retries int) ClientOption

+ func WithOverrideAllURLs(urls map[string]string) ClientOption

+ func WithRetryIncrement(t time.Duration) ClientOption

+ func WithTransport(transport *http.Transport) ClientOption

+ type ContentType string

+ type DataSourcesType struct

+ Disabled []string

+ Enabled []string

+ type ErrUnsupportedStatusCode struct

+ Code int

+ func (e *ErrUnsupportedStatusCode) Error() string

+ type ExecutionStatusResponse struct

+ EndTime int

+ ID string

+ Status string

+ type FailedResponse struct

+ Response []byte

+ StatusCode int

+ func (e *FailedResponse) Error() string

+ type FiatClient interface

+ UserRoles func(username, traceparent string) ([]string, error)

+ type FiatClientFactory func(opts ...ClientOption) FiatClient

+ type FiatPermissionEvaluator struct

+ func NewFiatPermissionEvaluator(opts ...PermissionEvaluatorOpt) *FiatPermissionEvaluator

+ func (f *FiatPermissionEvaluator) HasReadPermission(user, traceparent string, rp ReadPermissable) (bool, error)

+ type FiatRole struct

+ Name string

+ Source string

+ type Front50Permissions struct

+ Name string

+ Permissions *PermissionsType

+ type Method string

+ const Get

+ const Patch

+ const Post

+ const Put

+ type NotificationsType map[string]interface

+ func (notifications *NotificationsType) FillAppNotificationFields(appName string)

+ func (notifications *NotificationsType) ValidateAppNotification() error

+ type PermissionEvaluatorOpt func(fpe *FiatPermissionEvaluator)

+ func WithClientOptions(opts ...ClientOption) PermissionEvaluatorOpt

+ func WithOrMode(orMode bool) PermissionEvaluatorOpt

+ type PermissionsEvaluator interface

+ HasReadPermission func(user string, rp ReadPermissable) (bool, error)

+ type PermissionsType struct

+ Execute []string

+ Read []string

+ Write []string

+ type Pipeline struct

+ Application string

+ Config interface{}

+ Description string

+ ExecutionEngine string

+ ExpectedArtifacts []map[string]interface{}

+ ID string

+ KeepWaitingPipelines bool

+ LastModifiedBy string

+ LimitConcurrent bool

+ Locked *PipelineLockType

+ Name string

+ Notifications []map[string]interface{}

+ Parallel bool

+ Parameters []map[string]interface{}

+ SpelEvaluator string

+ Stages []map[string]interface{}

+ Triggers []map[string]interface{}

+ Type string

+ UpdateTs string

+ func (p *Pipeline) Lock() *Pipeline

+ func (p *Pipeline) ValidateRefIds() ValidationResult

+ type PipelineLockType struct

+ AllowUnlockUI bool

+ UI bool

+ type PipelineRef struct

+ Ref string

+ type ReadPermissable interface

+ GetName func() string

+ GetPermissions func() []string

+ type RequestFunction func() error

+ type Task struct

+ Application string

+ Description string

+ Job []interface{}

+ type TaskRefResponse struct

+ Ref string

+ type User struct

+ Accounts []Authorization

+ Admin bool

+ Applications []Authorization

+ Name string

+ func (u *User) HasAppWriteAccess(app string) bool

+ func (u *User) IsAdmin() bool

+ type ValidationResult struct

+ Errors []error

+ Warnings []string

Other modules containing this package

github.com/armory/plank

github.com/armory/plank/v2

github.com/armory/plank/v3

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