Documentation
¶
Index ¶
- Variables
- type StorageBucket
- func (*StorageBucket) Descriptor() ([]byte, []int)deprecated
- func (x *StorageBucket) GetAttributes() *structpb.Struct
- func (x *StorageBucket) GetAuthorizedActions() []string
- func (x *StorageBucket) GetBucketName() string
- func (x *StorageBucket) GetBucketPrefix() string
- func (x *StorageBucket) GetCreatedTime() *timestamppb.Timestamp
- func (x *StorageBucket) GetDescription() *wrapperspb.StringValue
- func (x *StorageBucket) GetId() string
- func (x *StorageBucket) GetName() *wrapperspb.StringValue
- func (x *StorageBucket) GetPlugin() *plugins.PluginInfo
- func (x *StorageBucket) GetPluginId() string
- func (x *StorageBucket) GetScope() *scopes.ScopeInfo
- func (x *StorageBucket) GetScopeId() string
- func (x *StorageBucket) GetSecrets() *structpb.Struct
- func (x *StorageBucket) GetSecretsHmac() string
- func (x *StorageBucket) GetStorageBucketCredentialId() string
- func (x *StorageBucket) GetType() string
- func (x *StorageBucket) GetUpdatedTime() *timestamppb.Timestamp
- func (x *StorageBucket) GetVersion() uint32
- func (x *StorageBucket) GetWorkerFilter() string
- func (*StorageBucket) ProtoMessage()
- func (x *StorageBucket) ProtoReflect() protoreflect.Message
- func (x *StorageBucket) Reset()
- func (x *StorageBucket) String() string
- type StorageBucketPersisted
- func (*StorageBucketPersisted) Descriptor() ([]byte, []int)deprecated
- func (x *StorageBucketPersisted) GetData() *structpb.Struct
- func (*StorageBucketPersisted) ProtoMessage()
- func (x *StorageBucketPersisted) ProtoReflect() protoreflect.Message
- func (x *StorageBucketPersisted) Reset()
- func (x *StorageBucketPersisted) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_controller_api_resources_storagebuckets_v1_storage_bucket_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type StorageBucket ¶
type StorageBucket struct {
// Output only. The ID of the storage bucket.
Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
// The ID of the Scope of which this storage bucket is a part.
ScopeId string `protobuf:"bytes,20,opt,name=scope_id,proto3" json:"scope_id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
// Output only. Scope information for this resource.
Scope *scopes.ScopeInfo `protobuf:"bytes,30,opt,name=scope,proto3" json:"scope,omitempty"`
// The ID of the plugin of which this storage bucket is created.
PluginId string `protobuf:"bytes,34,opt,name=plugin_id,proto3" json:"plugin_id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
// Output only. Plugin information for this resource.
Plugin *plugins.PluginInfo `protobuf:"bytes,35,opt,name=plugin,proto3" json:"plugin,omitempty"`
// Optional name for identification purposes.
Name *wrapperspb.StringValue `protobuf:"bytes,40,opt,name=name,proto3" json:"name,omitempty" class:"public"` // @gotags: `class:"public"`
// Optional user-set description for identification purposes.
Description *wrapperspb.StringValue `protobuf:"bytes,50,opt,name=description,proto3" json:"description,omitempty" class:"public"` // @gotags: `class:"public"`
// The name of the bucket within the external object store service.
BucketName string `protobuf:"bytes,60,opt,name=bucket_name,proto3" json:"bucket_name,omitempty" class:"public"` // @gotags: `class:"public"`
// The prefix used to organize the data held within the external object store.
BucketPrefix string `protobuf:"bytes,70,opt,name=bucket_prefix,proto3" json:"bucket_prefix,omitempty" class:"public"` // @gotags: `class:"public"`
// Output only. The time this resource was created.
CreatedTime *timestamppb.Timestamp `protobuf:"bytes,80,opt,name=created_time,proto3" json:"created_time,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamppb.Timestamp `protobuf:"bytes,90,opt,name=updated_time,proto3" json:"updated_time,omitempty" class:"secret"` // @gotags: `class:"secret"`
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
Version uint32 `protobuf:"varint,100,opt,name=version,proto3" json:"version,omitempty" class:"public"` // @gotags: `class:"public"`
// The type of Storage Bucket (currently only plugin).
Type string `protobuf:"bytes,110,opt,name=type,proto3" json:"type,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"`
// Attributes specific to the catalog type.
Attributes *structpb.Struct `protobuf:"bytes,120,opt,name=attributes,proto3" json:"attributes,omitempty" class:"public"` // @gotags: `class:"public"`
// Secrets specific to the storage bucket type. These are never output.
Secrets *structpb.Struct `protobuf:"bytes,130,opt,name=secrets,proto3" json:"secrets,omitempty" class:"public"` // @gotags: `class:"public"`
// Output only. The HMAC of the last secrets supplied via the API, if any.
SecretsHmac string `protobuf:"bytes,140,opt,name=secrets_hmac,json=secretsHmac,proto3" json:"secrets_hmac,omitempty" class:"public"` // @gotags: `class:"public"`
// Filters to the worker(s) that can handle requests for this storage bucket
WorkerFilter string `protobuf:"bytes,150,opt,name=worker_filter,proto3" json:"worker_filter,omitempty" class:"public"` // @gotags: `class:"public"`
// Internal use only. The storage bucket credential id for this storage bucket.
StorageBucketCredentialId string `` // @gotags: `class:"public"`
/* 157-byte string literal not displayed */
// Output only. The available actions on this resource for this user.
AuthorizedActions []string `protobuf:"bytes,300,rep,name=authorized_actions,proto3" json:"authorized_actions,omitempty" class:"public"` // @gotags: `class:"public"`
// contains filtered or unexported fields
}
StorageBucket manages external object stores
func (*StorageBucket) Descriptor
deprecated
func (*StorageBucket) Descriptor() ([]byte, []int)
Deprecated: Use StorageBucket.ProtoReflect.Descriptor instead.
func (*StorageBucket) GetAttributes ¶
func (x *StorageBucket) GetAttributes() *structpb.Struct
func (*StorageBucket) GetAuthorizedActions ¶
func (x *StorageBucket) GetAuthorizedActions() []string
func (*StorageBucket) GetBucketName ¶
func (x *StorageBucket) GetBucketName() string
func (*StorageBucket) GetBucketPrefix ¶
func (x *StorageBucket) GetBucketPrefix() string
func (*StorageBucket) GetCreatedTime ¶
func (x *StorageBucket) GetCreatedTime() *timestamppb.Timestamp
func (*StorageBucket) GetDescription ¶
func (x *StorageBucket) GetDescription() *wrapperspb.StringValue
func (*StorageBucket) GetId ¶
func (x *StorageBucket) GetId() string
func (*StorageBucket) GetName ¶
func (x *StorageBucket) GetName() *wrapperspb.StringValue
func (*StorageBucket) GetPlugin ¶
func (x *StorageBucket) GetPlugin() *plugins.PluginInfo
func (*StorageBucket) GetPluginId ¶
func (x *StorageBucket) GetPluginId() string
func (*StorageBucket) GetScope ¶
func (x *StorageBucket) GetScope() *scopes.ScopeInfo
func (*StorageBucket) GetScopeId ¶
func (x *StorageBucket) GetScopeId() string
func (*StorageBucket) GetSecrets ¶
func (x *StorageBucket) GetSecrets() *structpb.Struct
func (*StorageBucket) GetSecretsHmac ¶
func (x *StorageBucket) GetSecretsHmac() string
func (*StorageBucket) GetStorageBucketCredentialId ¶ added in v0.0.48
func (x *StorageBucket) GetStorageBucketCredentialId() string
func (*StorageBucket) GetType ¶
func (x *StorageBucket) GetType() string
func (*StorageBucket) GetUpdatedTime ¶
func (x *StorageBucket) GetUpdatedTime() *timestamppb.Timestamp
func (*StorageBucket) GetVersion ¶
func (x *StorageBucket) GetVersion() uint32
func (*StorageBucket) GetWorkerFilter ¶
func (x *StorageBucket) GetWorkerFilter() string
func (*StorageBucket) ProtoMessage ¶
func (*StorageBucket) ProtoMessage()
func (*StorageBucket) ProtoReflect ¶
func (x *StorageBucket) ProtoReflect() protoreflect.Message
func (*StorageBucket) Reset ¶
func (x *StorageBucket) Reset()
func (*StorageBucket) String ¶
func (x *StorageBucket) String() string
type StorageBucketPersisted ¶
type StorageBucketPersisted struct {
// Data has no explicit structure other than valid json.
// Data may contain sensitive information, such as
// credentials, rotated secrets, or configuration data.
// Data can be anything that may need to be provided to
// a series of different method calls.
// Data is encrypted at-rest by Boundary.
// Data is never returned to the end user.
Data *structpb.Struct `protobuf:"bytes,10,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
StorageBucketPersisted is data that the plugin can read from and write to that will always be provided by the host.
func (*StorageBucketPersisted) Descriptor
deprecated
func (*StorageBucketPersisted) Descriptor() ([]byte, []int)
Deprecated: Use StorageBucketPersisted.ProtoReflect.Descriptor instead.
func (*StorageBucketPersisted) GetData ¶
func (x *StorageBucketPersisted) GetData() *structpb.Struct
func (*StorageBucketPersisted) ProtoMessage ¶
func (*StorageBucketPersisted) ProtoMessage()
func (*StorageBucketPersisted) ProtoReflect ¶
func (x *StorageBucketPersisted) ProtoReflect() protoreflect.Message
func (*StorageBucketPersisted) Reset ¶
func (x *StorageBucketPersisted) Reset()
func (*StorageBucketPersisted) String ¶
func (x *StorageBucketPersisted) String() string
Click to show internal directories.
Click to hide internal directories.