client

package

Go to main page

Versions in this module

v1

v1.19.0

Feb 26, 2025

Changes in this version

+ type BasicIdentity struct

+ Password string

type CheckInfo

+ Startup CheckStartup

+ type CheckStartup string

+ const CheckStartupDisabled

+ const CheckStartupEnabled

type CheckStatus

+ const CheckStatusInactive

+ type ChecksActionOptions struct

+ Names []string

+ type ChecksActionResult struct

+ Changed []string

type Client

+ func (client *Client) StartChecks(opts *ChecksActionOptions) (*ChecksActionResult, error)

+ func (client *Client) StopChecks(opts *ChecksActionOptions) (*ChecksActionResult, error)

type Identity

+ Basic *BasicIdentity

v1.18.0

Jan 30, 2025

v1.17.0

Dec 1, 2024

Changes in this version

type AddLayerOptions

+ Inner bool

v1.16.0

Aug 29, 2024

Changes in this version

type Client

+ func (client *Client) LatestWarningTime() time.Time

type NoticeType

+ const WarningNotice

v1.15.0

Jul 16, 2024

Changes in this version

type Client

+ func (client *Client) AddIdentities(identities map[string]*Identity) error

+ func (client *Client) Identities(opts *IdentitiesOptions) (map[string]*Identity, error)

+ func (client *Client) RemoveIdentities(identityNames map[string]struct{}) error

+ func (client *Client) ReplaceIdentities(identities map[string]*Identity) error

+ func (client *Client) UpdateIdentities(identities map[string]*Identity) error

+ type IdentitiesOptions struct

+ type Identity struct

+ Access IdentityAccess

+ Local *LocalIdentity

+ type IdentityAccess string

+ const AdminAccess

+ const ReadAccess

+ const UntrustedAccess

+ type LocalIdentity struct

+ UserID *uint32

v1.14.1

Jul 15, 2024

v1.14.0

Jul 7, 2024

v1.13.0

Jul 1, 2024

v1.12.0

Jun 10, 2024

v1.11.0

Apr 26, 2024

Changes in this version

type CheckInfo

+ ChangeID string

v1.10.2

Apr 3, 2024

v1.10.1

Mar 28, 2024 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

Changes in this version

type NoticeType

+ const ChangeUpdateNotice

v1.10.0

Mar 28, 2024 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

v1.9.1

Mar 21, 2024 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

v1.9.0

Feb 28, 2024 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

v1.8.0

Feb 15, 2024 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

v1.7.4

Apr 3, 2024

v1.7.3

Mar 5, 2024

v1.7.2

Feb 28, 2024 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

Changes in this version

type NoticesOptions

+ Users NoticesUsers

+ type NoticesUsers string

+ const NoticesUsersAll

v1.7.1

Feb 20, 2024 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

v1.7.0

Dec 14, 2023 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

Changes in this version

type Notice

+ UserID *uint32

type NoticesOptions

+ Select NoticesSelect

+ UserID *uint32

+ type NoticesSelect string

+ const NoticesSelectAll

v1.6.0

Nov 30, 2023 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

Changes in this version

type Client

+ func (client *Client) Pull(opts *PullOptions) error

+ func (client *Client) Push(opts *PushOptions) error

+ type PullOptions struct

+ Path string

+ Target io.Writer

+ type PushOptions struct

+ Group string

+ GroupID *int

+ MakeDirs bool

+ Path string

+ Permissions os.FileMode

+ Source io.Reader

+ User string

+ UserID *int

type RequestResponse

+ Headers http.Header

v1.5.0

Oct 30, 2023 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

Changes in this version

+ const ErrorKindGenericFileError

+ const ErrorKindNotFound

+ const ErrorKindPermissionDenied

type Client

+ func (client *Client) Notice(id string) (*Notice, error)

+ func (client *Client) Notices(opts *NoticesOptions) ([]*Notice, error)

+ func (client *Client) Notify(opts *NotifyOptions) (string, error)

+ func (client *Client) Requester() Requester

+ func (client *Client) WaitNotices(ctx context.Context, serverTimeout time.Duration, opts *NoticesOptions) ([]*Notice, error)

+ type Notice struct

+ ExpireAfter time.Duration

+ FirstOccurred time.Time

+ ID string

+ Key string

+ LastData map[string]string

+ LastOccurred time.Time

+ LastRepeated time.Time

+ Occurrences int

+ RepeatAfter time.Duration

+ Type NoticeType

