Documentation ¶
Index ¶
- Variables
- type Host
- func (*Host) Descriptor() ([]byte, []int)deprecated
- func (x *Host) GetCatalogId() string
- func (x *Host) GetCreateTime() *timestamp.Timestamp
- func (x *Host) GetDescription() string
- func (x *Host) GetDnsNames() []string
- func (x *Host) GetExternalId() string
- func (x *Host) GetIpAddresses() []string
- func (x *Host) GetName() string
- func (x *Host) GetPublicId() string
- func (x *Host) GetUpdateTime() *timestamp.Timestamp
- func (x *Host) GetVersion() uint32
- func (*Host) ProtoMessage()
- func (x *Host) ProtoReflect() protoreflect.Message
- func (x *Host) Reset()
- func (x *Host) String() string
- type HostCatalog
- func (*HostCatalog) Descriptor() ([]byte, []int)deprecated
- func (x *HostCatalog) GetAttributes() []byte
- func (x *HostCatalog) GetCreateTime() *timestamp.Timestamp
- func (x *HostCatalog) GetDescription() string
- func (x *HostCatalog) GetName() string
- func (x *HostCatalog) GetPluginId() string
- func (x *HostCatalog) GetPublicId() string
- func (x *HostCatalog) GetScopeId() string
- func (x *HostCatalog) GetSecretsHmac() []byte
- func (x *HostCatalog) GetUpdateTime() *timestamp.Timestamp
- func (x *HostCatalog) GetVersion() uint32
- func (*HostCatalog) ProtoMessage()
- func (x *HostCatalog) ProtoReflect() protoreflect.Message
- func (x *HostCatalog) Reset()
- func (x *HostCatalog) String() string
- type HostCatalogSecret
- func (*HostCatalogSecret) Descriptor() ([]byte, []int)deprecated
- func (x *HostCatalogSecret) GetCatalogId() string
- func (x *HostCatalogSecret) GetCreateTime() *timestamp.Timestamp
- func (x *HostCatalogSecret) GetCtSecret() []byte
- func (x *HostCatalogSecret) GetKeyId() string
- func (x *HostCatalogSecret) GetSecret() []byte
- func (x *HostCatalogSecret) GetUpdateTime() *timestamp.Timestamp
- func (*HostCatalogSecret) ProtoMessage()
- func (x *HostCatalogSecret) ProtoReflect() protoreflect.Message
- func (x *HostCatalogSecret) Reset()
- func (x *HostCatalogSecret) String() string
- type HostSet
- func (*HostSet) Descriptor() ([]byte, []int)deprecated
- func (x *HostSet) GetAttributes() []byte
- func (x *HostSet) GetCatalogId() string
- func (x *HostSet) GetCreateTime() *timestamp.Timestamp
- func (x *HostSet) GetDescription() string
- func (x *HostSet) GetLastSyncTime() *timestamp.Timestamp
- func (x *HostSet) GetName() string
- func (x *HostSet) GetNeedSync() bool
- func (x *HostSet) GetPreferredEndpoints() []string
- func (x *HostSet) GetPublicId() string
- func (x *HostSet) GetSyncIntervalSeconds() int32
- func (x *HostSet) GetUpdateTime() *timestamp.Timestamp
- func (x *HostSet) GetVersion() uint32
- func (*HostSet) ProtoMessage()
- func (x *HostSet) ProtoReflect() protoreflect.Message
- func (x *HostSet) Reset()
- func (x *HostSet) String() string
- type HostSetMember
- func (*HostSetMember) Descriptor() ([]byte, []int)deprecated
- func (x *HostSetMember) GetCatalogId() string
- func (x *HostSetMember) GetHostId() string
- func (x *HostSetMember) GetSetId() string
- func (*HostSetMember) ProtoMessage()
- func (x *HostSetMember) ProtoReflect() protoreflect.Message
- func (x *HostSetMember) Reset()
- func (x *HostSetMember) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_controller_storage_host_plugin_store_v1_host_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Host ¶
type Host struct { // public_id is a surrogate key suitable for use in a public API. // @inject_tag: `gorm:"primary_key"` PublicId string `protobuf:"bytes,1,opt,name=public_id,json=publicId,proto3" json:"public_id,omitempty" gorm:"primary_key"` // external_id is an id provided by the plugin. // @inject_tag: `gorm:"not_null"` ExternalId string `protobuf:"bytes,2,opt,name=external_id,json=externalId,proto3" json:"external_id,omitempty" gorm:"not_null"` // The create_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` CreateTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty" gorm:"default:current_timestamp"` // The update_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` UpdateTime *timestamp.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty" gorm:"default:current_timestamp"` // name is optional. If set, it must be unique within // catalog_id. // @inject_tag: `gorm:"default:null"` Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty" gorm:"default:null"` // description is optional. // @inject_tag: `gorm:"default:null"` Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty" gorm:"default:null"` // catalog_id is the public_id of the owning // plugin_host_catalog and must be set. // @inject_tag: `gorm:"not_null"` CatalogId string `protobuf:"bytes,7,opt,name=catalog_id,json=catalogId,proto3" json:"catalog_id,omitempty" gorm:"not_null"` // version allows optimistic locking of the resource // @inject_tag: `gorm:"default:null"` Version uint32 `protobuf:"varint,8,opt,name=version,proto3" json:"version,omitempty" gorm:"default:null"` // ip_addresses are the ip addresses associated with this host and will // be persisted in the db through the HostAddress message. // @inject_tag: `gorm:"-"` IpAddresses []string `protobuf:"bytes,9,rep,name=ip_addresses,json=ipAddresses,proto3" json:"ip_addresses,omitempty" gorm:"-"` // dns_names are the dns names associated with this host and will // be persisted in the db through the HostAddress message. // @inject_tag: `gorm:"-"` DnsNames []string `protobuf:"bytes,10,rep,name=dns_names,json=dnsNames,proto3" json:"dns_names,omitempty" gorm:"-"` // contains filtered or unexported fields }
TODO: Add a field which tracks if the host in cache should be considered
invalid and fall back to the plugin provided data.
func (*Host) Descriptor
deprecated
func (*Host) GetCatalogId ¶
func (*Host) GetCreateTime ¶
func (*Host) GetDescription ¶
func (*Host) GetDnsNames ¶
func (*Host) GetExternalId ¶
func (*Host) GetIpAddresses ¶
func (*Host) GetPublicId ¶
func (*Host) GetUpdateTime ¶
func (*Host) GetVersion ¶
func (*Host) ProtoMessage ¶
func (*Host) ProtoMessage()
func (*Host) ProtoReflect ¶
func (x *Host) ProtoReflect() protoreflect.Message
type HostCatalog ¶
type HostCatalog struct { // public_id is a surrogate key suitable for use in a public API. // @inject_tag: `gorm:"primary_key"` PublicId string `protobuf:"bytes,1,opt,name=public_id,json=publicId,proto3" json:"public_id,omitempty" gorm:"primary_key"` // The create_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` CreateTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty" gorm:"default:current_timestamp"` // The update_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` UpdateTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty" gorm:"default:current_timestamp"` // name is optional. If set, it must be unique within scope_id. // @inject_tag: `gorm:"default:null"` Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty" gorm:"default:null"` // description is optional. // @inject_tag: `gorm:"default:null"` Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty" gorm:"default:null"` // The scope_id of the owning scope and must be set. // @inject_tag: `gorm:"not_null"` ScopeId string `protobuf:"bytes,6,opt,name=scope_id,json=scopeId,proto3" json:"scope_id,omitempty" gorm:"not_null"` // The public id of the plugin this catalog uses. // @inject_tag: `gorm:"not_null"` PluginId string `protobuf:"bytes,7,opt,name=plugin_id,json=pluginId,proto3" json:"plugin_id,omitempty" gorm:"not_null"` // version allows optimistic locking of the resource // @inject_tag: `gorm:"default:null"` Version uint32 `protobuf:"varint,8,opt,name=version,proto3" json:"version,omitempty" gorm:"default:null"` // secrets_hmac is a sha256-hmac of the unencrypted secrets that is returned // from the API for read. It is recalculated everytime the raw secrets are // updated. // @inject_tag: `gorm:"default:null"` SecretsHmac []byte `protobuf:"bytes,9,opt,name=secrets_hmac,json=secretsHmac,proto3" json:"secrets_hmac,omitempty" gorm:"default:null"` // attributes is a jsonb formatted field. // @inject_tag: `gorm:"not_null"` Attributes []byte `protobuf:"bytes,10,opt,name=attributes,proto3" json:"attributes,omitempty" gorm:"not_null"` // contains filtered or unexported fields }
func (*HostCatalog) Descriptor
deprecated
func (*HostCatalog) Descriptor() ([]byte, []int)
Deprecated: Use HostCatalog.ProtoReflect.Descriptor instead.
func (*HostCatalog) GetAttributes ¶
func (x *HostCatalog) GetAttributes() []byte
func (*HostCatalog) GetCreateTime ¶
func (x *HostCatalog) GetCreateTime() *timestamp.Timestamp
func (*HostCatalog) GetDescription ¶
func (x *HostCatalog) GetDescription() string
func (*HostCatalog) GetName ¶
func (x *HostCatalog) GetName() string
func (*HostCatalog) GetPluginId ¶
func (x *HostCatalog) GetPluginId() string
func (*HostCatalog) GetPublicId ¶
func (x *HostCatalog) GetPublicId() string
func (*HostCatalog) GetScopeId ¶
func (x *HostCatalog) GetScopeId() string
func (*HostCatalog) GetSecretsHmac ¶
func (x *HostCatalog) GetSecretsHmac() []byte
func (*HostCatalog) GetUpdateTime ¶
func (x *HostCatalog) GetUpdateTime() *timestamp.Timestamp
func (*HostCatalog) GetVersion ¶
func (x *HostCatalog) GetVersion() uint32
func (*HostCatalog) ProtoMessage ¶
func (*HostCatalog) ProtoMessage()
func (*HostCatalog) ProtoReflect ¶
func (x *HostCatalog) ProtoReflect() protoreflect.Message
func (*HostCatalog) Reset ¶
func (x *HostCatalog) Reset()
func (*HostCatalog) String ¶
func (x *HostCatalog) String() string
type HostCatalogSecret ¶
type HostCatalogSecret struct { // catalog_id is the public id of the catalog containing this secret. // @inject_tag: `gorm:"primary_key"` CatalogId string `protobuf:"bytes,1,opt,name=catalog_id,json=catalogId,proto3" json:"catalog_id,omitempty" gorm:"primary_key"` // The create_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` CreateTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty" gorm:"default:current_timestamp"` // The update_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` UpdateTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty" gorm:"default:current_timestamp"` // attributes is the plain-text of the attribute data. We are not storing // this plain-text value in the database. // @inject_tag: `gorm:"-" wrapping:"pt,secret_data"` Secret []byte `protobuf:"bytes,4,opt,name=secret,proto3" json:"secret,omitempty" gorm:"-" wrapping:"pt,secret_data"` // ct_attributes is the ciphertext of the attribute data stored in the db. // @inject_tag: `gorm:"column:secret;not_null" wrapping:"ct,secret_data"` CtSecret []byte `` /* 141-byte string literal not displayed */ // The key_id of the kms database key used for encrypting this entry. // It must be set. // @inject_tag: `gorm:"not_null"` KeyId string `protobuf:"bytes,6,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty" gorm:"not_null"` // contains filtered or unexported fields }
func (*HostCatalogSecret) Descriptor
deprecated
func (*HostCatalogSecret) Descriptor() ([]byte, []int)
Deprecated: Use HostCatalogSecret.ProtoReflect.Descriptor instead.
func (*HostCatalogSecret) GetCatalogId ¶
func (x *HostCatalogSecret) GetCatalogId() string
func (*HostCatalogSecret) GetCreateTime ¶
func (x *HostCatalogSecret) GetCreateTime() *timestamp.Timestamp
func (*HostCatalogSecret) GetCtSecret ¶
func (x *HostCatalogSecret) GetCtSecret() []byte
func (*HostCatalogSecret) GetKeyId ¶
func (x *HostCatalogSecret) GetKeyId() string
func (*HostCatalogSecret) GetSecret ¶
func (x *HostCatalogSecret) GetSecret() []byte
func (*HostCatalogSecret) GetUpdateTime ¶
func (x *HostCatalogSecret) GetUpdateTime() *timestamp.Timestamp
func (*HostCatalogSecret) ProtoMessage ¶
func (*HostCatalogSecret) ProtoMessage()
func (*HostCatalogSecret) ProtoReflect ¶
func (x *HostCatalogSecret) ProtoReflect() protoreflect.Message
func (*HostCatalogSecret) Reset ¶
func (x *HostCatalogSecret) Reset()
func (*HostCatalogSecret) String ¶
func (x *HostCatalogSecret) String() string
type HostSet ¶
type HostSet struct { // public_id is a surrogate key suitable for use in a public API. // @inject_tag: `gorm:"primary_key"` PublicId string `protobuf:"bytes,1,opt,name=public_id,json=publicId,proto3" json:"public_id,omitempty" gorm:"primary_key"` // The create_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` CreateTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty" gorm:"default:current_timestamp"` // The update_time is set by the database. // @inject_tag: `gorm:"default:current_timestamp"` UpdateTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty" gorm:"default:current_timestamp"` // The last_sync_time is updated every time a host set has been synced. // @inject_tag: `gorm:"default:null"` LastSyncTime *timestamp.Timestamp `protobuf:"bytes,4,opt,name=last_sync_time,json=lastSyncTime,proto3" json:"last_sync_time,omitempty" gorm:"default:null"` // The need_sync indicates that a sync needs to happen. // @inject_tag: `gorm:"not_null"` NeedSync bool `protobuf:"varint,5,opt,name=need_sync,json=needSync,proto3" json:"need_sync,omitempty" gorm:"not_null"` // name is optional. If set, it must be unique within // catalog_id. // @inject_tag: `gorm:"default:null"` Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty" gorm:"default:null"` // description is optional. // @inject_tag: `gorm:"default:null"` Description string `protobuf:"bytes,7,opt,name=description,proto3" json:"description,omitempty" gorm:"default:null"` // catalog_id is the public_id of the owning // plugin_host_catalog and must be set. // @inject_tag: `gorm:"not_null"` CatalogId string `protobuf:"bytes,8,opt,name=catalog_id,json=catalogId,proto3" json:"catalog_id,omitempty" gorm:"not_null"` // version allows optimistic locking of the resource // @inject_tag: `gorm:"default:null"` Version uint32 `protobuf:"varint,9,opt,name=version,proto3" json:"version,omitempty" gorm:"default:null"` // attributes is a byte field containing marshaled JSON data // @inject_tag: `gorm:"not_null"` Attributes []byte `protobuf:"bytes,10,opt,name=attributes,proto3" json:"attributes,omitempty" gorm:"not_null"` // preferred_endpoints stores string preference values // @inject_tag: `gorm:"-"` PreferredEndpoints []string `protobuf:"bytes,11,rep,name=preferred_endpoints,json=preferredEndpoints,proto3" json:"preferred_endpoints,omitempty" gorm:"-"` // Sync interval is a value representing a duration in seconds // @inject_tag: `gorm:"default:null"` SyncIntervalSeconds int32 `` /* 142-byte string literal not displayed */ // contains filtered or unexported fields }
func (*HostSet) Descriptor
deprecated
func (*HostSet) GetAttributes ¶
func (*HostSet) GetCatalogId ¶
func (*HostSet) GetCreateTime ¶
func (*HostSet) GetDescription ¶
func (*HostSet) GetLastSyncTime ¶
func (*HostSet) GetNeedSync ¶
func (*HostSet) GetPreferredEndpoints ¶
func (*HostSet) GetPublicId ¶
func (*HostSet) GetSyncIntervalSeconds ¶
func (*HostSet) GetUpdateTime ¶
func (*HostSet) GetVersion ¶
func (*HostSet) ProtoMessage ¶
func (*HostSet) ProtoMessage()
func (*HostSet) ProtoReflect ¶
func (x *HostSet) ProtoReflect() protoreflect.Message
type HostSetMember ¶
type HostSetMember struct { // @inject_tag: `gorm:"primary_key"` HostId string `protobuf:"bytes,1,opt,name=host_id,json=hostId,proto3" json:"host_id,omitempty" gorm:"primary_key"` // @inject_tag: `gorm:"primary_key"` SetId string `protobuf:"bytes,2,opt,name=set_id,json=setId,proto3" json:"set_id,omitempty" gorm:"primary_key"` // @inject_tag: `gorm:"default:null"` CatalogId string `protobuf:"bytes,3,opt,name=catalog_id,json=catalogId,proto3" json:"catalog_id,omitempty" gorm:"default:null"` // contains filtered or unexported fields }
func (*HostSetMember) Descriptor
deprecated
func (*HostSetMember) Descriptor() ([]byte, []int)
Deprecated: Use HostSetMember.ProtoReflect.Descriptor instead.
func (*HostSetMember) GetCatalogId ¶
func (x *HostSetMember) GetCatalogId() string
func (*HostSetMember) GetHostId ¶
func (x *HostSetMember) GetHostId() string
func (*HostSetMember) GetSetId ¶
func (x *HostSetMember) GetSetId() string
func (*HostSetMember) ProtoMessage ¶
func (*HostSetMember) ProtoMessage()
func (*HostSetMember) ProtoReflect ¶
func (x *HostSetMember) ProtoReflect() protoreflect.Message
func (*HostSetMember) Reset ¶
func (x *HostSetMember) Reset()
func (*HostSetMember) String ¶
func (x *HostSetMember) String() string
Click to show internal directories.
Click to hide internal directories.