workers

package
v0.0.53 Latest Latest
Warning

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

 Go to latest Published: Sep 30, 2024 License: MPL-2.0 Imports: 9 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Certificate added in v0.0.30 

type Certificate struct {
	Id              string    `json:"id,omitempty"`
	PublicKeySha256 string    `json:"public_key_sha256,omitempty"`
	NotBeforeTime   time.Time `json:"not_before_time,omitempty"`
	NotAfterTime    time.Time `json:"not_after_time,omitempty"`
}

type CertificateAuthority added in v0.0.30 

type CertificateAuthority struct {
	Certs []*Certificate `json:"certs,omitempty"`
}

type CertificateAuthorityReadResult added in v0.0.30 

type CertificateAuthorityReadResult struct {
	Item     *CertificateAuthority
	Response *api.Response
}

func (CertificateAuthorityReadResult) GetItem added in v0.0.30 

func (n CertificateAuthorityReadResult) GetItem() *CertificateAuthority

func (CertificateAuthorityReadResult) GetResponse added in v0.0.30 

func (n CertificateAuthorityReadResult) GetResponse() *api.Response

type CertificateAuthorityReinitializeResult added in v0.0.30 

type CertificateAuthorityReinitializeResult = CertificateAuthorityReadResult

type Client 

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

Client is a client for this collection

func NewClient 

func NewClient(c *api.Client) *Client

Creates a new client for this collection. The submitted API client is cloned; modifications to it after generating this client will not have effect. If you need to make changes to the underlying API client, use ApiClient() to access it.

func (*Client) AddWorkerTags added in v0.0.29 

func (c *Client) AddWorkerTags(ctx context.Context, id string, version uint32, apiTags map[string][]string, opt ...Option) (*WorkerUpdateResult, error)

func (*Client) ApiClient 

func (c *Client) ApiClient() *api.Client

ApiClient returns the underlying API client

func (*Client) CreateControllerLed added in v0.0.29 

func (c *Client) CreateControllerLed(ctx context.Context, scopeId string, opt ...Option) (*WorkerCreateResult, error)

func (*Client) CreateWorkerLed 

func (c *Client) CreateWorkerLed(ctx context.Context, workerGeneratedAuthToken string, scopeId string, opt ...Option) (*WorkerCreateResult, error)

func (*Client) Delete 

func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*WorkerDeleteResult, error)

func (*Client) List 

func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*WorkerListResult, error)

func (*Client) Read 

func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*WorkerReadResult, error)

func (*Client) ReadCA added in v0.0.30 

func (c *Client) ReadCA(ctx context.Context, scopeId string, opt ...Option) (*CertificateAuthorityReadResult, error)

func (*Client) ReinitializeCA added in v0.0.30 

func (c *Client) ReinitializeCA(ctx context.Context, scopeId string, opt ...Option) (*CertificateAuthorityReinitializeResult, error)

func (*Client) RemoveWorkerTags added in v0.0.29 

func (c *Client) RemoveWorkerTags(ctx context.Context, id string, version uint32, apiTags map[string][]string, opt ...Option) (*WorkerUpdateResult, error)

func (*Client) SetWorkerTags added in v0.0.29 

func (c *Client) SetWorkerTags(ctx context.Context, id string, version uint32, apiTags map[string][]string, opt ...Option) (*WorkerUpdateResult, error)

func (*Client) Update 

func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*WorkerUpdateResult, error)

type Option 

type Option func(*options)

Option is a func that sets optional attributes for a call. This does not need to be used directly, but instead option arguments are built from the functions in this package. WithX options set a value to that given in the argument; DefaultX options indicate that the value should be set to its default. When an API call is made options are processed in the order they appear in the function call, so for a given argument X, a succession of WithX or DefaultX calls will result in the last call taking effect.

func DefaultDescription 

func DefaultDescription() Option

func DefaultName 

func DefaultName() Option

func WithAutomaticVersioning 

func WithAutomaticVersioning(enable bool) Option

If set, and if the version is zero during an update, the API will perform a fetch to get the current version of the resource and populate it during the update call. This is convenient but opens up the possibility for subtle order-of-modification issues, so use carefully.

func WithClientDirectedPagination added in v0.0.53 

func WithClientDirectedPagination(with bool) Option

WithClientDirectedPagination tells the List function to return only the first page, if more pages are available

func WithDescription 

func WithDescription(inDescription string) Option

func WithFilter 

func WithFilter(filter string) Option

WithFilter tells the API to filter the items returned using the provided filter term. The filter should be in a format supported by hashicorp/go-bexpr.

func WithListToken added in v0.0.44 

func WithListToken(listToken string) Option

WithListToken tells the API to use the provided list token for listing operations on this resource.

func WithName 

func WithName(inName string) Option

