entity

package
v0.0.0-kmdagger2 Latest Latest
Warning

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

 Go to latest Published: Jun 12, 2023 License: AGPL-3.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	StandardKindDashboard   = "dashboard"
	StandardKindPlaylist    = "playlist"
	StandardKindSnapshot    = "snapshot"
	StandardKindFolder      = "folder"
	StandardKindPreferences = "preferences"

	// StandardKindDataSource: not a real kind yet, but used to define references from dashboards
	// Types: influx, prometheus, testdata, ...
	StandardKindDataSource = "ds"

	// StandardKindPanel: only used for searchV2 right now
	// Standalone panel is not an object kind yet -- library panel, or nested in dashboard
	StandardKindPanel = "panel"

	// entity.StandardKindSVG SVG file support
	StandardKindSVG = "svg"

	// StandardKindPNG PNG file support
	StandardKindPNG = "png"

	// StandardKindGeoJSON represents spatial data
	StandardKindGeoJSON = "geojson"

	// StandardKindDataFrame data frame
	StandardKindDataFrame = "frame"

	// StandardKindJSONObj generic json object
	StandardKindJSONObj = "jsonobj"

	// StandardKindQuery early development on panel query library
	// the kind may need to change to better encapsulate { targets:[], transforms:[] }
	StandardKindQuery = "query"

	// KindAlertRule is not a real kind. It's used to refer to alert rules, for instance
	// in the folder registry service.
	StandardKindAlertRule = "alertrule"

	// ExternalEntityReferencePlugin: requires a plugin to be installed
	ExternalEntityReferencePlugin = "plugin"

	// ExternalEntityReferenceRuntime: frontend runtime requirements
	ExternalEntityReferenceRuntime = "runtime"

	// ExternalEntityReferenceRuntime_Transformer is a "type" under runtime
	// UIDs include: joinByField, organize, seriesToColumns, etc
	ExternalEntityReferenceRuntime_Transformer = "transformer"
)

Variables

View Source 
var (
	WriteEntityResponse_Status_name = map[int32]string{
		0: "ERROR",
		1: "CREATED",
		2: "UPDATED",
		3: "UNCHANGED",
	}
	WriteEntityResponse_Status_value = map[string]int32{
		"ERROR":     0,
		"CREATED":   1,
		"UPDATED":   2,
		"UNCHANGED": 3,
	}
)

Enum value maps for WriteEntityResponse_Status.

View Source 
var (
	EntityWatchResponse_Action_name = map[int32]string{
		0: "UNKNOWN",
		1: "UPDATED",
		2: "DELETED",
	}
	EntityWatchResponse_Action_value = map[string]int32{
		"UNKNOWN": 0,
		"UPDATED": 1,
		"DELETED": 2,
	}
)

Enum value maps for EntityWatchResponse_Action.

View Source 
var EntityStoreAdmin_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "entity.EntityStoreAdmin",
	HandlerType: (*EntityStoreAdminServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "AdminWrite",
			Handler:    _EntityStoreAdmin_AdminWrite_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "entity.proto",
}

EntityStoreAdmin_ServiceDesc is the grpc.ServiceDesc for EntityStoreAdmin service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var EntityStore_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "entity.EntityStore",
	HandlerType: (*EntityStoreServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Read",
			Handler:    _EntityStore_Read_Handler,
		},
		{
			MethodName: "BatchRead",
			Handler:    _EntityStore_BatchRead_Handler,
		},
		{
			MethodName: "Write",
			Handler:    _EntityStore_Write_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _EntityStore_Delete_Handler,
		},
		{
			MethodName: "History",
			Handler:    _EntityStore_History_Handler,
		},
		{
			MethodName: "Search",
			Handler:    _EntityStore_Search_Handler,
		},
		{
			MethodName: "AdminWrite",
			Handler:    _EntityStore_AdminWrite_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Watch",
			Handler:       _EntityStore_Watch_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "entity.proto",
}

EntityStore_ServiceDesc is the grpc.ServiceDesc for EntityStore service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_entity_proto protoreflect.FileDescriptor

Functions

func RegisterEntityStoreAdminServer 

func RegisterEntityStoreAdminServer(s grpc.ServiceRegistrar, srv EntityStoreAdminServer)

func RegisterEntityStoreServer 

func RegisterEntityStoreServer(s grpc.ServiceRegistrar, srv EntityStoreServer)

Types

type AdminWriteEntityRequest 

type AdminWriteEntityRequest struct {

	// Entity identifier
	GRN *GRN `protobuf:"bytes,1,opt,name=GRN,proto3" json:"GRN,omitempty"`
	// Where to save the entity (empty will leave it unchanged)
	Folder string `protobuf:"bytes,2,opt,name=folder,proto3" json:"folder,omitempty"`
	// The raw entity body
	Body []byte `protobuf:"bytes,3,opt,name=body,proto3" json:"body,omitempty"`
	// Message that can be seen when exploring entity history
	Comment string `protobuf:"bytes,4,opt,name=comment,proto3" json:"comment,omitempty"`
	// Time in epoch milliseconds that the entity was created
	// Optional, if 0 it will use the current time
	CreatedAt int64 `protobuf:"varint,5,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Time in epoch milliseconds that the entity was updated
	// Optional, if empty it will use the current user
	UpdatedAt int64 `protobuf:"varint,6,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Who created the entity
	// Optional, if 0 it will use the current time
	CreatedBy string `protobuf:"bytes,7,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Who updated the entity
	// Optional, if empty it will use the current user
	UpdatedBy string `protobuf:"bytes,8,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// An explicit version identifier
	// Optional, if set, this will overwrite/define an explicit version
	Version string `protobuf:"bytes,9,opt,name=version,proto3" json:"version,omitempty"`
	// Used for optimistic locking.  If missing, the previous version will be replaced regardless
	// This may not be used along with an explicit version in the request
	PreviousVersion string `protobuf:"bytes,10,opt,name=previous_version,json=previousVersion,proto3" json:"previous_version,omitempty"`
	// Request that all previous versions are removed from the history
	// This will make sense for systems that manage history explicitly externallay
	ClearHistory bool `protobuf:"varint,11,opt,name=clear_history,json=clearHistory,proto3" json:"clear_history,omitempty"`
	// Optionally define where the entity came from
	Origin *EntityOriginInfo `protobuf:"bytes,12,opt,name=origin,proto3" json:"origin,omitempty"`
	// contains filtered or unexported fields
}

