entity

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
}

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

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

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
}

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

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
}

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
}

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"`
}

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
}

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
}

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"`
}

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
}

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
}

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
}

type EntitySearchResult struct {

	// Entity identifier
	GRN *GRN `protobuf:"bytes,1,opt,name=GRN,proto3" json:"GRN,omitempty"`
	// The current version 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
}

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

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

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)
}

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)
}

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

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

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
}

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

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
}

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
}

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
}

type EntityWatchResponse_Action int32

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
}

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
}

type UnimplementedEntityStoreAdminServer struct {
}

type UnimplementedEntityStoreServer struct {
}

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

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

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
}

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
}

type WriteEntityResponse_Status int32