taxonomy

package
v1.3.0 Latest Latest
Warning

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

 Go to latest Published: Mar 5, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

+kubebuilder:object:generate=true +fybrik:validation:schema

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Action 

type Action struct {
	// Action name
	Name ActionName `json:"name"`
	// Action properties, e.g., names of columns that should be masked
	AdditionalProperties serde.Properties `json:"-"`
}

Action to be performed on the data, e.g., masking +kubebuilder:pruning:PreserveUnknownFields

func (*Action) DeepCopy 

func (in *Action) DeepCopy() *Action

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Action.

func (*Action) DeepCopyInto 

func (in *Action) DeepCopyInto(out *Action)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Action) MarshalJSON 

func (o Action) MarshalJSON() ([]byte, error)

func (*Action) UnmarshalJSON 

func (o *Action) UnmarshalJSON(bytes []byte) (err error)

type ActionName 

type ActionName string

Name of the action to be performed, or Deny if access to the data is forbidden Action names should be defined in additional taxonomy layers

type AppInfo 

type AppInfo struct {
	serde.Properties `json:"-"`
}

Application specific properties, e.g., intent for using the data, user role and workload characteristics +kubebuilder:pruning:PreserveUnknownFields

func (*AppInfo) DeepCopy 

func (in *AppInfo) DeepCopy() *AppInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppInfo.

func (*AppInfo) DeepCopyInto 

func (in *AppInfo) DeepCopyInto(out *AppInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AssetID 

type AssetID string

Asset ID of the registered asset to be queried in the catalog, or a name of the new asset to be created and registered by Fybrik

type AttributeType added in v0.7.0 

type AttributeType string

+kubebuilder:validation:Enum=numeric;string;bool AttributeType enumeration: numeric, string, bool 

const (
	Numeric AttributeType = "numeric"
	String  AttributeType = "string"
	Bool    AttributeType = "bool"
)

List of attribute types

type Capability 

type Capability string

Capability declared by the module, e.g., read, delete, copy, write, transform

type Connection 

type Connection struct {
	// Name of the connection to the data source
	Name                 ConnectionType   `json:"name"`
	AdditionalProperties serde.Properties `json:"-"`
}

+kubebuilder:pruning:PreserveUnknownFields Name of the connection to the data source Connection details should be defined in additional taxonomy layers

func (*Connection) DeepCopy 

func (in *Connection) DeepCopy() *Connection

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Connection.

func (*Connection) DeepCopyInto 

func (in *Connection) DeepCopyInto(out *Connection)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Connection) MarshalJSON 

func (o Connection) MarshalJSON() ([]byte, error)

func (*Connection) UnmarshalJSON 

func (o *Connection) UnmarshalJSON(bytes []byte) (err error)

type ConnectionType 

type ConnectionType string

Name of the connection type to the data source

type DataFlow added in v0.7.0 

type DataFlow string

DataFlow indicates how the data is used by the workload, e.g., it is being read, copied, written or deleted +kubebuilder:validation:Enum=read;write;delete;copy 

const (
	// ReadFlow indicates a data set is being read
	ReadFlow DataFlow = "read"

	// WriteFlow indicates a data set is being written
	WriteFlow DataFlow = "write"

	// DeleteFlow indicates a data set is being deleted
	DeleteFlow DataFlow = "delete"

	// CopyFlow indicates a data set is being copied
	CopyFlow DataFlow = "copy"
)

type DataFormat 

type DataFormat string

Format in which the data is being read/written by the workload

type InfrastructureElement added in v0.7.0 

type InfrastructureElement struct {
	// Attribute name, defined in additional taxonomy layers
	Name string `json:"attribute"`
	// Description of the infrastructure attribute
	Description string `json:"description,omitempty"`
	// Name of the metric specified in the metrics section
	MetricName string `json:"metricName,omitempty"`
	// Attribute value
	Value string `json:"value"`
	// A resource defined by the attribute ("fybrikstorageaccount","fybrikmodule","cluster")
	Object InstanceType `json:"object"`
	// A reference to the resource instance, e.g. storage account name
	Instance string `json:"instance,omitempty"`
	// A list of arguments defining a specific metric, e.g. regions for a bandwidth
	Arguments []string `json:"arguments,omitempty"`
}

InfrastructureElement defines an infrastructure attribute - its measurement metric, value and relation to Fybrik resources

func (*InfrastructureElement) DeepCopy added in v0.7.0 

func (in *InfrastructureElement) DeepCopy() *InfrastructureElement

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InfrastructureElement.

func (*InfrastructureElement) DeepCopyInto added in v0.7.0 