This operation is useful when syncing a resource from external sources that have more accurate metadata information (git, or an archive). This process can bypass the forced checks that

func ToAdminWriteEntityRequest 

func ToAdminWriteEntityRequest(req *WriteEntityRequest) *AdminWriteEntityRequest

The admin request is a superset of write request features

func (*AdminWriteEntityRequest) Descriptor deprecated 

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

Deprecated: Use AdminWriteEntityRequest.ProtoReflect.Descriptor instead.

func (*AdminWriteEntityRequest) GetBody 

func (x *AdminWriteEntityRequest) GetBody() []byte

func (*AdminWriteEntityRequest) GetClearHistory 

func (x *AdminWriteEntityRequest) GetClearHistory() bool

func (*AdminWriteEntityRequest) GetComment 

func (x *AdminWriteEntityRequest) GetComment() string

func (*AdminWriteEntityRequest) GetCreatedAt 

func (x *AdminWriteEntityRequest) GetCreatedAt() int64

func (*AdminWriteEntityRequest) GetCreatedBy 

func (x *AdminWriteEntityRequest) GetCreatedBy() string

func (*AdminWriteEntityRequest) GetFolder 

func (x *AdminWriteEntityRequest) GetFolder() string

func (*AdminWriteEntityRequest) GetGRN 

func (x *AdminWriteEntityRequest) GetGRN() *GRN

func (*AdminWriteEntityRequest) GetOrigin 

func (x *AdminWriteEntityRequest) GetOrigin() *EntityOriginInfo

func (*AdminWriteEntityRequest) GetPreviousVersion 

func (x *AdminWriteEntityRequest) GetPreviousVersion() string

func (*AdminWriteEntityRequest) GetUpdatedAt 

func (x *AdminWriteEntityRequest) GetUpdatedAt() int64

func (*AdminWriteEntityRequest) GetUpdatedBy 

func (x *AdminWriteEntityRequest) GetUpdatedBy() string

func (*AdminWriteEntityRequest) GetVersion 

func (x *AdminWriteEntityRequest) GetVersion() string

func (*AdminWriteEntityRequest) ProtoMessage 

func (*AdminWriteEntityRequest) ProtoMessage()

func (*AdminWriteEntityRequest) ProtoReflect 

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

func (*AdminWriteEntityRequest) Reset 

func (x *AdminWriteEntityRequest) Reset()

func (*AdminWriteEntityRequest) String 

func (x *AdminWriteEntityRequest) String() string

type BatchReadEntityRequest 

type BatchReadEntityRequest struct {
	Batch []*ReadEntityRequest `protobuf:"bytes,1,rep,name=batch,proto3" json:"batch,omitempty"`
	// contains filtered or unexported fields
}

func (*BatchReadEntityRequest) Descriptor deprecated 

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

Deprecated: Use BatchReadEntityRequest.ProtoReflect.Descriptor instead.

func (*BatchReadEntityRequest) GetBatch 

func (x *BatchReadEntityRequest) GetBatch() []*ReadEntityRequest

func (*BatchReadEntityRequest) ProtoMessage 

func (*BatchReadEntityRequest) ProtoMessage()

func (*BatchReadEntityRequest) ProtoReflect 

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

func (*BatchReadEntityRequest) Reset 

func (x *BatchReadEntityRequest) Reset()

func (*BatchReadEntityRequest) String 

func (x *BatchReadEntityRequest) String() string

type BatchReadEntityResponse 

