asset

package
v0.0.0-...-1a246bd Latest Latest
Warning

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

 Go to latest Published: Oct 27, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_odpf_assets_v1beta2_asset_proto protoreflect.FileDescriptor
View Source 
var File_odpf_assets_v1beta2_common_proto protoreflect.FileDescriptor
View Source 
var File_odpf_assets_v1beta2_feature_table_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Asset 

type Asset struct {

	// The unique identifier of the asset.
	// Example: `user:jdoe` or `group:accounting`.
	Urn string `protobuf:"bytes,1,opt,name=urn,proto3" json:"urn,omitempty"`
	// The name of the asset.
	// Example: `John Doe` or `Accounting`.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The source of the asset.
	// Example: `github` or `bigquery`.
	Service string `protobuf:"bytes,3,opt,name=service,proto3" json:"service,omitempty"`
	// The type of the asset.
	// Example: `user` or `group`.
	Type string `protobuf:"bytes,4,opt,name=type,proto3" json:"type,omitempty"`
	// The REST URL for accessing the resource. URL returns the resource itself.
	// Example: `https://xyz.com/v1/users/user-123`
	Url string `protobuf:"bytes,5,opt,name=url,proto3" json:"url,omitempty"`
	// The description of the resource.
	// Example: `This resource is being used for storing important number`
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// Represents Data in asset, can be of type bucket, dashboard, group ... user
	Data *anypb.Any `protobuf:"bytes,7,opt,name=data,proto3" json:"data,omitempty"`
	// The ownership of the job.
	// For an example check out Owner.
	Owners []*Owner `protobuf:"bytes,31,rep,name=owners,proto3" json:"owners,omitempty"`
	// The lineage of the job.
	// For an example check out lineage schema.
	Lineage *Lineage `protobuf:"bytes,32,opt,name=lineage,proto3" json:"lineage,omitempty"`
	//Optional. List of labels the user has.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// The timestamp of the generated event.
	// Event schemas is defined in the common event schema.
	Event *Event `protobuf:"bytes,100,opt,name=event,proto3" json:"event,omitempty"`
	// The timestamp when the asset was created.
	// This information is expected to be maintained by the system.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,101,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The timestamp when the asset was last modified.
	// This information is expected to be maintained by the system.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,102,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Asset is a resource that represents any type of asset.

func (*Asset) Descriptor deprecated 

func (*Asset) Descriptor() ([]byte, []int)

Deprecated: Use Asset.ProtoReflect.Descriptor instead.

func (*Asset) GetCreateTime 

func (x *Asset) GetCreateTime() *timestamppb.Timestamp

func (*Asset) GetData 

func (x *Asset) GetData() *anypb.Any

func (*Asset) GetDescription 

func (x *Asset) GetDescription() string

func (*Asset) GetEvent 

func (x *Asset) GetEvent() *Event

func (*Asset) GetLabels 

func (x *Asset) GetLabels() map[string]string

func (*Asset) GetLineage 

func (x *Asset) GetLineage() *Lineage

func (*Asset) GetName 

func (x *Asset) GetName() string

func (*Asset) GetOwners 

func (x *Asset) GetOwners() []*Owner

func (*Asset) GetService 

func (x *Asset) GetService() string

func (*Asset) GetType 

func (x *Asset) GetType() string

func (*Asset) GetUpdateTime 

func (x *Asset) GetUpdateTime() *timestamppb.Timestamp

func (*Asset) GetUrl 

func (x *Asset) GetUrl() string

func (*Asset) GetUrn 

func (x *Asset) GetUrn() string

func (*Asset) ProtoMessage 

func (*Asset) ProtoMessage()

func (*Asset) ProtoReflect 

func (x *Asset) ProtoReflect() protoreflect.Message

func (*Asset) Reset 

func (x *Asset) Reset()

func (*Asset) String 

func (x *Asset) String() string

type Event 

type Event struct {

	// The timestamp of the event.
	// Example: `2018-01-01T00:00:00Z`.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// The activity that created the event.
	// Example: `create`, `update`.
	Action string `protobuf:"bytes,2,opt,name=action,proto3" json:"action,omitempty"`
	// The description of the event.
	// Example: `user is created from signup form`.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Event represents an event in the system. Event is majorly used to represent the state of the system in the form of events. It can be used in any schema which intend to produce events to message bus.

func (*Event) Descriptor deprecated 

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetAction 

func (x *Event) GetAction() string

func (*Event) GetDescription 

func (x *Event) GetDescription() string

func (*Event) GetTimestamp 

func (x *Event) GetTimestamp() *timestamppb.Timestamp

func (*Event) ProtoMessage 

func (*Event) ProtoMessage()

func (*Event) ProtoReflect 

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset 

func (x *Event) Reset()

func (*Event) String 

func (x *Event) String() string

type Feature 

type Feature struct {

	// The name of the field.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The data type associated with an individual ML Feature.
	DataType string `protobuf:"bytes,2,opt,name=data_type,json=dataType,proto3" json:"data_type,omitempty"`
	// Optional: Name of the algorithm used to compute the feature, e.g., PCA,
	// bucketing etc.
	Algorithm string `protobuf:"bytes,3,opt,name=algorithm,proto3" json:"algorithm,omitempty"`
	// Optional: Name of the entity instance.
	EntityName string `protobuf:"bytes,4,opt,name=entity_name,json=entityName,proto3" json:"entity_name,omitempty"`
	// contains filtered or unexported fields
}

Feature is a Machine Learning(ML) feature. In machine learning, a feature is an individual measurable property, typically represented by a column, that serves as an input for Machine Learning (ML) algorithms.

func (*Feature) Descriptor deprecated 

func (*Feature) Descriptor() ([]byte, []int)

Deprecated: Use Feature.ProtoReflect.Descriptor instead.

func (*Feature) GetAlgorithm 

func (x *Feature) GetAlgorithm() string

func (*Feature) GetDataType 

func (x *Feature) GetDataType() string

func (*Feature) GetEntityName 

func (x *Feature) GetEntityName() string

func (*Feature) GetName 

func (x *Feature) GetName() string

func (*Feature) ProtoMessage 

func (*Feature) ProtoMessage()

func (*Feature) ProtoReflect 

func (x *Feature) ProtoReflect() protoreflect.Message

func (*Feature) Reset 

func (x *Feature) Reset()

func (*Feature) String 

func (x *Feature) String() string

type FeatureTable 

type FeatureTable struct {

	// Optional: Feature store's namespace or project.
	Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// Optional: The list of entities that this feature view is associated with.
	Entities []*FeatureTable_Entity `protobuf:"bytes,2,rep,name=entities,proto3" json:"entities,omitempty"`
	// Features that are part of the table, akin to columns in a table.
	Features []*Feature `protobuf:"bytes,3,rep,name=features,proto3" json:"features,omitempty"`
	// The timestamp when the feature table was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,101,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The timestamp when the feature table was last modified.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,102,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

FeatureTable is a Machine Learning(ML) feature table or view that represents a logical group of time-series feature data as it is found in a data source.

func (*FeatureTable) Descriptor deprecated 

func (*FeatureTable) Descriptor() ([]byte, []int)

Deprecated: Use FeatureTable.ProtoReflect.Descriptor instead.

func (*FeatureTable) GetCreateTime 

func (x *FeatureTable) GetCreateTime() *timestamppb.Timestamp

func (*FeatureTable) GetEntities 

func (x *FeatureTable) GetEntities() []*FeatureTable_Entity

func (*FeatureTable) GetFeatures 

func (x *FeatureTable) GetFeatures() []*Feature

func (*FeatureTable) GetNamespace 

func (x *FeatureTable) GetNamespace() string

func (*FeatureTable) GetUpdateTime 

func (x *FeatureTable) GetUpdateTime() *timestamppb.Timestamp

func (*FeatureTable) ProtoMessage 

func (*FeatureTable) ProtoMessage()

func (*FeatureTable) ProtoReflect 

func (x *FeatureTable) ProtoReflect() protoreflect.Message

func (*FeatureTable) Reset 

func (x *FeatureTable) Reset()

func (*FeatureTable) String 

func (x *FeatureTable) String() string

type FeatureTable_Entity 

type FeatureTable_Entity struct {

	// The unique name of the entity.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A property that uniquely identifies different entities within the
	// collection. The join_key property is typically used for joining entities
	// with their associated features.
	JoinKeys []string `protobuf:"bytes,2,rep,name=join_keys,json=joinKeys,proto3" json:"join_keys,omitempty"`
	// Optional: Arbitrary metadata.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

An entity is a collection of semantically related features. Users define entities to map to the domain of their use case. For example, a ride-hailing service could have customers and drivers as their entities, which group related features that correspond to these customers and drivers.

func (*FeatureTable_Entity) Descriptor deprecated 

func (*FeatureTable_Entity) Descriptor() ([]byte, []int)

Deprecated: Use FeatureTable_Entity.ProtoReflect.Descriptor instead.

func (*FeatureTable_Entity) GetJoinKeys 

func (x *FeatureTable_Entity) GetJoinKeys() []string

func (*FeatureTable_Entity) GetLabels 

func (x *FeatureTable_Entity) GetLabels() map[string]string

func (*FeatureTable_Entity) GetName 

func (x *FeatureTable_Entity) GetName() string

func (*FeatureTable_Entity) ProtoMessage 

func (*FeatureTable_Entity) ProtoMessage()

func (*FeatureTable_Entity) ProtoReflect 

func (x *FeatureTable_Entity) ProtoReflect() protoreflect.Message

func (*FeatureTable_Entity) Reset 

func (x *FeatureTable_Entity) Reset()

func (*FeatureTable_Entity) String 

func (x *FeatureTable_Entity) String() string

type Lineage 

type Lineage struct {

	// The resource that is the source of the relationship.
	// Example: a resource that is the parent of another resource.
	Upstreams []*Resource `protobuf:"bytes,1,rep,name=upstreams,proto3" json:"upstreams,omitempty"`
	// The resource that is the destination of the relationship.
	// Example: a resource that is the child of another resource.
	Downstreams []*Resource `protobuf:"bytes,2,rep,name=downstreams,proto3" json:"downstreams,omitempty"`
	// contains filtered or unexported fields
}

Linage represents the relationship of resource to other resources. Relation is way of describing the relationship between two resources.

func (*Lineage) Descriptor deprecated 

func (*Lineage) Descriptor() ([]byte, []int)

Deprecated: Use Lineage.ProtoReflect.Descriptor instead.

func (*Lineage) GetDownstreams 

func (x *Lineage) GetDownstreams() []*Resource

func (*Lineage) GetUpstreams 

func (x *Lineage) GetUpstreams() []*Resource

func (*Lineage) ProtoMessage 

func (*Lineage) ProtoMessage()

func (*Lineage) ProtoReflect 

func (x *Lineage) ProtoReflect() protoreflect.Message

func (*Lineage) Reset 

func (x *Lineage) Reset()

func (*Lineage) String 

func (x *Lineage) String() string

type Owner 

type Owner struct {
	Urn string `protobuf:"bytes,1,opt,name=urn,proto3" json:"urn,omitempty"`
	// The name of the owner.
	// Example: `John Doe`.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The role of the owner.
	// Example: `admin`, `steward`.
	Role string `protobuf:"bytes,3,opt,name=role,proto3" json:"role,omitempty"`
	// The email of the owner.
	// Example: `abc@email.com`
	Email string `protobuf:"bytes,4,opt,name=email,proto3" json:"email,omitempty"`
	// contains filtered or unexported fields
}

Owner is a facet that describes the owner of a resource.

func (*Owner) Descriptor deprecated 

func (*Owner) Descriptor() ([]byte, []int)

Deprecated: Use Owner.ProtoReflect.Descriptor instead.

func (*Owner) GetEmail 

func (x *Owner) GetEmail() string

func (*Owner) GetName 

func (x *Owner) GetName() string

func (*Owner) GetRole 

func (x *Owner) GetRole() string

func (*Owner) GetUrn 

func (x *Owner) GetUrn() string

func (*Owner) ProtoMessage 

func (*Owner) ProtoMessage()

func (*Owner) ProtoReflect 

func (x *Owner) ProtoReflect() protoreflect.Message

func (*Owner) Reset 

func (x *Owner) Reset()

func (*Owner) String 

func (x *Owner) String() string

type Resource 

type Resource struct {

	// The unique identifier of the resource.
	// Example: `user:jdoe` or `group:accounting`.
	Urn string `protobuf:"bytes,1,opt,name=urn,proto3" json:"urn,omitempty"`
	// The name of the resource.
	// Example: `John Doe` or `Accounting`.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The source of the resource.
	// Example: `github` or `bigquery`.
	Service string `protobuf:"bytes,3,opt,name=service,proto3" json:"service,omitempty"`
	// The type of the asset.
	// Example: `user` or `group`.
	Type string `protobuf:"bytes,4,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*Resource) Descriptor deprecated 

func (*Resource) Descriptor() ([]byte, []int)

Deprecated: Use Resource.ProtoReflect.Descriptor instead.

func (*Resource) GetName 

func (x *Resource) GetName() string

func (*Resource) GetService 

func (x *Resource) GetService() string

func (*Resource) GetType 

func (x *Resource) GetType() string

func (*Resource) GetUrn 

func (x *Resource) GetUrn() string

func (*Resource) ProtoMessage 

func (*Resource) ProtoMessage()

func (*Resource) ProtoReflect 

func (x *Resource) ProtoReflect() protoreflect.Message

func (*Resource) Reset 

func (x *Resource) Reset()

func (*Resource) String 

func (x *Resource) String() string

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.