Documentation
¶
Overview ¶
Code generated by "make api"; DO NOT EDIT.
Index ¶
- type Client
- func (c *Client) ApiClient() *api.Client
- func (c *Client) Create(ctx context.Context, resourceType string, scopeId string, opt ...Option) (*HostCatalogCreateResult, error)
- func (c *Client) Delete(ctx context.Context, hostCatalogId string, opt ...Option) (*HostCatalogDeleteResult, error)
- func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*HostCatalogListResult, error)
- func (c *Client) Read(ctx context.Context, hostCatalogId string, opt ...Option) (*HostCatalogReadResult, error)
- func (c *Client) Update(ctx context.Context, hostCatalogId string, version uint32, opt ...Option) (*HostCatalogUpdateResult, error)
- type HostCatalog
- type HostCatalogCreateResult
- type HostCatalogDeleteResult
- type HostCatalogListResult
- type HostCatalogReadResult
- type HostCatalogUpdateResult
- type Option
- func DefaultAttributes() Option
- func DefaultDescription() Option
- func DefaultName() Option
- func WithAttributes(inAttributes map[string]interface{}) 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
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 ¶
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.
type HostCatalog ¶
type HostCatalog 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"`
Type string `json:"type,omitempty"`
Attributes map[string]interface{} `json:"attributes,omitempty"`
AuthorizedActions []string `json:"authorized_actions,omitempty"`
AuthorizedCollectionActions map[string][]string `json:"authorized_collection_actions,omitempty"`
// contains filtered or unexported fields
}
type HostCatalogCreateResult ¶
type HostCatalogCreateResult = HostCatalogReadResult
type HostCatalogDeleteResult ¶
type HostCatalogDeleteResult struct {
// contains filtered or unexported fields
}
func (HostCatalogDeleteResult) GetResponse ¶ added in v0.0.7
func (n HostCatalogDeleteResult) GetResponse() *api.Response
type HostCatalogListResult ¶
type HostCatalogListResult struct {
Items []*HostCatalog
// contains filtered or unexported fields
}
func (HostCatalogListResult) GetItems ¶
func (n HostCatalogListResult) GetItems() interface{}
func (HostCatalogListResult) GetResponse ¶ added in v0.0.7
func (n HostCatalogListResult) GetResponse() *api.Response
type HostCatalogReadResult ¶
type HostCatalogReadResult struct {
Item *HostCatalog
// contains filtered or unexported fields
}
func (HostCatalogReadResult) GetItem ¶
func (n HostCatalogReadResult) GetItem() interface{}
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 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 DefaultAttributes ¶
func DefaultAttributes() Option
func DefaultDescription ¶
func DefaultDescription() Option
func DefaultName ¶
func DefaultName() Option
func WithAttributes ¶
func WithAutomaticVersioning ¶
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 WithFilter ¶ added in v0.0.6
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 WithRecursive ¶ added in v0.0.4
WithRecursive tells the API to use recursion for listing operations on this resource
func WithSkipCurlOutput ¶ added in v0.0.4
WithSkipCurlOutput tells the API to not use the current call for cURL output. Useful for when we need to look up versions.