func (in *InfrastructureElement) DeepCopyInto(out *InfrastructureElement)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type InfrastructureMetrics added in v1.0.0 

type InfrastructureMetrics struct {
	Name string `json:"name"`
	// Attribute type, e.g. numeric or string
	Type AttributeType `json:"type"`
	// Measurement units
	Units Units `json:"units,omitempty"`
	// A scale of values (minimum and maximum) when applicable
	Scale *RangeType `json:"scale,omitempty"`
}

Measurement metric defining units and the value scale used for value normalization

func (*InfrastructureMetrics) DeepCopy added in v1.0.0 

func (in *InfrastructureMetrics) DeepCopy() *InfrastructureMetrics

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InfrastructureMetrics.

func (*InfrastructureMetrics) DeepCopyInto added in v1.0.0 

func (in *InfrastructureMetrics) DeepCopyInto(out *InfrastructureMetrics)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type InstanceType added in v0.7.0 

type InstanceType string

+kubebuilder:validation:Enum=fybrikmodule;fybrikstorageaccount;cluster;inter-region InstanceType enumeration: fybrikmodule, cluster, fybrikstorageaccount, inter-region 

const (
	Module         InstanceType = "fybrikmodule"
	Cluster        InstanceType = "cluster"
	StorageAccount InstanceType = "fybrikstorageaccount"
	InterRegion    InstanceType = "inter-region"
)

List of instance types

type Interface 

type Interface struct {
	// Connection type, e.g., S3, Kafka, MySQL
	Protocol ConnectionType `json:"protocol"` // TODO(roee88): should this be named ConnectionType instead of Protocol
	// DataFormat defines the data format type
	DataFormat DataFormat `json:"dataformat,omitempty"`
}

Connection type and data format used for data transactions

func (*Interface) DeepCopy 

func (in *Interface) DeepCopy() *Interface

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Interface.

func (*Interface) DeepCopyInto 

func (in *Interface) DeepCopyInto(out *Interface)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PluginType 

type PluginType string

Type of the plugin, not supported yet

type PolicyManagerRequestContext 

type PolicyManagerRequestContext struct {
	serde.Properties `json:"-"`
}

Context in which a policy is evaluated, e.g., details of the data user such as role and intent +kubebuilder:pruning:PreserveUnknownFields

func (*PolicyManagerRequestContext) DeepCopy 

func (in *PolicyManagerRequestContext) DeepCopy() *PolicyManagerRequestContext

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyManagerRequestContext.

func (*PolicyManagerRequestContext) DeepCopyInto 

func (in *PolicyManagerRequestContext) DeepCopyInto(out *PolicyManagerRequestContext)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ProcessingLocation 

type ProcessingLocation string

location information

type RangeType added in v0.7.0 

type RangeType struct {
	Min int `json:"min,omitempty"`
	Max int `json:"max,omitempty"`
}

Range of numeric values

func (*RangeType) DeepCopy added in v0.7.0 

func (in *RangeType) DeepCopy() *RangeType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RangeType.

func (*RangeType) DeepCopyInto added in v0.7.0 

func (in *RangeType) DeepCopyInto(out *RangeType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SecretRef added in v1.3.0 

type SecretRef struct {
	// Namespace
	Namespace string `json:"namespace"`
	// Name
	Name string `json:"name"`
}

Reference to k8s secret holding credentials for storage access

func (*SecretRef) DeepCopy added in v1.3.0 

func (in *SecretRef) DeepCopy() *SecretRef

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretRef.

func (*SecretRef) DeepCopyInto added in v1.3.0 

func (in *SecretRef) DeepCopyInto(out *SecretRef)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StorageAccountProperties added in v1.3.0 

type StorageAccountProperties struct {
	serde.Properties `json:"-"`
}

Properties of a shared storage account, e.g., endpoint +kubebuilder:pruning:PreserveUnknownFields

func (*StorageAccountProperties) DeepCopy added in v1.3.0 

func (in *StorageAccountProperties) DeepCopy() *StorageAccountProperties

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageAccountProperties.

func (*StorageAccountProperties) DeepCopyInto added in v1.3.0 

func (in *StorageAccountProperties) DeepCopyInto(out *StorageAccountProperties)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Tags 

type Tags struct {
	serde.Properties `json:"-"`
}

+kubebuilder:pruning:PreserveUnknownFields Additional metadata for the asset/field

func (*Tags) DeepCopy 

func (in *Tags) DeepCopy() *Tags

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tags.

func (*Tags) DeepCopyInto 

func (in *Tags) DeepCopyInto(out *Tags)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Units added in v0.7.0 

type Units string

Measurement units

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.