+ type NoticeType string

+ const CustomNotice

+ type NoticesOptions struct

+ After time.Time

+ Keys []string

+ Types []NoticeType

+ type NotifyOptions struct

+ Data map[string]string

+ Key string

+ RepeatAfter time.Duration

+ Type NoticeType

+ type RequestOptions struct

+ Body io.Reader

+ Headers map[string]string

+ Method string

+ Path string

+ Query url.Values

+ Type RequestType

+ type RequestResponse struct

+ Body io.ReadCloser

+ ChangeID string

+ Result []byte

+ StatusCode int

+ func (resp *RequestResponse) DecodeResult(result interface{}) error

+ type RequestType int

+ const AsyncRequest

+ const RawRequest

+ const SyncRequest

+ type Requester interface

+ Do func(ctx context.Context, opts *RequestOptions) (*RequestResponse, error)

+ Transport func() *http.Transport

v1.4.2

Apr 3, 2024

v1.4.1

Feb 20, 2024 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

v1.4.0

Sep 28, 2023 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

Changes in this version

type Client

+ func (client *Client) Health(opts *HealthOptions) (health bool, err error)

+ type HealthOptions struct

+ Level CheckLevel

+ Names []string

v1.3.0

Sep 3, 2023 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

Changes in this version

type ExecOptions

+ ServiceContext string

v1.2.0

May 22, 2023 GO-2024-2692

GO-2024-2692: Pebble service manager's file pull API allows access by any user in github.com/canonical/pebble

v1.1.1

Apr 3, 2024

Changes in this version

+ const ErrorKindDaemonRestart

+ const ErrorKindLoginRequired

+ const ErrorKindNoDefaultServices

+ const ErrorKindSystemRestart

+ var ErrNoData = fmt.Errorf("data entry not found")

+ func FakeDoRetry(retry, timeout time.Duration) (restore func())

+ type AddLayerOptions struct

+ Combine bool

+ Label string

+ LayerData []byte

+ type Change struct

+ Err string

+ ID string

+ Kind string

+ Ready bool

+ ReadyTime time.Time

+ SpawnTime time.Time

+ Status string

+ Summary string

+ Tasks []*Task

+ func (c *Change) Get(key string, value interface{}) error

+ type ChangeSelector uint8

+ const ChangesAll

+ const ChangesInProgress

+ const ChangesReady

+ func (c ChangeSelector) String() string

+ type ChangesOptions struct

+ Selector ChangeSelector

+ ServiceName string

+ type CheckInfo struct

+ Failures int

+ Level CheckLevel

+ Name string

+ Status CheckStatus

+ Threshold int

+ type CheckLevel string

+ const AliveLevel

+ const ReadyLevel

+ const UnsetLevel

+ type CheckStatus string

+ const CheckStatusDown

+ const CheckStatusUp

+ type ChecksOptions struct

+ Level CheckLevel

+ Names []string

+ type Client struct

+ func New(config *Config) (*Client, error)

+ func (client *Client) Abort(id string) (*Change, error)

+ func (client *Client) AddLayer(opts *AddLayerOptions) error

+ func (client *Client) AutoStart(opts *ServiceOptions) (changeID string, err error)

+ func (client *Client) Change(id string) (*Change, error)

+ func (client *Client) Changes(opts *ChangesOptions) ([]*Change, error)

+ func (client *Client) Checks(opts *ChecksOptions) ([]*CheckInfo, error)

+ func (client *Client) CloseIdleConnections()

+ func (client *Client) DebugGet(action string, result interface{}, params map[string]string) error

+ func (client *Client) DebugPost(action string, params interface{}, result interface{}) error

+ func (client *Client) Exec(opts *ExecOptions) (*ExecProcess, error)

+ func (client *Client) FollowLogs(ctx context.Context, opts *LogsOptions) error

+ func (client *Client) Hijack(f func(*http.Request) (*http.Response, error))

+ func (client *Client) ListFiles(opts *ListFilesOptions) ([]*FileInfo, error)

+ func (client *Client) Logs(opts *LogsOptions) error

+ func (client *Client) Maintenance() error

+ func (client *Client) MakeDir(opts *MakeDirOptions) error

+ func (client *Client) Okay(t time.Time) error

+ func (client *Client) PlanBytes(_ *PlanOptions) (data []byte, err error)

+ func (client *Client) RemovePath(opts *RemovePathOptions) error

+ func (client *Client) Replan(opts *ServiceOptions) (changeID string, err error)

