storagebuckets

package
v0.0.58 Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2025 License: MPL-2.0 Imports: 12 Imported by: 1

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, scopeId string, opt ...Option) (*StorageBucketCreateResult, error)

func (*Client) Delete 

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

func (*Client) List 

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

func (*Client) ListNextPage added in v0.0.53 

func (c *Client) ListNextPage(ctx context.Context, currentPage *StorageBucketListResult, opt ...Option) (*StorageBucketListResult, error)

func (*Client) Read 

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

func (*Client) Update 

func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*StorageBucketUpdateResult, 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 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 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 WithBucketName 

func WithBucketName(inBucketName string) Option

func WithBucketPrefix 

func WithBucketPrefix(inBucketPrefix string) Option

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 WithPluginId 

func WithPluginId(inPluginId string) Option

func WithPluginName 

func WithPluginName(inPluginName string) Option

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 WithSecrets 

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

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.

func WithWorkerFilter 

func WithWorkerFilter(inWorkerFilter string) Option

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"`
	StorageBucketCredentialId string                 `json:"storage_bucket_credential_id,omitempty"`
	AuthorizedActions         []string               `json:"authorized_actions,omitempty"`
}

type StorageBucketCreateResult 

type StorageBucketCreateResult = StorageBucketReadResult

type StorageBucketDeleteResult 

type StorageBucketDeleteResult struct {
	Response *api.Response
}

func (StorageBucketDeleteResult) GetItem 

func (n StorageBucketDeleteResult) GetItem() any

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
	// contains filtered or unexported fields
}

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

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.