Documentation ¶
Index ¶
- Constants
- type Option
- func WithAttributes(attrs *structpb.Struct) Option
- func WithBucketPrefix(bp string) Option
- func WithChunkSize(chunkSize uint32) Option
- func WithDescription(desc string) Option
- func WithLimit(l int) Option
- func WithName(name string) Option
- func WithSecrets(secrets *structpb.Struct) Option
- func WithVersion(v uint32) Option
- func WithWorkerFilter(wf string) Option
- type Repository
- type StorageBucket
- type StorageBucketSecret
Constants ¶
const ( // DefaultChunkSize is the default chunk size for streaming DefaultChunkSize = 65536 // 64KiB )
const StorageDomain = "storage"
const (
Subtype = subtypes.Subtype("plugin")
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*options)
Option - how Options are passed as arguments.
func WithAttributes ¶
WithAttributes provides an optional attributes field.
func WithBucketPrefix ¶
WithBucketPrefix provides an optional bucket prefix.
func WithChunkSize ¶
WithChunkSize provides an optional chunkSize to associate with a StorageClient. ChunkSize is the number of bytes to send to the plugin in a single request. If not provided, the default is 64KiB. The recommended chunk size for GRPC streamed messages is 16KiB to 64KiB.
func WithDescription ¶
WithDescription provides an optional description.
func WithLimit ¶
WithLimit provides an option to provide a limit. Intentionally allowing negative integers. If WithLimit < 0, then unlimited results are returned. If WithLimit == 0, then default limits are used for results.
func WithSecrets ¶
WithSecrets provides an optional secrets field.
func WithVersion ¶
WithVersion provides an optional version number
func WithWorkerFilter ¶
WithWorkerFilter provides a worker filter that indicate which workers can support requests for this storage bucket.
type Repository ¶
type Repository struct {
// contains filtered or unexported fields
}
type StorageBucket ¶
type StorageBucket struct { *store.StorageBucket Secrets *structpb.Struct `gorm:"-"` // contains filtered or unexported fields }
StorageBucket represents a bucket within an external object store. It contains secret data needed to create and read objects within the external object store.
func (*StorageBucket) SetTableName ¶
func (s *StorageBucket) SetTableName(n string)
SetTableName sets the table name.
func (*StorageBucket) TableName ¶
func (s *StorageBucket) TableName() string
TableName returns the table name for the storage bucket.
type StorageBucketSecret ¶
type StorageBucketSecret struct { *store.StorageBucketSecret // contains filtered or unexported fields }
func (*StorageBucketSecret) SetTableName ¶
func (sbs *StorageBucketSecret) SetTableName(n string)
SetTableName sets the table name.
func (*StorageBucketSecret) TableName ¶
func (sbs *StorageBucketSecret) TableName() string
TableName returns the table name for the storage bucket secrets.