Documentation ¶
Index ¶
- type Client
- func (c *Client) ApiClient() *api.Client
- func (c *Client) Create(ctx context.Context, scopeId string, opt ...Option) (*StorageBucketCreateResult, error)
- func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*StorageBucketDeleteResult, error)
- func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*StorageBucketListResult, error)
- func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*StorageBucketReadResult, error)
- func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*StorageBucketUpdateResult, error)
- type Option
- func DefaultAttributes() Option
- func DefaultBucketName() Option
- func DefaultBucketPrefix() Option
- func DefaultDescription() Option
- func DefaultName() Option
- func DefaultSecrets() Option
- func DefaultWorkerFilter() Option
- func WithAttributes(inAttributes map[string]interface{}) Option
- func WithAutomaticVersioning(enable bool) Option
- func WithBucketName(inBucketName string) Option
- func WithBucketPrefix(inBucketPrefix string) Option
- func WithDescription(inDescription string) Option
- func WithFilter(filter string) Option
- func WithListToken(listToken string) Option
- func WithName(inName string) Option
- func WithPluginId(inPluginId string) Option
- func WithPluginName(inPluginName string) Option
- func WithRecursive(recurse bool) Option
- func WithSecrets(inSecrets map[string]interface{}) Option
- func WithSkipCurlOutput(skip bool) Option
- func WithWorkerFilter(inWorkerFilter string) Option
- type StorageBucket
- type StorageBucketCreateResult
- type StorageBucketDeleteResult
- type StorageBucketListResult
- func (n StorageBucketListResult) GetEstItemCount() uint
- func (n StorageBucketListResult) GetItems() []*StorageBucket
- func (n StorageBucketListResult) GetListToken() string
- func (n StorageBucketListResult) GetRemovedIds() []string
- func (n StorageBucketListResult) GetResponse() *api.Response
- func (n StorageBucketListResult) GetResponseType() string
- type StorageBucketReadResult
- type StorageBucketUpdateResult
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 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 DefaultBucketName ¶
func DefaultBucketName() Option
func DefaultBucketPrefix ¶
func DefaultBucketPrefix() Option
func DefaultDescription ¶
func DefaultDescription() Option
func DefaultName ¶
func DefaultName() Option
func DefaultSecrets ¶
func DefaultSecrets() Option
func DefaultWorkerFilter ¶
func DefaultWorkerFilter() 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 WithBucketName ¶
func WithBucketPrefix ¶
func WithDescription ¶
func WithFilter ¶
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
WithListToken tells the API to use the provided list token for listing operations on this resource.
func WithPluginId ¶
func WithPluginName ¶
func WithRecursive ¶
WithRecursive tells the API to use recursion for listing operations on this resource
func WithSecrets ¶
func WithSkipCurlOutput ¶
WithSkipCurlOutput tells the API to not use the current call for cURL output. Useful for when we need to look up versions.
func WithWorkerFilter ¶
type StorageBucket ¶
type StorageBucket 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"` BucketName string `json:"bucket_name,omitempty"` BucketPrefix string `json:"bucket_prefix,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"` WorkerFilter string `json:"worker_filter,omitempty"` AuthorizedActions []string `json:"authorized_actions,omitempty"` }
type StorageBucketCreateResult ¶
type StorageBucketCreateResult = StorageBucketReadResult
type StorageBucketDeleteResult ¶
func (StorageBucketDeleteResult) GetItem ¶
func (n StorageBucketDeleteResult) GetItem() interface{}
GetItem will always be nil for StorageBucketDeleteResult
func (StorageBucketDeleteResult) GetResponse ¶
func (n StorageBucketDeleteResult) GetResponse() *api.Response
type StorageBucketListResult ¶
type StorageBucketListResult struct { Items []*StorageBucket `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 (StorageBucketListResult) GetEstItemCount ¶ added in v0.0.44
func (n StorageBucketListResult) GetEstItemCount() uint
func (StorageBucketListResult) GetItems ¶
func (n StorageBucketListResult) GetItems() []*StorageBucket
func (StorageBucketListResult) GetListToken ¶ added in v0.0.44
func (n StorageBucketListResult) GetListToken() string
func (StorageBucketListResult) GetRemovedIds ¶ added in v0.0.44
func (n StorageBucketListResult) GetRemovedIds() []string
func (StorageBucketListResult) GetResponse ¶
func (n StorageBucketListResult) GetResponse() *api.Response
func (StorageBucketListResult) GetResponseType ¶ added in v0.0.44
func (n StorageBucketListResult) GetResponseType() string
type StorageBucketReadResult ¶
type StorageBucketReadResult struct { Item *StorageBucket Response *api.Response }
func (StorageBucketReadResult) GetItem ¶
func (n StorageBucketReadResult) GetItem() *StorageBucket
func (StorageBucketReadResult) GetResponse ¶
func (n StorageBucketReadResult) GetResponse() *api.Response
type StorageBucketUpdateResult ¶
type StorageBucketUpdateResult = StorageBucketReadResult