+ func (client *Client) Restart(opts *ServiceOptions) (changeID string, err error)

+ func (client *Client) SendSignal(opts *SendSignalOptions) error

+ func (client *Client) Services(opts *ServicesOptions) ([]*ServiceInfo, error)

+ func (client *Client) Start(opts *ServiceOptions) (changeID string, err error)

+ func (client *Client) Stop(opts *ServiceOptions) (changeID string, err error)

+ func (client *Client) SysInfo() (*SysInfo, error)

+ func (client *Client) WaitChange(id string, opts *WaitChangeOptions) (*Change, error)

+ func (client *Client) Warnings(opts WarningsOptions) ([]*Warning, error)

+ func (client *Client) WarningsSummary() (count int, timestamp time.Time)

+ type Config struct

+ BaseURL string

+ DisableKeepAlive bool

+ Socket string

+ UserAgent string

+ type ConnectionError struct

+ func (e ConnectionError) Error() string

+ func (e ConnectionError) Unwrap() error

+ type Error struct

+ Kind string

+ Message string

+ StatusCode int

+ Value interface{}

+ func (e *Error) Error() string

+ type ExecOptions struct

+ Command []string

+ Environment map[string]string

+ Group string

+ GroupID *int

+ Height int

+ Interactive bool

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ Terminal bool

+ Timeout time.Duration

+ User string

+ UserID *int

+ Width int

+ WorkingDir string

+ type ExecProcess struct

+ func (p *ExecProcess) SendResize(width, height int) error

+ func (p *ExecProcess) SendSignal(signal string) error

+ func (p *ExecProcess) Wait() error

+ type ExitError struct

+ func (e *ExitError) Error() string

+ func (e *ExitError) ExitCode() int

+ type FileInfo struct

+ func (fi *FileInfo) Group() string

+ func (fi *FileInfo) GroupID() *int

+ func (fi *FileInfo) IsDir() bool

+ func (fi *FileInfo) ModTime() time.Time

+ func (fi *FileInfo) Mode() os.FileMode

+ func (fi *FileInfo) Name() string

+ func (fi *FileInfo) Path() string

+ func (fi *FileInfo) Size() int64

+ func (fi *FileInfo) Sys() interface{}

+ func (fi *FileInfo) User() string

+ func (fi *FileInfo) UserID() *int

+ type ListFilesOptions struct

+ Itself bool

+ Path string

+ Pattern string

+ type LogEntry struct

+ Message string

+ Service string

+ Time time.Time

+ type LogsOptions struct

+ N int

+ Services []string

+ WriteLog func(entry LogEntry) error

+ type MakeDirOptions struct

+ Group string

+ GroupID *int

+ MakeParents bool

+ Path string

+ Permissions os.FileMode

+ User string

+ UserID *int

+ type PlanOptions struct

+ type RemovePathOptions struct

+ Path string

+ Recursive bool

+ type RequestError struct

+ func (e RequestError) Error() string

+ type ResultInfo struct

+ type SendSignalOptions struct

+ Services []string

+ Signal string

+ type ServiceInfo struct

+ Current ServiceStatus

+ CurrentSince time.Time

+ Name string

+ Startup ServiceStartup

+ type ServiceOptions struct

+ Names []string

+ type ServiceStartup string

+ const StartupDisabled

+ const StartupEnabled

+ type ServiceStatus string

+ const StatusActive

+ const StatusBackoff

+ const StatusError

+ const StatusInactive

+ type ServicesOptions struct

+ Names []string

+ type SocketNotFoundError struct

+ Err error

+ Path string

+ func (s SocketNotFoundError) Error() string

+ func (s SocketNotFoundError) Unwrap() error

+ type SysInfo struct

+ BootID string

+ Version string

+ type Task struct

+ Data map[string]*json.RawMessage

+ ID string

+ Kind string

+ Log []string

+ Progress TaskProgress

+ ReadyTime time.Time

+ SpawnTime time.Time

+ Status string

+ Summary string

+ func (t *Task) Get(key string, value interface{}) error

+ type TaskProgress struct

+ Done int

+ Label string

+ Total int

+ type WaitChangeOptions struct

+ Timeout time.Duration

+ type Warning struct

+ ExpireAfter time.Duration

+ FirstAdded time.Time

+ LastAdded time.Time

+ LastShown time.Time

+ Message string

+ RepeatAfter time.Duration

+ type WarningsOptions struct

+ All bool

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