hostcatalogs

package
v0.0.51 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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

func (c *Client) Create(ctx context.Context, resourceType string, scopeId string, opt ...Option) (*HostCatalogCreateResult, error)

func (*Client) Delete 

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

func (*Client) List 

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

func (*Client) Read 

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

func (*Client) Update 

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

type HostCatalog 

type HostCatalog struct {
	Id                          string                 `json:"id,omitempty"`
	ScopeId                     string                 `json:"scope_id,omitempty"`
	Scope                       *scopes.ScopeInfo      `json:"scope,omitempty"`
	PluginId                    string                 `json:"plugin_id,omitempty"`
	Plugin                      *plugins.PluginInfo    `json:"plugin,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"`
	Type                        string                 `json:"type,omitempty"`
	Attributes                  map[string]interface{} `json:"attributes,omitempty"`
	Secrets                     map[string]interface{} `json:"secrets,omitempty"`
	SecretsHmac                 string                 `json:"secrets_hmac,omitempty"`
	AuthorizedActions           []string               `json:"authorized_actions,omitempty"`
	AuthorizedCollectionActions map[string][]string    `json:"authorized_collection_actions,omitempty"`
}

type HostCatalogCreateResult 

type HostCatalogCreateResult = HostCatalogReadResult

type HostCatalogDeleteResult 

type HostCatalogDeleteResult struct {
	Response *api.Response
}

func (HostCatalogDeleteResult) GetItem added in v0.0.10 

func (n HostCatalogDeleteResult) GetItem() interface{}

GetItem will always be nil for HostCatalogDeleteResult

func (HostCatalogDeleteResult) GetResponse added in v0.0.7 

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

type HostCatalogListResult 

type HostCatalogListResult struct {
	Items        []*HostCatalog `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
}

func (HostCatalogListResult) GetEstItemCount added in v0.0.44 

func (n HostCatalogListResult) GetEstItemCount() uint

func (HostCatalogListResult) GetItems 

func (n HostCatalogListResult) GetItems() []*HostCatalog

func (HostCatalogListResult) GetListToken added in v0.0.44 

func (n HostCatalogListResult) GetListToken() string

func (HostCatalogListResult) GetRemovedIds added in v0.0.44 

func (n HostCatalogListResult) GetRemovedIds() []string

func (HostCatalogListResult) GetResponse added in v0.0.7 

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

func (HostCatalogListResult) GetResponseType added in v0.0.44 

func (n HostCatalogListResult) GetResponseType() string

type HostCatalogReadResult 

type HostCatalogReadResult struct {
	Item     *HostCatalog
	Response *api.Response
}

func (HostCatalogReadResult) GetItem 

func (n HostCatalogReadResult) GetItem() *HostCatalog

func (HostCatalogReadResult) GetResponse added in v0.0.7 

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

type HostCatalogUpdateResult 

type HostCatalogUpdateResult = HostCatalogReadResult

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 DefaultAttributes 

func DefaultAttributes() Option

func DefaultDescription 

func DefaultDescription() Option

func DefaultName 

func DefaultName() Option

func DefaultSecrets added in v0.0.20 

func DefaultSecrets() Option

func WithAttributes 

func WithAttributes(inAttributes map[string]interface{}) 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 added in v0.0.6 

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 WithPluginId added in v0.0.20 

func WithPluginId(inPluginId string) Option

func WithPluginName added in v0.0.20 

func WithPluginName(inPluginName string) Option

func WithRecursive added in v0.0.4 

func WithRecursive(recurse bool) Option

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

func WithSecrets added in v0.0.20 

func WithSecrets(inSecrets map[string]interface{}) Option

func WithSkipCurlOutput added in v0.0.4 

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.

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.