type BatchReadEntityResponse struct {
	Results []*Entity `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*BatchReadEntityResponse) Descriptor deprecated 

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

Deprecated: Use BatchReadEntityResponse.ProtoReflect.Descriptor instead.

func (*BatchReadEntityResponse) GetResults 

func (x *BatchReadEntityResponse) GetResults() []*Entity

func (*BatchReadEntityResponse) ProtoMessage 

func (*BatchReadEntityResponse) ProtoMessage()

func (*BatchReadEntityResponse) ProtoReflect 

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

func (*BatchReadEntityResponse) Reset 

func (x *BatchReadEntityResponse) Reset()

func (*BatchReadEntityResponse) String 

func (x *BatchReadEntityResponse) String() string

type DeleteEntityRequest 

type DeleteEntityRequest struct {

	// Entity identifier
	GRN *GRN `protobuf:"bytes,1,opt,name=GRN,proto3" json:"GRN,omitempty"`
	// Used for optimistic locking.  If missing, the previous version will be replaced regardless
	PreviousVersion string `protobuf:"bytes,3,opt,name=previous_version,json=previousVersion,proto3" json:"previous_version,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteEntityRequest) Descriptor deprecated 

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

Deprecated: Use DeleteEntityRequest.ProtoReflect.Descriptor instead.

func (*DeleteEntityRequest) GetGRN 

func (x *DeleteEntityRequest) GetGRN() *GRN

func (*DeleteEntityRequest) GetPreviousVersion 

func (x *DeleteEntityRequest) GetPreviousVersion() string

func (*DeleteEntityRequest) ProtoMessage 

func (*DeleteEntityRequest) ProtoMessage()

func (*DeleteEntityRequest) ProtoReflect 

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

func (*DeleteEntityRequest) Reset 

func (x *DeleteEntityRequest) Reset()

func (*DeleteEntityRequest) String 

func (x *DeleteEntityRequest) String() string

type DeleteEntityResponse 

type DeleteEntityResponse struct {
	OK bool `protobuf:"varint,1,opt,name=OK,proto3" json:"OK,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteEntityResponse) Descriptor deprecated 

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

Deprecated: Use DeleteEntityResponse.ProtoReflect.Descriptor instead.

func (*DeleteEntityResponse) GetOK 

func (x *DeleteEntityResponse) GetOK() bool

func (*DeleteEntityResponse) ProtoMessage 

func (*DeleteEntityResponse) ProtoMessage()

func (*DeleteEntityResponse) ProtoReflect 

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

func (*DeleteEntityResponse) Reset 

func (x *DeleteEntityResponse) Reset()

func (*DeleteEntityResponse) String 

func (x *DeleteEntityResponse) String() string

type Entity 

type Entity struct {

	// Entity identifier
	GRN *GRN `protobuf:"bytes,1,opt,name=GRN,proto3" json:"GRN,omitempty"`
	// The version will change when the entity is saved. It is not necessarily sortable
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Time in epoch milliseconds that the entity was created
	CreatedAt int64 `protobuf:"varint,3,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Time in epoch milliseconds that the entity was updated
	UpdatedAt int64 `protobuf:"varint,4,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Who created the entity
	CreatedBy string `protobuf:"bytes,5,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Who updated the entity
	UpdatedBy string `protobuf:"bytes,6,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// The folder UID (not stored in the body)
	Folder string `protobuf:"bytes,7,opt,name=folder,proto3" json:"folder,omitempty"`
	// MD5 digest of the body
	ETag string `protobuf:"bytes,8,opt,name=ETag,proto3" json:"ETag,omitempty"`
	// Content Length
	Size int64 `protobuf:"varint,9,opt,name=size,proto3" json:"size,omitempty"`
	// Raw bytes of the storage entity.  The kind will determine what is a valid payload
	Body []byte `protobuf:"bytes,10,opt,name=body,proto3" json:"body,omitempty"`
	// Entity summary as JSON
	SummaryJson []byte `protobuf:"bytes,11,opt,name=summary_json,json=summaryJson,proto3" json:"summary_json,omitempty"`
	// External location info
	Origin *EntityOriginInfo `protobuf:"bytes,12,opt,name=origin,proto3" json:"origin,omitempty"`
	// contains filtered or unexported fields
}

The canonical entity/document data -- this represents the raw bytes and storage level metadata

func (*Entity) Descriptor deprecated 

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

Deprecated: Use Entity.ProtoReflect.Descriptor instead.

func (*Entity) GetBody 

func (x *Entity) GetBody() []byte

func (*Entity) GetCreatedAt 

func (x *Entity) GetCreatedAt() int64

func (*Entity) GetCreatedBy 

func (x *Entity) GetCreatedBy() string

func (*Entity) GetETag 

func (x *Entity) GetETag() string

func (*Entity) GetFolder 

func (x *Entity) GetFolder() string

func (*Entity) GetGRN 

func (x *Entity) GetGRN() *GRN

func (*Entity) GetOrigin 

func (x *Entity) GetOrigin() *EntityOriginInfo

func (*Entity) GetSize 

func (x *Entity) GetSize() int64

func (*Entity) GetSummaryJson 

func (x *Entity) GetSummaryJson() []byte

func (*Entity) GetUpdatedAt 

func (x *Entity) GetUpdatedAt() int64

func (*Entity) GetUpdatedBy 

func (x *Entity) GetUpdatedBy() string

func (*Entity) GetVersion 

func (x *Entity) GetVersion() string

func (*Entity) MarshalJSON 

func (obj *Entity) MarshalJSON() ([]byte, error)

func (*Entity) ProtoMessage 

func (*Entity) ProtoMessage()

func (*Entity) ProtoReflect 

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

func (*Entity) Reset 

func (x *Entity) Reset()

func (*Entity) String 

func (x *Entity) String() string

func (*Entity) UnmarshalJSON 

func (obj *Entity) UnmarshalJSON(b []byte) error

UnmarshalJSON will read JSON into a Entity

type EntityErrorInfo 

type EntityErrorInfo struct {

	// Match an error code registry?
	Code int64 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	// Simple error display
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// Details encoded in JSON
	DetailsJson []byte `protobuf:"bytes,3,opt,name=details_json,json=detailsJson,proto3" json:"details_json,omitempty"`
	// contains filtered or unexported fields
}

Report error while working with entitys NOTE: real systems at scale will contain errors.

func (*EntityErrorInfo) Descriptor deprecated 

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

Deprecated: Use EntityErrorInfo.ProtoReflect.Descriptor instead.

func (*EntityErrorInfo) GetCode 

func (x *EntityErrorInfo) GetCode() int64

func (*EntityErrorInfo) GetDetailsJson 

func (x *EntityErrorInfo) GetDetailsJson() []byte

func (*EntityErrorInfo) GetMessage 

func (x *EntityErrorInfo) GetMessage() string

func (*EntityErrorInfo) ProtoMessage 

func (*EntityErrorInfo) ProtoMessage()

func (*EntityErrorInfo) ProtoReflect 

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

func (*EntityErrorInfo) Reset 

func (x *EntityErrorInfo) Reset()

func (*EntityErrorInfo) String 

func (x *EntityErrorInfo) String() string

type EntityExternalReference 

type EntityExternalReference struct {
	// Category of dependency
	// eg: datasource, plugin, runtime
	Family string `json:"family,omitempty"`

	// datasource > prometheus|influx|...
	// plugin > panel | datasource
	// runtime > transformer
	Type string `json:"type,omitempty"` // flavor

	// datasource > UID
	// plugin > plugin identifier
	// runtime > name lookup
	Identifier string `json:"ID,omitempty"`
}

Reference to another object outside itself This message is derived from the object body and can be used to search for references. This does not represent a method to declare a reference to another object.

type EntityHistoryRequest 

type EntityHistoryRequest struct {

	// Entity identifier
	GRN *GRN `protobuf:"bytes,1,opt,name=GRN,proto3" json:"GRN,omitempty"`
	// Maximum number of items to return
	Limit int64 `protobuf:"varint,3,opt,name=limit,proto3" json:"limit,omitempty"`
	// Starting from the requested page
	NextPageToken string `protobuf:"bytes,5,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*EntityHistoryRequest) Descriptor deprecated 

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

Deprecated: Use EntityHistoryRequest.ProtoReflect.Descriptor instead.

func (*EntityHistoryRequest) GetGRN 

func (x *EntityHistoryRequest) GetGRN() *GRN

func (*EntityHistoryRequest) GetLimit 

func (x *EntityHistoryRequest) GetLimit() int64

func (*EntityHistoryRequest) GetNextPageToken 

func (x *EntityHistoryRequest) GetNextPageToken() string

func (*EntityHistoryRequest) ProtoMessage 

func (*EntityHistoryRequest) ProtoMessage()

func (*EntityHistoryRequest) ProtoReflect 

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

func (*EntityHistoryRequest) Reset 

func (x *EntityHistoryRequest) Reset()

func (*EntityHistoryRequest) String 

func (x *EntityHistoryRequest) String() string

type EntityHistoryResponse 

type EntityHistoryResponse struct {

	// Entity identifier
	GRN *GRN `protobuf:"bytes,1,opt,name=GRN,proto3" json:"GRN,omitempty"`
	// Entity metadata without the raw bytes
	Versions []*EntityVersionInfo `protobuf:"bytes,2,rep,name=versions,proto3" json:"versions,omitempty"`
	// More results exist... pass this in the next request
	NextPageToken string `protobuf:"bytes,3,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*EntityHistoryResponse) Descriptor deprecated 

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

Deprecated: Use EntityHistoryResponse.ProtoReflect.Descriptor instead.

func (*EntityHistoryResponse) GetGRN 

func (x *EntityHistoryResponse) GetGRN() *GRN

func (*EntityHistoryResponse) GetNextPageToken 

func (x *EntityHistoryResponse) GetNextPageToken() string

func (*EntityHistoryResponse) GetVersions 

func (x *EntityHistoryResponse) GetVersions() []*EntityVersionInfo

func (*EntityHistoryResponse) ProtoMessage 

func (*EntityHistoryResponse) ProtoMessage()

func (*EntityHistoryResponse) ProtoReflect 

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

func (*EntityHistoryResponse) Reset 

func (x *EntityHistoryResponse) Reset()

func (*EntityHistoryResponse) String 

func (x *EntityHistoryResponse) String() string

type EntityKindInfo 

type EntityKindInfo struct {
	// Unique short id for this kind
	ID string `json:"id,omitempty"`

	// Display name (may be equal to the ID)
	Name string `json:"name,omitempty"`

	// Kind description
	Description string `json:"description,omitempty"`

	// The format is not controlled by a schema
	IsRaw bool `json:"isRaw,omitempty"`

	// The preferred save extension (svg, png, parquet, etc) if one exists
	FileExtension string `json:"fileExtension,omitempty"`

	// The correct mime-type to return for raw objects
	MimeType string `json:"mimeType,omitempty"`
}

EntityKindInfo describes information needed from the object store All non-raw types will have a schema that can be used to validate

type EntityOriginInfo 

type EntityOriginInfo struct {

	// identify the external source (plugin, git instance, etc)
	Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	// Key in the upstream system (git hash, file path, etc)
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// Time in epoch milliseconds that the entity was last synced with an external system (provisioning/git)
	Time int64 `protobuf:"varint,3,opt,name=time,proto3" json:"time,omitempty"`
	// contains filtered or unexported fields
}

This stores additional metadata for items entities that were synced from external systmes

func (*EntityOriginInfo) Descriptor deprecated 

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

Deprecated: Use EntityOriginInfo.ProtoReflect.Descriptor instead.

func (*EntityOriginInfo) GetKey 

func (x *EntityOriginInfo) GetKey() string

func (*EntityOriginInfo) GetSource 

func (x *EntityOriginInfo) GetSource() string

func (*EntityOriginInfo) GetTime 

func (x *EntityOriginInfo) GetTime() int64

func (*EntityOriginInfo) ProtoMessage 

func (*EntityOriginInfo) ProtoMessage()

func (*EntityOriginInfo) ProtoReflect 

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

func (*EntityOriginInfo) Reset 

func (x *EntityOriginInfo) Reset()

func (*EntityOriginInfo) String 

func (x *EntityOriginInfo) String() string

type EntitySearchRequest 

type EntitySearchRequest struct {

	// Starting from the requested page (other query parameters must match!)
	NextPageToken string `protobuf:"bytes,1,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Maximum number of items to return
	Limit int64 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// Free text query string -- mileage may vary :)
	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
	// limit to a specific kind (empty is all)
	Kind []string `protobuf:"bytes,4,rep,name=kind,proto3" json:"kind,omitempty"`
	// Limit results to items in a specific folder
	Folder string `protobuf:"bytes,5,opt,name=folder,proto3" json:"folder,omitempty"`
	// Must match all labels
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Sorting instructions `field ASC/DESC`
	Sort []string `protobuf:"bytes,7,rep,name=sort,proto3" json:"sort,omitempty"`
	// Return the full body in each payload
	WithBody bool `protobuf:"varint,8,opt,name=with_body,json=withBody,proto3" json:"with_body,omitempty"`
	// Return the full body in each payload
	WithLabels bool `protobuf:"varint,9,opt,name=with_labels,json=withLabels,proto3" json:"with_labels,omitempty"`
	// Return the full body in each payload
	WithFields bool `protobuf:"varint,10,opt,name=with_fields,json=withFields,proto3" json:"with_fields,omitempty"`
	// contains filtered or unexported fields
}

func (*EntitySearchRequest) Descriptor deprecated 

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

Deprecated: Use EntitySearchRequest.ProtoReflect.Descriptor instead.

func (*EntitySearchRequest) GetFolder 

func (x *EntitySearchRequest) GetFolder() string

func (*EntitySearchRequest) GetKind 

func (x *EntitySearchRequest) GetKind() []string

func (*EntitySearchRequest) GetLabels 

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

func (*EntitySearchRequest) GetLimit 

func (x *EntitySearchRequest) GetLimit() int64

func (*EntitySearchRequest) GetNextPageToken 

func (x *EntitySearchRequest) GetNextPageToken() string

func (*EntitySearchRequest) GetQuery 

func (x *EntitySearchRequest) GetQuery() string

func (*EntitySearchRequest) GetSort 

func (x *EntitySearchRequest) GetSort() []string

func (*EntitySearchRequest) GetWithBody 

func (x *EntitySearchRequest) GetWithBody() bool

func (*EntitySearchRequest) GetWithFields 

func (x *EntitySearchRequest) GetWithFields() bool

func (*EntitySearchRequest) GetWithLabels 

func (x *EntitySearchRequest) GetWithLabels() bool

func (*EntitySearchRequest) ProtoMessage 

func (*EntitySearchRequest) ProtoMessage()

func (*EntitySearchRequest) ProtoReflect 

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

func (*EntitySearchRequest) Reset 

func (x *EntitySearchRequest) Reset()

func (*EntitySearchRequest) String 

func (x *EntitySearchRequest) String() string

type EntitySearchResponse 

type EntitySearchResponse struct {
	Results []*EntitySearchResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// More results exist... pass this in the next request
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*EntitySearchResponse) Descriptor deprecated 

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

Deprecated: Use EntitySearchResponse.ProtoReflect.Descriptor instead.

func (*EntitySearchResponse) GetNextPageToken 

func (x *EntitySearchResponse) GetNextPageToken() string

func (*EntitySearchResponse) GetResults 

func (x *EntitySearchResponse) GetResults() []*EntitySearchResult

func (*EntitySearchResponse) ProtoMessage 

func (*EntitySearchResponse) ProtoMessage()

func (*EntitySearchResponse) ProtoReflect 

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

func (*EntitySearchResponse) Reset 

func (x *EntitySearchResponse) Reset()

func (*EntitySearchResponse) String 

func (x *EntitySearchResponse) String() string

type EntitySearchResult 

type EntitySearchResult struct {

	// Entity identifier
	GRN *GRN `protobuf:"bytes,1,opt,name=GRN,proto3" json:"GRN,omitempty"`
	// The current veresion of this entity
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Content Length
	Size int64 `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`
	// Time in epoch milliseconds that the entity was updated
	UpdatedAt int64 `protobuf:"varint,4,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Who updated the entity
	UpdatedBy string `protobuf:"bytes,5,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// Optionally include the full entity body
	Body []byte `protobuf:"bytes,6,opt,name=body,proto3" json:"body,omitempty"`
	// Always included
	Name string `protobuf:"bytes,7,opt,name=name,proto3" json:"name,omitempty"`
	// Always included
	Description string `protobuf:"bytes,8,opt,name=description,proto3" json:"description,omitempty"`
	// The structured labels
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Folder UID
	Folder string `protobuf:"bytes,10,opt,name=folder,proto3" json:"folder,omitempty"`
	// Slugified name
	Slug string `protobuf:"bytes,11,opt,name=slug,proto3" json:"slug,omitempty"`
	// Optionally include extracted JSON
	FieldsJson []byte `protobuf:"bytes,12,opt,name=fields_json,json=fieldsJson,proto3" json:"fields_json,omitempty"`
	// EntityErrorInfo in json
	ErrorJson []byte `protobuf:"bytes,13,opt,name=error_json,json=errorJson,proto3" json:"error_json,omitempty"`
	// contains filtered or unexported fields
}

Search result metadata for each entity

func (*EntitySearchResult) Descriptor deprecated 

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

Deprecated: Use EntitySearchResult.ProtoReflect.Descriptor instead.

func (*EntitySearchResult) GetBody 

func (x *EntitySearchResult) GetBody() []byte

func (*EntitySearchResult) GetDescription 

func (x *EntitySearchResult) GetDescription() string

func (*EntitySearchResult) GetErrorJson 

func (x *EntitySearchResult) GetErrorJson() []byte

func (*EntitySearchResult) GetFieldsJson 

func (x *EntitySearchResult) GetFieldsJson() []byte

func (*EntitySearchResult) GetFolder 

func (x *EntitySearchResult) GetFolder() string

func (*EntitySearchResult) GetGRN 

func (x *EntitySearchResult) GetGRN() *GRN

func (*EntitySearchResult) GetLabels 

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

func (*EntitySearchResult) GetName 

func (x *EntitySearchResult) GetName() string

func (*EntitySearchResult) GetSize 

func (x *EntitySearchResult) GetSize() int64

func (*EntitySearchResult) GetSlug 

func (x *EntitySearchResult) GetSlug() string

func (*EntitySearchResult) GetUpdatedAt 

func (x *EntitySearchResult) GetUpdatedAt() int64

func (*EntitySearchResult) GetUpdatedBy 

func (x *EntitySearchResult) GetUpdatedBy() string

func (*EntitySearchResult) GetVersion 

func (x *EntitySearchResult) GetVersion() string

func (*EntitySearchResult) MarshalJSON 

func (obj *EntitySearchResult) MarshalJSON() ([]byte, error)

func (*EntitySearchResult) ProtoMessage 

func (*EntitySearchResult) ProtoMessage()

func (*EntitySearchResult) ProtoReflect 

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

func (*EntitySearchResult) Reset 

func (x *EntitySearchResult) Reset()

func (*EntitySearchResult) String 

func (x *EntitySearchResult) String() string

type EntityStoreAdminClient 

type EntityStoreAdminClient interface {
	AdminWrite(ctx context.Context, in *AdminWriteEntityRequest, opts ...grpc.CallOption) (*WriteEntityResponse, error)
}

EntityStoreAdminClient is the client API for EntityStoreAdmin service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewEntityStoreAdminClient 

func NewEntityStoreAdminClient(cc grpc.ClientConnInterface) EntityStoreAdminClient

type EntityStoreAdminServer 

type EntityStoreAdminServer interface {
	AdminWrite(context.Context, *AdminWriteEntityRequest) (*WriteEntityResponse, error)
}

EntityStoreAdminServer is the server API for EntityStoreAdmin service. All implementations should embed UnimplementedEntityStoreAdminServer for forward compatibility

type EntityStoreClient 

type EntityStoreClient interface {
	Read(ctx context.Context, in *ReadEntityRequest, opts ...grpc.CallOption) (*Entity, error)
	BatchRead(ctx context.Context, in *BatchReadEntityRequest, opts ...grpc.CallOption) (*BatchReadEntityResponse, error)
	Write(ctx context.Context, in *WriteEntityRequest, opts ...grpc.CallOption) (*WriteEntityResponse, error)
	Delete(ctx context.Context, in *DeleteEntityRequest, opts ...grpc.CallOption) (*DeleteEntityResponse, error)
	History(ctx context.Context, in *EntityHistoryRequest, opts ...grpc.CallOption) (*EntityHistoryResponse, error)
	Search(ctx context.Context, in *EntitySearchRequest, opts ...grpc.CallOption) (*EntitySearchResponse, error)
	Watch(ctx context.Context, in *EntityWatchRequest, opts ...grpc.CallOption) (EntityStore_WatchClient, error)
	// TEMPORARY... while we split this into a new service (see below)
	AdminWrite(ctx context.Context, in *AdminWriteEntityRequest, opts ...grpc.CallOption) (*WriteEntityResponse, error)
}

EntityStoreClient is the client API for EntityStore service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewEntityStoreClient 

func NewEntityStoreClient(cc grpc.ClientConnInterface) EntityStoreClient

type EntityStoreServer 

type EntityStoreServer interface {
	Read(context.Context, *ReadEntityRequest) (*Entity, error)
	BatchRead(context.Context, *BatchReadEntityRequest) (*BatchReadEntityResponse, error)
	Write(context.Context, *WriteEntityRequest) (*WriteEntityResponse, error)
	Delete(context.Context, *DeleteEntityRequest) (*DeleteEntityResponse, error)
	History(context.Context, *EntityHistoryRequest) (*EntityHistoryResponse, error)
	Search(context.Context, *EntitySearchRequest) (*EntitySearchResponse, error)
	Watch(*EntityWatchRequest, EntityStore_WatchServer) error
	// TEMPORARY... while we split this into a new service (see below)
	AdminWrite(context.Context, *AdminWriteEntityRequest) (*WriteEntityResponse, error)
}

EntityStoreServer is the server API for EntityStore service. All implementations should embed UnimplementedEntityStoreServer for forward compatibility

type EntityStore_WatchClient 

type EntityStore_WatchClient interface {
	Recv() (*EntityWatchResponse, error)
	grpc.ClientStream
}

type EntityStore_WatchServer 

type EntityStore_WatchServer interface {
	Send(*EntityWatchResponse) error
	grpc.ServerStream
}

type EntitySummary 

type EntitySummary struct {
	UID         string `json:"uid,omitempty"`
	Kind        string `json:"kind,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`

	// Key value pairs.  Tags are are represented as keys with empty values
	Labels map[string]string `json:"labels,omitempty"`

	// Parent folder UID
	Folder string `json:"folder,omitempty"`

	// URL safe version of the name.  It will be unique within the folder
	Slug string `json:"slug,omitempty"`

	// When errors exist
	Error *EntityErrorInfo `json:"error,omitempty"`

	// Optional field values.  The schema will define and document possible values for a given kind
	Fields map[string]interface{} `json:"fields,omitempty"`

	// eg: panels within dashboard
	Nested []*EntitySummary `json:"nested,omitempty"`

	// Optional references to external things
	References []*EntityExternalReference `json:"references,omitempty"`
	// contains filtered or unexported fields
}

EntitySummary represents common data derived from a raw object bytes. The values should not depend on system state, and are derived from the raw object. This summary is used for a unified search and object listing

type EntitySummaryBuilder 

type EntitySummaryBuilder = func(ctx context.Context, uid string, body []byte) (*EntitySummary, []byte, error)

EntitySummaryBuilder will read an object, validate it, and return a summary, sanitized payload, or an error This should not include values that depend on system state, only the raw object

type EntityVersionInfo 

type EntityVersionInfo struct {

	// The version will change when the entity is saved. It is not necessarily sortable
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Time in epoch milliseconds that the entity was updated
	UpdatedAt int64 `protobuf:"varint,2,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Who updated the entity
	UpdatedBy string `protobuf:"bytes,3,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// Content Length
	Size int64 `protobuf:"varint,4,opt,name=size,proto3" json:"size,omitempty"`
	// MD5 digest of the body
	ETag string `protobuf:"bytes,5,opt,name=ETag,proto3" json:"ETag,omitempty"`
	// optional "save" or "commit" message
	//
	// NOTE: currently managed by the dashboard_version table, and will be returned from a "history" command
	Comment string `protobuf:"bytes,6,opt,name=comment,proto3" json:"comment,omitempty"`
	// contains filtered or unexported fields
}

This is a subset of Entity that does not include body or sync info

func (*EntityVersionInfo) Descriptor deprecated 

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

Deprecated: Use EntityVersionInfo.ProtoReflect.Descriptor instead.

func (*EntityVersionInfo) GetComment 

func (x *EntityVersionInfo) GetComment() string

func (*EntityVersionInfo) GetETag 

func (x *EntityVersionInfo) GetETag() string

func (*EntityVersionInfo) GetSize 

func (x *EntityVersionInfo) GetSize() int64

func (*EntityVersionInfo) GetUpdatedAt 

func (x *EntityVersionInfo) GetUpdatedAt() int64

func (*EntityVersionInfo) GetUpdatedBy 

func (x *EntityVersionInfo) GetUpdatedBy() string

func (*EntityVersionInfo) GetVersion 

func (x *EntityVersionInfo) GetVersion() string

func (*EntityVersionInfo) ProtoMessage 

func (*EntityVersionInfo) ProtoMessage()

func (*EntityVersionInfo) ProtoReflect 

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

func (*EntityVersionInfo) Reset 

func (x *EntityVersionInfo) Reset()

func (*EntityVersionInfo) String 

func (x *EntityVersionInfo) String() string

type EntityWatchRequest 

type EntityWatchRequest struct {

	// Timestamp of last changes. Empty will default to
	Since int64 `protobuf:"varint,1,opt,name=since,proto3" json:"since,omitempty"`
	// Watch sppecific entities
	GRN []*GRN `protobuf:"bytes,2,rep,name=GRN,proto3" json:"GRN,omitempty"`
	// limit to a specific kind (empty is all)
	Kind []string `protobuf:"bytes,3,rep,name=kind,proto3" json:"kind,omitempty"`
	// Limit results to items in a specific folder
	Folder string `protobuf:"bytes,4,opt,name=folder,proto3" json:"folder,omitempty"`
	// Must match all labels
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Return the full body in each payload
	WithBody bool `protobuf:"varint,6,opt,name=with_body,json=withBody,proto3" json:"with_body,omitempty"`
	// Return the full body in each payload
	WithLabels bool `protobuf:"varint,7,opt,name=with_labels,json=withLabels,proto3" json:"with_labels,omitempty"`
	// Return the full body in each payload
	WithFields bool `protobuf:"varint,8,opt,name=with_fields,json=withFields,proto3" json:"with_fields,omitempty"`
	// contains filtered or unexported fields
}

func (*EntityWatchRequest) Descriptor deprecated 

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

Deprecated: Use EntityWatchRequest.ProtoReflect.Descriptor instead.

func (*EntityWatchRequest) GetFolder 

func (x *EntityWatchRequest) GetFolder() string

func (*EntityWatchRequest) GetGRN 

func (x *EntityWatchRequest) GetGRN() []*GRN

func (*EntityWatchRequest) GetKind 

func (x *EntityWatchRequest) GetKind() []string

func (*EntityWatchRequest) GetLabels 

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

func (*EntityWatchRequest) GetSince 

func (x *EntityWatchRequest) GetSince() int64

func (*EntityWatchRequest) GetWithBody 

func (x *EntityWatchRequest) GetWithBody() bool

func (*EntityWatchRequest) GetWithFields 

func (x *EntityWatchRequest) GetWithFields() bool

func (*EntityWatchRequest) GetWithLabels 

func (x *EntityWatchRequest) GetWithLabels() bool

func (*EntityWatchRequest) ProtoMessage 

func (*EntityWatchRequest) ProtoMessage()

func (*EntityWatchRequest) ProtoReflect 

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

func (*EntityWatchRequest) Reset 

func (x *EntityWatchRequest) Reset()

func (*EntityWatchRequest) String 

func (x *EntityWatchRequest) String() string

type EntityWatchResponse 

type EntityWatchResponse struct {

	// Timestamp the event was sent
	Timestamp int64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// List of entities with the same action
	Entity []*Entity `protobuf:"bytes,2,rep,name=entity,proto3" json:"entity,omitempty"`
	// Action code
	Action EntityWatchResponse_Action `protobuf:"varint,3,opt,name=action,proto3,enum=entity.EntityWatchResponse_Action" json:"action,omitempty"`
	// contains filtered or unexported fields
}

func (*EntityWatchResponse) Descriptor deprecated 

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

Deprecated: Use EntityWatchResponse.ProtoReflect.Descriptor instead.

func (*EntityWatchResponse) GetAction 

func (x *EntityWatchResponse) GetAction() EntityWatchResponse_Action

func (*EntityWatchResponse) GetEntity 

func (x *EntityWatchResponse) GetEntity() []*Entity

func (*EntityWatchResponse) GetTimestamp 

func (x *EntityWatchResponse) GetTimestamp() int64

func (*EntityWatchResponse) ProtoMessage 

func (*EntityWatchResponse) ProtoMessage()

func (*EntityWatchResponse) ProtoReflect 

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

func (*EntityWatchResponse) Reset 

func (x *EntityWatchResponse) Reset()

func (*EntityWatchResponse) String 

func (x *EntityWatchResponse) String() string

type EntityWatchResponse_Action 

type EntityWatchResponse_Action int32

Status enumeration 

const (
	EntityWatchResponse_UNKNOWN EntityWatchResponse_Action = 0
	EntityWatchResponse_UPDATED EntityWatchResponse_Action = 1
	EntityWatchResponse_DELETED EntityWatchResponse_Action = 2
)

func (EntityWatchResponse_Action) Descriptor 

func (EntityWatchResponse_Action) Descriptor() protoreflect.EnumDescriptor

func (EntityWatchResponse_Action) Enum 

func (x EntityWatchResponse_Action) Enum() *EntityWatchResponse_Action

func (EntityWatchResponse_Action) EnumDescriptor deprecated 

func (EntityWatchResponse_Action) EnumDescriptor() ([]byte, []int)

Deprecated: Use EntityWatchResponse_Action.Descriptor instead.

func (EntityWatchResponse_Action) Number 

func (x EntityWatchResponse_Action) Number() protoreflect.EnumNumber

func (EntityWatchResponse_Action) String 

func (x EntityWatchResponse_Action) String() string

func (EntityWatchResponse_Action) Type 

func (EntityWatchResponse_Action) Type() protoreflect.EnumType

type GRN 

type GRN struct {

	// the tenant/org id
	TenantId int64 `protobuf:"varint,1,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	// Identify the entity kind.  This kind will be used to apply a schema to the body and
	// will trigger additional indexing behavior.
	Kind string `protobuf:"bytes,3,opt,name=kind,proto3" json:"kind,omitempty"`
	// Unique ID
	// 40 characters or less, no slashes or other special characters
	UID string `protobuf:"bytes,4,opt,name=UID,proto3" json:"UID,omitempty"`
	// contains filtered or unexported fields
}

func (*GRN) Descriptor deprecated 

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

Deprecated: Use GRN.ProtoReflect.Descriptor instead.

func (*GRN) Equals 

func (x *GRN) Equals(b *GRN) bool

Check if the two GRNs reference to the same object we can not use simple `*x == *b` because of the internal settings

func (*GRN) GetKind 

func (x *GRN) GetKind() string

func (*GRN) GetTenantId 

func (x *GRN) GetTenantId() int64

func (*GRN) GetUID 

func (x *GRN) GetUID() string

func (*GRN) ProtoMessage 

func (*GRN) ProtoMessage()

func (*GRN) ProtoReflect 

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

func (*GRN) Reset 

func (x *GRN) Reset()

func (*GRN) String 

func (x *GRN) String() string

func (*GRN) ToGRNString 

func (x *GRN) ToGRNString() string

Set an OID based on the GRN

type ReadEntityRequest 

type ReadEntityRequest struct {

	// Entity identifier
	GRN *GRN `protobuf:"bytes,1,opt,name=GRN,proto3" json:"GRN,omitempty"`
	// Fetch an explicit version
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Include the full body bytes
	WithBody bool `protobuf:"varint,3,opt,name=with_body,json=withBody,proto3" json:"with_body,omitempty"`
	// Include derived summary metadata
	WithSummary bool `protobuf:"varint,4,opt,name=with_summary,json=withSummary,proto3" json:"with_summary,omitempty"`
	// contains filtered or unexported fields
}

func (*ReadEntityRequest) Descriptor deprecated 

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

Deprecated: Use ReadEntityRequest.ProtoReflect.Descriptor instead.

func (*ReadEntityRequest) GetGRN 

func (x *ReadEntityRequest) GetGRN() *GRN

func (*ReadEntityRequest) GetVersion 

func (x *ReadEntityRequest) GetVersion() string

func (*ReadEntityRequest) GetWithBody 

func (x *ReadEntityRequest) GetWithBody() bool

func (*ReadEntityRequest) GetWithSummary 

func (x *ReadEntityRequest) GetWithSummary() bool

func (*ReadEntityRequest) ProtoMessage 

func (*ReadEntityRequest) ProtoMessage()

func (*ReadEntityRequest) ProtoReflect 

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

func (*ReadEntityRequest) Reset 

func (x *ReadEntityRequest) Reset()

func (*ReadEntityRequest) String 

func (x *ReadEntityRequest) String() string

type UnimplementedEntityStoreAdminServer 

type UnimplementedEntityStoreAdminServer struct {
}

UnimplementedEntityStoreAdminServer should be embedded to have forward compatible implementations.

func (UnimplementedEntityStoreAdminServer) AdminWrite 

func (UnimplementedEntityStoreAdminServer) AdminWrite(context.Context, *AdminWriteEntityRequest) (*WriteEntityResponse, error)

type UnimplementedEntityStoreServer 

type UnimplementedEntityStoreServer struct {
}

UnimplementedEntityStoreServer should be embedded to have forward compatible implementations.

func (UnimplementedEntityStoreServer) AdminWrite 

func (UnimplementedEntityStoreServer) AdminWrite(context.Context, *AdminWriteEntityRequest) (*WriteEntityResponse, error)

func (UnimplementedEntityStoreServer) BatchRead 

func (UnimplementedEntityStoreServer) BatchRead(context.Context, *BatchReadEntityRequest) (*BatchReadEntityResponse, error)

func (UnimplementedEntityStoreServer) Delete 

func (UnimplementedEntityStoreServer) Delete(context.Context, *DeleteEntityRequest) (*DeleteEntityResponse, error)

func (UnimplementedEntityStoreServer) History 

func (UnimplementedEntityStoreServer) History(context.Context, *EntityHistoryRequest) (*EntityHistoryResponse, error)

func (UnimplementedEntityStoreServer) Read 

func (UnimplementedEntityStoreServer) Read(context.Context, *ReadEntityRequest) (*Entity, error)

func (UnimplementedEntityStoreServer) Search 

func (UnimplementedEntityStoreServer) Search(context.Context, *EntitySearchRequest) (*EntitySearchResponse, error)

func (UnimplementedEntityStoreServer) Watch 

func (UnimplementedEntityStoreServer) Watch(*EntityWatchRequest, EntityStore_WatchServer) error

func (UnimplementedEntityStoreServer) Write 

func (UnimplementedEntityStoreServer) Write(context.Context, *WriteEntityRequest) (*WriteEntityResponse, error)

type UnsafeEntityStoreAdminServer 

type UnsafeEntityStoreAdminServer interface {
	// contains filtered or unexported methods
}

UnsafeEntityStoreAdminServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EntityStoreAdminServer will result in compilation errors.

type UnsafeEntityStoreServer 

type UnsafeEntityStoreServer interface {
	// contains filtered or unexported methods
}

UnsafeEntityStoreServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EntityStoreServer will result in compilation errors.

type WriteEntityRequest 

type WriteEntityRequest struct {

	// Entity identifier
	GRN *GRN `protobuf:"bytes,1,opt,name=GRN,proto3" json:"GRN,omitempty"`
	// Where to save the entity (empty will leave it unchanged)
	Folder string `protobuf:"bytes,2,opt,name=folder,proto3" json:"folder,omitempty"`
	// The raw entity body
	Body []byte `protobuf:"bytes,3,opt,name=body,proto3" json:"body,omitempty"`
	// Message that can be seen when exploring entity history
	Comment string `protobuf:"bytes,4,opt,name=comment,proto3" json:"comment,omitempty"`
	// Used for optimistic locking.  If missing, the previous version will be replaced regardless
	PreviousVersion string `protobuf:"bytes,5,opt,name=previous_version,json=previousVersion,proto3" json:"previous_version,omitempty"`
	// contains filtered or unexported fields
}

func (*WriteEntityRequest) Descriptor deprecated 

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

Deprecated: Use WriteEntityRequest.ProtoReflect.Descriptor instead.

func (*WriteEntityRequest) GetBody 

func (x *WriteEntityRequest) GetBody() []byte

func (*WriteEntityRequest) GetComment 

func (x *WriteEntityRequest) GetComment() string

func (*WriteEntityRequest) GetFolder 

func (x *WriteEntityRequest) GetFolder() string

func (*WriteEntityRequest) GetGRN 

func (x *WriteEntityRequest) GetGRN() *GRN

func (*WriteEntityRequest) GetPreviousVersion 

func (x *WriteEntityRequest) GetPreviousVersion() string

func (*WriteEntityRequest) ProtoMessage 

func (*WriteEntityRequest) ProtoMessage()

func (*WriteEntityRequest) ProtoReflect 

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

func (*WriteEntityRequest) Reset 

func (x *WriteEntityRequest) Reset()

func (*WriteEntityRequest) String 

func (x *WriteEntityRequest) String() string

type WriteEntityResponse 

type WriteEntityResponse struct {

	// Error info -- if exists, the save did not happen
	Error *EntityErrorInfo `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// Entity identifier
	GRN *GRN `protobuf:"bytes,2,opt,name=GRN,proto3" json:"GRN,omitempty"`
	// Entity details with the body removed
	Entity *EntityVersionInfo `protobuf:"bytes,3,opt,name=entity,proto3" json:"entity,omitempty"`
	// Entity summary as JSON
	SummaryJson []byte `protobuf:"bytes,4,opt,name=summary_json,json=summaryJson,proto3" json:"summary_json,omitempty"`
	// Status code
	Status WriteEntityResponse_Status `protobuf:"varint,5,opt,name=status,proto3,enum=entity.WriteEntityResponse_Status" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*WriteEntityResponse) Descriptor deprecated 

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

Deprecated: Use WriteEntityResponse.ProtoReflect.Descriptor instead.

func (*WriteEntityResponse) GetEntity 

func (x *WriteEntityResponse) GetEntity() *EntityVersionInfo

func (*WriteEntityResponse) GetError 

func (x *WriteEntityResponse) GetError() *EntityErrorInfo

func (*WriteEntityResponse) GetGRN 

func (x *WriteEntityResponse) GetGRN() *GRN

func (*WriteEntityResponse) GetStatus 

func (x *WriteEntityResponse) GetStatus() WriteEntityResponse_Status

func (*WriteEntityResponse) GetSummaryJson 

func (x *WriteEntityResponse) GetSummaryJson() []byte

func (*WriteEntityResponse) MarshalJSON 

func (obj *WriteEntityResponse) MarshalJSON() ([]byte, error)

func (*WriteEntityResponse) ProtoMessage 

func (*WriteEntityResponse) ProtoMessage()

func (*WriteEntityResponse) ProtoReflect 

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

func (*WriteEntityResponse) Reset 

func (x *WriteEntityResponse) Reset()

func (*WriteEntityResponse) String 

func (x *WriteEntityResponse) String() string

type WriteEntityResponse_Status 

type WriteEntityResponse_Status int32

Status enumeration 

const (
	WriteEntityResponse_ERROR     WriteEntityResponse_Status = 0
	WriteEntityResponse_CREATED   WriteEntityResponse_Status = 1
	WriteEntityResponse_UPDATED   WriteEntityResponse_Status = 2
	WriteEntityResponse_UNCHANGED WriteEntityResponse_Status = 3
)

func (WriteEntityResponse_Status) Descriptor 

func (WriteEntityResponse_Status) Descriptor() protoreflect.EnumDescriptor

func (WriteEntityResponse_Status) Enum 

func (x WriteEntityResponse_Status) Enum() *WriteEntityResponse_Status

func (WriteEntityResponse_Status) EnumDescriptor deprecated 

func (WriteEntityResponse_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use WriteEntityResponse_Status.Descriptor instead.

func (WriteEntityResponse_Status) Number 

func (x WriteEntityResponse_Status) Number() protoreflect.EnumNumber

func (WriteEntityResponse_Status) String 

func (x WriteEntityResponse_Status) String() string

func (WriteEntityResponse_Status) Type 

func (WriteEntityResponse_Status) Type() protoreflect.EnumType

Source Files

View all Source files

Directories

Path Synopsis

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.