func WithPageSize added in v0.0.53 

func WithPageSize(with uint32) Option

WithPageSize controls the size of pages used during List

func WithRecursive 

func WithRecursive(recurse bool) Option

WithRecursive tells the API to use recursion for listing operations on this resource

func WithResourcePathOverride added in v0.0.53 

func WithResourcePathOverride(path string) Option

WithResourcePathOverride tells the API to use the provided resource path

func WithSkipCurlOutput 

func WithSkipCurlOutput(skip bool) Option

WithSkipCurlOutput tells the API to not use the current call for cURL output. Useful for when we need to look up versions.

type RemoteStoragePermissions added in v0.0.52 

type RemoteStoragePermissions struct {
	Write  string `json:"write,omitempty"`
	Read   string `json:"read,omitempty"`
	Delete string `json:"delete,omitempty"`
}

type RemoteStorageState added in v0.0.52 

type RemoteStorageState struct {
	Status      string                    `json:"status,omitempty"`
	Permissions *RemoteStoragePermissions `json:"permissions,omitempty"`
}

type Worker 

type Worker struct {
	Id                                 string                        `json:"id,omitempty"`
	ScopeId                            string                        `json:"scope_id,omitempty"`
	Scope                              *scopes.ScopeInfo             `json:"scope,omitempty"`
	Name                               string                        `json:"name,omitempty"`
	Description                        string                        `json:"description,omitempty"`
	CreatedTime                        time.Time                     `json:"created_time,omitempty"`
	UpdatedTime                        time.Time                     `json:"updated_time,omitempty"`
	Version                            uint32                        `json:"version,omitempty"`
	Address                            string                        `json:"address,omitempty"`
	CanonicalTags                      map[string][]string           `json:"canonical_tags,omitempty"`
	ConfigTags                         map[string][]string           `json:"config_tags,omitempty"`
	LastStatusTime                     time.Time                     `json:"last_status_time,omitempty"`
	WorkerGeneratedAuthToken           string                        `json:"worker_generated_auth_token,omitempty"`
	ControllerGeneratedActivationToken string                        `json:"controller_generated_activation_token,omitempty"`
	ActiveConnectionCount              uint32                        `json:"active_connection_count,omitempty"`
	Type                               string                        `json:"type,omitempty"`
	ApiTags                            map[string][]string           `json:"api_tags,omitempty"`
	ReleaseVersion                     string                        `json:"release_version,omitempty"`
	DirectlyConnectedDownstreamWorkers []string                      `json:"directly_connected_downstream_workers,omitempty"`
	AuthorizedActions                  []string                      `json:"authorized_actions,omitempty"`
	LocalStorageState                  string                        `json:"local_storage_state,omitempty"`
	RemoteStorageState                 map[string]RemoteStorageState `json:"remote_storage_state,omitempty"`
}

type WorkerCreateResult 

type WorkerCreateResult = WorkerReadResult

type WorkerDeleteResult 

type WorkerDeleteResult struct {
	Response *api.Response
}

func (WorkerDeleteResult) GetItem 

func (n WorkerDeleteResult) GetItem() any

GetItem will always be nil for WorkerDeleteResult

func (WorkerDeleteResult) GetResponse 

func (n WorkerDeleteResult) GetResponse() *api.Response

type WorkerListResult 

type WorkerListResult struct {
	Items        []*Worker `json:"items,omitempty"`
	EstItemCount uint      `json:"est_item_count,omitempty"`
	RemovedIds   []string  `json:"removed_ids,omitempty"`
	ListToken    string    `json:"list_token,omitempty"`
	ResponseType string    `json:"response_type,omitempty"`
	Response     *api.Response
	// contains filtered or unexported fields
}

func (WorkerListResult) GetEstItemCount added in v0.0.44 

func (n WorkerListResult) GetEstItemCount() uint

func (WorkerListResult) GetItems 

func (n WorkerListResult) GetItems() []*Worker

func (WorkerListResult) GetListToken added in v0.0.44 

func (n WorkerListResult) GetListToken() string

func (WorkerListResult) GetRemovedIds added in v0.0.44 

func (n WorkerListResult) GetRemovedIds() []string

func (WorkerListResult) GetResponse 

func (n WorkerListResult) GetResponse() *api.Response

func (WorkerListResult) GetResponseType added in v0.0.44 

func (n WorkerListResult) GetResponseType() string

type WorkerReadResult 

type WorkerReadResult struct {
	Item     *Worker
	Response *api.Response
}

func (WorkerReadResult) GetItem 

func (n WorkerReadResult) GetItem() *Worker

func (WorkerReadResult) GetResponse 

func (n WorkerReadResult) GetResponse() *api.Response

type WorkerUpdateResult 

type WorkerUpdateResult = WorkerReadResult

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.