workers

Documentation

Overview

Code generated by "make api"; DO NOT EDIT.

Index

• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) ApiClient() *api.Client
  • func (c *Client) CreateWorkerLed(ctx context.Context, workerGeneratedAuthToken string, scopeId string, ...) (*WorkerCreateResult, error)
  • func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*WorkerDeleteResult, error)
  • func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*WorkerListResult, error)
  • func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*WorkerReadResult, error)
  • func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*WorkerUpdateResult, error)
• type Option
  • func DefaultDescription() Option
  • func DefaultName() Option
  • func WithAutomaticVersioning(enable bool) Option
  • func WithDescription(inDescription string) Option
  • func WithFilter(filter string) Option
  • func WithName(inName string) Option
  • func WithRecursive(recurse bool) Option
  • func WithSkipCurlOutput(skip bool) Option
• type Worker
• type WorkerCreateResult
• type WorkerDeleteResult
  • func (n WorkerDeleteResult) GetItem() interface{}
  • func (n WorkerDeleteResult) GetResponse() *api.Response
• type WorkerListResult
  • func (n WorkerListResult) GetItems() []*Worker
  • func (n WorkerListResult) GetResponse() *api.Response
• type WorkerReadResult
  • func (n WorkerReadResult) GetItem() *Worker
  • func (n WorkerReadResult) GetResponse() *api.Response
• type WorkerUpdateResult

Types

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) ApiClient

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

ApiClient returns the underlying API client

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) 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 ther 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 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 WithName

func WithName(inName string) Option

func WithRecursive

func WithRecursive(recurse bool) Option

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

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 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"`
	ActiveConnectionCount    uint32              `json:"active_connection_count,omitempty"`
	Type                     string              `json:"type,omitempty"`
	ApiTags                  map[string][]string `json:"api_tags,omitempty"`
	AuthorizedActions        []string            `json:"authorized_actions,omitempty"`
	// contains filtered or unexported fields
}

type WorkerCreateResult

type WorkerCreateResult = WorkerReadResult

type WorkerDeleteResult

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

func (WorkerDeleteResult) GetItem

func (n WorkerDeleteResult) GetItem() interface{}

GetItem will always be nil for WorkerDeleteResult

func (WorkerDeleteResult) GetResponse

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

type WorkerListResult

type WorkerListResult struct {
	Items []*Worker
	// contains filtered or unexported fields
}

func (WorkerListResult) GetItems

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

func (WorkerListResult) GetResponse

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

type WorkerReadResult

type WorkerReadResult struct {
	Item *Worker
	// contains filtered or unexported fields
}

func (WorkerReadResult) GetItem

func (n WorkerReadResult) GetItem() *Worker

func (WorkerReadResult) GetResponse

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

type WorkerUpdateResult

type WorkerUpdateResult = WorkerReadResult