annotation

package
v0.0.0-...-4722edd Latest Latest
Warning

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

 Go to latest Published: Dec 5, 2024 License: BSD-2-Clause Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	TaggedAnnotationService_GetAnnotation_FullMethodName         = "/dictybase.annotation.TaggedAnnotationService/GetAnnotation"
	TaggedAnnotationService_GetEntryAnnotation_FullMethodName    = "/dictybase.annotation.TaggedAnnotationService/GetEntryAnnotation"
	TaggedAnnotationService_ListAnnotations_FullMethodName       = "/dictybase.annotation.TaggedAnnotationService/ListAnnotations"
	TaggedAnnotationService_CreateAnnotation_FullMethodName      = "/dictybase.annotation.TaggedAnnotationService/CreateAnnotation"
	TaggedAnnotationService_UpdateAnnotation_FullMethodName      = "/dictybase.annotation.TaggedAnnotationService/UpdateAnnotation"
	TaggedAnnotationService_DeleteAnnotation_FullMethodName      = "/dictybase.annotation.TaggedAnnotationService/DeleteAnnotation"
	TaggedAnnotationService_CreateAnnotationGroup_FullMethodName = "/dictybase.annotation.TaggedAnnotationService/CreateAnnotationGroup"
	TaggedAnnotationService_GetAnnotationGroup_FullMethodName    = "/dictybase.annotation.TaggedAnnotationService/GetAnnotationGroup"
	TaggedAnnotationService_AddToAnnotationGroup_FullMethodName  = "/dictybase.annotation.TaggedAnnotationService/AddToAnnotationGroup"
	TaggedAnnotationService_DeleteAnnotationGroup_FullMethodName = "/dictybase.annotation.TaggedAnnotationService/DeleteAnnotationGroup"
	TaggedAnnotationService_ListAnnotationGroups_FullMethodName  = "/dictybase.annotation.TaggedAnnotationService/ListAnnotationGroups"
	TaggedAnnotationService_GetAnnotationTag_FullMethodName      = "/dictybase.annotation.TaggedAnnotationService/GetAnnotationTag"
	TaggedAnnotationService_OboJSONFileUpload_FullMethodName     = "/dictybase.annotation.TaggedAnnotationService/OboJSONFileUpload"
)

Variables

View Source 
var File_dictybase_annotation_annotation_proto protoreflect.FileDescriptor
View Source 
var TaggedAnnotationService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "dictybase.annotation.TaggedAnnotationService",
	HandlerType: (*TaggedAnnotationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetAnnotation",
			Handler:    _TaggedAnnotationService_GetAnnotation_Handler,
		},
		{
			MethodName: "GetEntryAnnotation",
			Handler:    _TaggedAnnotationService_GetEntryAnnotation_Handler,
		},
		{
			MethodName: "ListAnnotations",
			Handler:    _TaggedAnnotationService_ListAnnotations_Handler,
		},
		{
			MethodName: "CreateAnnotation",
			Handler:    _TaggedAnnotationService_CreateAnnotation_Handler,
		},
		{
			MethodName: "UpdateAnnotation",
			Handler:    _TaggedAnnotationService_UpdateAnnotation_Handler,
		},
		{
			MethodName: "DeleteAnnotation",
			Handler:    _TaggedAnnotationService_DeleteAnnotation_Handler,
		},
		{
			MethodName: "CreateAnnotationGroup",
			Handler:    _TaggedAnnotationService_CreateAnnotationGroup_Handler,
		},
		{
			MethodName: "GetAnnotationGroup",
			Handler:    _TaggedAnnotationService_GetAnnotationGroup_Handler,
		},
		{
			MethodName: "AddToAnnotationGroup",
			Handler:    _TaggedAnnotationService_AddToAnnotationGroup_Handler,
		},
		{
			MethodName: "DeleteAnnotationGroup",
			Handler:    _TaggedAnnotationService_DeleteAnnotationGroup_Handler,
		},
		{
			MethodName: "ListAnnotationGroups",
			Handler:    _TaggedAnnotationService_ListAnnotationGroups_Handler,
		},
		{
			MethodName: "GetAnnotationTag",
			Handler:    _TaggedAnnotationService_GetAnnotationTag_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "OboJSONFileUpload",
			Handler:       _TaggedAnnotationService_OboJSONFileUpload_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "dictybase/annotation/annotation.proto",
}

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

Functions

func RegisterTaggedAnnotationServiceServer 

func RegisterTaggedAnnotationServiceServer(s grpc.ServiceRegistrar, srv TaggedAnnotationServiceServer)

Types

type AnnotationGroupId 

type AnnotationGroupId struct {

	// unique identifier for the annotation
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// unique identifier of a group
	GroupId string `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// contains filtered or unexported fields
}

func (*AnnotationGroupId) Descriptor deprecated 

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

Deprecated: Use AnnotationGroupId.ProtoReflect.Descriptor instead.

func (*AnnotationGroupId) GetGroupId 

func (x *AnnotationGroupId) GetGroupId() string

func (*AnnotationGroupId) GetId 

func (x *AnnotationGroupId) GetId() string

func (*AnnotationGroupId) ProtoMessage 

func (*AnnotationGroupId) ProtoMessage()

func (*AnnotationGroupId) ProtoReflect 

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

func (*AnnotationGroupId) Reset 

func (x *AnnotationGroupId) Reset()

func (*AnnotationGroupId) String 

func (x *AnnotationGroupId) String() string

func (*AnnotationGroupId) Validate 

func (this *AnnotationGroupId) Validate() error

type AnnotationId 

type AnnotationId struct {

	// unique identifier for the annotation
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*AnnotationId) Descriptor deprecated 

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

Deprecated: Use AnnotationId.ProtoReflect.Descriptor instead.

func (*AnnotationId) GetId 

func (x *AnnotationId) GetId() string

func (*AnnotationId) ProtoMessage 

func (*AnnotationId) ProtoMessage()

func (*AnnotationId) ProtoReflect 

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

func (*AnnotationId) Reset 

func (x *AnnotationId) Reset()

func (*AnnotationId) String 

func (x *AnnotationId) String() string

func (*AnnotationId) Validate 

func (this *AnnotationId) Validate() error

type AnnotationIdList 

type AnnotationIdList struct {

	// list of unique identifiers
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

Identifiers for grouping list of tagged annotations

func (*AnnotationIdList) Descriptor deprecated 

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

Deprecated: Use AnnotationIdList.ProtoReflect.Descriptor instead.

func (*AnnotationIdList) GetIds 

func (x *AnnotationIdList) GetIds() []string

func (*AnnotationIdList) ProtoMessage 

func (*AnnotationIdList) ProtoMessage()

func (*AnnotationIdList) ProtoReflect 

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

func (*AnnotationIdList) Reset 

func (x *AnnotationIdList) Reset()

func (*AnnotationIdList) String 

func (x *AnnotationIdList) String() string

func (*AnnotationIdList) Validate 

func (this *AnnotationIdList) Validate() error

type AnnotationTag 

type AnnotationTag struct {

	// tag identifier
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// human readable name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// ontology to which this tag belong
	Ontology string `protobuf:"bytes,3,opt,name=ontology,proto3" json:"ontology,omitempty"`
	// status for active or retired tag
	IsObsolete bool `protobuf:"varint,4,opt,name=is_obsolete,json=isObsolete,proto3" json:"is_obsolete,omitempty"`
	// contains filtered or unexported fields
}

Definition of annotation tag

func (*AnnotationTag) Descriptor deprecated 

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

Deprecated: Use AnnotationTag.ProtoReflect.Descriptor instead.

func (*AnnotationTag) GetId 

func (x *AnnotationTag) GetId() string

func (*AnnotationTag) GetIsObsolete 

func (x *AnnotationTag) GetIsObsolete() bool

func (*AnnotationTag) GetName 

func (x *AnnotationTag) GetName() string

func (*AnnotationTag) GetOntology 

func (x *AnnotationTag) GetOntology() string

func (*AnnotationTag) ProtoMessage 

func (*AnnotationTag) ProtoMessage()

func (*AnnotationTag) ProtoReflect 

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

func (*AnnotationTag) Reset 

func (x *AnnotationTag) Reset()

func (*AnnotationTag) String 

func (x *AnnotationTag) String() string

func (*AnnotationTag) Validate 

func (this *AnnotationTag) Validate() error

type DeleteAnnotationRequest 

type DeleteAnnotationRequest struct {

	// unique identifier for the annotation
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// flag to indicate whether the entry will be wiped or turned obsolete(soft delete)
	Purge bool `protobuf:"varint,2,opt,name=purge,proto3" json:"purge,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteAnnotationRequest) Descriptor deprecated 

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

Deprecated: Use DeleteAnnotationRequest.ProtoReflect.Descriptor instead.

func (*DeleteAnnotationRequest) GetId 

func (x *DeleteAnnotationRequest) GetId() string

func (*DeleteAnnotationRequest) GetPurge 

func (x *DeleteAnnotationRequest) GetPurge() bool

func (*DeleteAnnotationRequest) ProtoMessage 

func (*DeleteAnnotationRequest) ProtoMessage()

func (*DeleteAnnotationRequest) ProtoReflect 

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

func (*DeleteAnnotationRequest) Reset 

func (x *DeleteAnnotationRequest) Reset()

func (*DeleteAnnotationRequest) String 

func (x *DeleteAnnotationRequest) String() string

func (*DeleteAnnotationRequest) Validate 

func (this *DeleteAnnotationRequest) Validate() error

type EntryAnnotationRequest 

type EntryAnnotationRequest struct {

	// An identifiable tagname for the annotation, primarily
	// a structured tag, generally an ontology term.
	Tag string `protobuf:"bytes,1,opt,name=tag,proto3" json:"tag,omitempty"`
	// unique identifier of a biological entity that is being annotated
	EntryId string `protobuf:"bytes,2,opt,name=entry_id,json=entryId,proto3" json:"entry_id,omitempty"`
	// Name of ontology in which the tag name is taken
	Ontology string `protobuf:"bytes,3,opt,name=ontology,proto3" json:"ontology,omitempty"`
	// Ordering of annotation when an entry has multiple annotations with
	// identical tag from the same ontology. By default, rank 0 is assumed.
	Rank int64 `protobuf:"varint,4,opt,name=rank,proto3" json:"rank,omitempty"`
	// Status for active or retired annotation. Active annotation is chosen by default.
	IsObsolete bool `protobuf:"varint,5,opt,name=is_obsolete,json=isObsolete,proto3" json:"is_obsolete,omitempty"`
	// contains filtered or unexported fields
}

Definition for various fields that are needed for fetching annotation for an entry. The tag, ontology and entry_id must be provided, version and rank are optional and their default values are used.

func (*EntryAnnotationRequest) Descriptor deprecated 

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

Deprecated: Use EntryAnnotationRequest.ProtoReflect.Descriptor instead.

func (*EntryAnnotationRequest) GetEntryId 

func (x *EntryAnnotationRequest) GetEntryId() string

func (*EntryAnnotationRequest) GetIsObsolete 

func (x *EntryAnnotationRequest) GetIsObsolete() bool

func (*EntryAnnotationRequest) GetOntology 

func (x *EntryAnnotationRequest) GetOntology() string

func (*EntryAnnotationRequest) GetRank 

func (x *EntryAnnotationRequest) GetRank() int64

func (*EntryAnnotationRequest) GetTag 

func (x *EntryAnnotationRequest) GetTag() string

func (*EntryAnnotationRequest) ProtoMessage 

func (*EntryAnnotationRequest) ProtoMessage()

func (*EntryAnnotationRequest) ProtoReflect 

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

func (*EntryAnnotationRequest) Reset 

func (x *EntryAnnotationRequest) Reset()

func (*EntryAnnotationRequest) String 

func (x *EntryAnnotationRequest) String() string

func (*EntryAnnotationRequest) Validate 

func (this *EntryAnnotationRequest) Validate() error

type GroupEntryId 

type GroupEntryId struct {

	// unique identifier of a group
	GroupId string `protobuf:"bytes,1,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GroupEntryId) Descriptor deprecated 

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

Deprecated: Use GroupEntryId.ProtoReflect.Descriptor instead.

func (*GroupEntryId) GetGroupId 

func (x *GroupEntryId) GetGroupId() string

func (*GroupEntryId) ProtoMessage 

func (*GroupEntryId) ProtoMessage()

func (*GroupEntryId) ProtoReflect 

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

func (*GroupEntryId) Reset 

func (x *GroupEntryId) Reset()

func (*GroupEntryId) String 

func (x *GroupEntryId) String() string

func (*GroupEntryId) Validate 

func (this *GroupEntryId) Validate() error

type ListGroupParameters 

type ListGroupParameters struct {

	// A unique pointer to the next set of result in the list
	Cursor int64 `protobuf:"varint,1,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// Maximum number of records that can be fetch per request
	Limit int64 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// The `filter` field restricts the data return by the collection. To use
	// it, supply one or multiple allowed fields to filter followed
	// by a filter expression. It uses the following syntax...
	//
	//	field_name operator expression
	//
	// The following fields of `AnnotationAttributes` definition are allowed to
	// be used for filtering
	//   - entry_id    - The entry that is being annotated (string)
	//   - created_by  - Email id of the user (string)
	//   - tag         - Tag name, a term from an ontology (string).
	//   - ontology    - Ontology that provides the tag names (string).
	//   - rank        - Ordering of annotation (number).
	//
	// operator - Defines the type of filter match to use. It could be any of
	// the following four and all of them should be URL-encoded for http request.
	//
	//	Operators for strings
	//	      =~    Contains substring
	//	      !~   Not contains substring
	//	      ===  Equals
	//	      !==  Not equals
	//
	//	Operators for numbers
	//	      ==  Equals
	//	      !=  Not equals
	//	      >   Greater than
	//	      <   Less than
	//	      =<  Less than equal to
	//	      >=  Greater than equal to
	//
	// expression - The value that will be included or excluded from the
	// result. URL-reserved characters must be URL-encoded for http request.
	//
	//	filter: "created_by==caboose@abc.com"
	//	filter: "entry_id==DDB_G4839483"
	//	filter: "tag==growth"
	//
	// Filter can be combined using OR or AND boolean logic.
	//
	//   - The OR is represented using a comma(,).
	//
	//   - The AND is represented using a semi-colon(;).
	//
	//   - AND and OR operators can be combined and AND takes precedence over OR.
	//
	//     filter: "tag~cytoskeletion;entry_id==DDB_G4839783;ontology==cellular"
	//     filter: "tag~membrane;entry_id==DDB_G4839783;ontology==cellular;rank=0"
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

ListGroupParameters defines fields for manipulating output of TaggedAnnotationGroupCollection collection

func (*ListGroupParameters) Descriptor deprecated 

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

Deprecated: Use ListGroupParameters.ProtoReflect.Descriptor instead.

func (*ListGroupParameters) GetCursor 

func (x *ListGroupParameters) GetCursor() int64

func (*ListGroupParameters) GetFilter 

func (x *ListGroupParameters) GetFilter() string

func (*ListGroupParameters) GetLimit 

func (x *ListGroupParameters) GetLimit() int64

func (*ListGroupParameters) ProtoMessage 

func (*ListGroupParameters) ProtoMessage()

func (*ListGroupParameters) ProtoReflect 

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

func (*ListGroupParameters) Reset 

func (x *ListGroupParameters) Reset()

func (*ListGroupParameters) String 

func (x *ListGroupParameters) String() string

func (*ListGroupParameters) Validate 

func (this *ListGroupParameters) Validate() error

type ListParameters 

type ListParameters struct {

	// A unique pointer to the next set of result in the list
	Cursor int64 `protobuf:"varint,1,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// Maximum number of records that can be fetch per request
	Limit int64 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// The `filter` field restricts the data return by the collection. To use
	// it, supply one or multiple allowed fields to filter followed
	// by a filter expression. It uses the following syntax...
	//
	//	field_name operator expression
	//
	// The following fields of `AnnotationAttributes` definition are allowed to
	// be used for filtering
	//   - entry_id    - The entry that is being annotated (string)
	//   - value       - The annotation in plain text format (string)
	//   - created_by  - Email id of the user (string)
	//   - tag         - Tag name, a term from an ontology (string).
	//   - ontology    - Ontology that provides the tag names (string).
	//   - version     - Version no (number).
	//   - value       - annotation in plain text format (number).
	//
	// operator - Defines the type of filter match to use. It could be any of
	// the following four and all of them should be URL-encoded for http request.
	//
	//	Operators for strings
	//	      =~    Contains substring
	//	      !~   Not contains substring
	//	      ===  Equals
	//	      !==  Not equals
	//
	//	Operators for numbers
	//	      ==  Equals
	//	      !=  Not equals
	//	      >   Greater than
	//	      <   Less than
	//	      =<  Less than equal to
	//	      >=  Greater than equal to
	//
	// expression - The value that will be included or excluded from the
	// result. URL-reserved characters must be URL-encoded for http request.
	//
	//	filter: "created_by==caboose@abc.com"
	//	filter: "entry_id==DDB_G4839483"
	//	filter: "value~actin"
	//
	// Filter can be combined using OR or AND boolean logic.
	//
	//   - The OR is represented using a comma(,).
	//
	//   - The AND is represented using a semi-colon(;).
	//
	//   - AND and OR operators can be combined and AND takes precedence over OR.
	//
	//     filter: "value~cytoskeletion;tag==cell membrane;ontology==cellular"
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

ListParameters defines fields for manipulating output of TaggedAnnotation collection

func (*ListParameters) Descriptor deprecated 

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

Deprecated: Use ListParameters.ProtoReflect.Descriptor instead.

func (*ListParameters) GetCursor 

func (x *ListParameters) GetCursor() int64

func (*ListParameters) GetFilter 

func (x *ListParameters) GetFilter() string

func (*ListParameters) GetLimit 

func (x *ListParameters) GetLimit() int64

func (*ListParameters) ProtoMessage 

func (*ListParameters) ProtoMessage()

func (*ListParameters) ProtoReflect 

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

func (*ListParameters) Reset 

func (x *ListParameters) Reset()

func (*ListParameters) String 

func (x *ListParameters) String() string

func (*ListParameters) Validate 

func (this *ListParameters) Validate() error

type Meta 

type Meta struct {

	// A unique pointer to the next set of result in the collection. Set the
	// cursor value parameter to the value of next_cursor to retrieve the next
	// set of collection using the same method
	NextCursor int64 `protobuf:"varint,1,opt,name=next_cursor,json=nextCursor,proto3" json:"next_cursor,omitempty"`
	// Maximum number of records that can be fetch per request
	Limit int64 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

func (*Meta) Descriptor deprecated 

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

Deprecated: Use Meta.ProtoReflect.Descriptor instead.

func (*Meta) GetLimit 

func (x *Meta) GetLimit() int64

func (*Meta) GetNextCursor 

func (x *Meta) GetNextCursor() int64

func (*Meta) ProtoMessage 

func (*Meta) ProtoMessage()

func (*Meta) ProtoReflect 

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

func (*Meta) Reset 

func (x *Meta) Reset()

func (*Meta) String 

func (x *Meta) String() string

func (*Meta) Validate 

func (this *Meta) Validate() error

type NewTaggedAnnotation 

type NewTaggedAnnotation struct {
	Data *NewTaggedAnnotation_Data `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Definition for creating a new tagged annotation

func (*NewTaggedAnnotation) Descriptor deprecated 

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

Deprecated: Use NewTaggedAnnotation.ProtoReflect.Descriptor instead.

func (*NewTaggedAnnotation) GetData 

func (x *NewTaggedAnnotation) GetData() *NewTaggedAnnotation_Data

func (*NewTaggedAnnotation) ProtoMessage 

func (*NewTaggedAnnotation) ProtoMessage()

func (*NewTaggedAnnotation) ProtoReflect 

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

func (*NewTaggedAnnotation) Reset 

func (x *NewTaggedAnnotation) Reset()

func (*NewTaggedAnnotation) String 

func (x *NewTaggedAnnotation) String() string

func (*NewTaggedAnnotation) Validate 

func (this *NewTaggedAnnotation) Validate() error

type NewTaggedAnnotationAttributes 

type NewTaggedAnnotationAttributes struct {

	// annotation in plain text format
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// serialized text content in a format recognized by frontend rich text
	// editor
	EditableValue string `protobuf:"bytes,2,opt,name=editable_value,json=editableValue,proto3" json:"editable_value,omitempty"`
	// Unique identifier(generally email) of the user who created the annotation
	CreatedBy string `protobuf:"bytes,3,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// An identifiable tagname for the annotation, primarily
	// a structured tag, generally an ontology term.
	Tag string `protobuf:"bytes,4,opt,name=tag,proto3" json:"tag,omitempty"`
	// unique identifier of a biological entity that is being annotated
	EntryId string `protobuf:"bytes,5,opt,name=entry_id,json=entryId,proto3" json:"entry_id,omitempty"`
	// Name of ontology from which the tag name is taken
	Ontology string `protobuf:"bytes,6,opt,name=ontology,proto3" json:"ontology,omitempty"`
	// Ordering of annotation when an entry has multiple annotations with
	// identical tag from the same ontology. By default, rank 0 is used.
	Rank int64 `protobuf:"varint,7,opt,name=rank,proto3" json:"rank,omitempty"`
	// contains filtered or unexported fields
}

NewTaggedAnnotation defines attributes for creating a new annotation

func (*NewTaggedAnnotationAttributes) Descriptor deprecated 

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

Deprecated: Use NewTaggedAnnotationAttributes.ProtoReflect.Descriptor instead.

func (*NewTaggedAnnotationAttributes) GetCreatedBy 

func (x *NewTaggedAnnotationAttributes) GetCreatedBy() string

func (*NewTaggedAnnotationAttributes) GetEditableValue 

func (x *NewTaggedAnnotationAttributes) GetEditableValue() string

func (*NewTaggedAnnotationAttributes) GetEntryId 

func (x *NewTaggedAnnotationAttributes) GetEntryId() string

func (*NewTaggedAnnotationAttributes) GetOntology 

func (x *NewTaggedAnnotationAttributes) GetOntology() string

func (*NewTaggedAnnotationAttributes) GetRank 

func (x *NewTaggedAnnotationAttributes) GetRank() int64

func (*NewTaggedAnnotationAttributes) GetTag 

func (x *NewTaggedAnnotationAttributes) GetTag() string

func (*NewTaggedAnnotationAttributes) GetValue 

func (x *NewTaggedAnnotationAttributes) GetValue() string

func (*NewTaggedAnnotationAttributes) ProtoMessage 

func (*NewTaggedAnnotationAttributes) ProtoMessage()

func (*NewTaggedAnnotationAttributes) ProtoReflect 

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

func (*NewTaggedAnnotationAttributes) Reset 

func (x *NewTaggedAnnotationAttributes) Reset()

func (*NewTaggedAnnotationAttributes) String 

func (x *NewTaggedAnnotationAttributes) String() string

func (*NewTaggedAnnotationAttributes) Validate 

func (this *NewTaggedAnnotationAttributes) Validate() error

type NewTaggedAnnotation_Data 

type NewTaggedAnnotation_Data struct {

	// resource name, by default should be annotation
	Type       string                         `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Attributes *NewTaggedAnnotationAttributes `protobuf:"bytes,2,opt,name=attributes,proto3" json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

func (*NewTaggedAnnotation_Data) Descriptor deprecated 

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

Deprecated: Use NewTaggedAnnotation_Data.ProtoReflect.Descriptor instead.

func (*NewTaggedAnnotation_Data) GetAttributes 

func (x *NewTaggedAnnotation_Data) GetAttributes() *NewTaggedAnnotationAttributes

func (*NewTaggedAnnotation_Data) GetType 

func (x *NewTaggedAnnotation_Data) GetType() string

func (*NewTaggedAnnotation_Data) ProtoMessage 

func (*NewTaggedAnnotation_Data) ProtoMessage()

func (*NewTaggedAnnotation_Data) ProtoReflect 

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

func (*NewTaggedAnnotation_Data) Reset 

func (x *NewTaggedAnnotation_Data) Reset()

func (*NewTaggedAnnotation_Data) String 

func (x *NewTaggedAnnotation_Data) String() string

func (*NewTaggedAnnotation_Data) Validate 

func (this *NewTaggedAnnotation_Data) Validate() error

type TagRequest 

type TagRequest struct {

	// human readable name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// ontology to which this tag belong
	Ontology string `protobuf:"bytes,2,opt,name=ontology,proto3" json:"ontology,omitempty"`
	// status for active or retired tag
	IsObsolete bool `protobuf:"varint,3,opt,name=is_obsolete,json=isObsolete,proto3" json:"is_obsolete,omitempty"`
	// contains filtered or unexported fields
}

Definition of various fields needed to fetch a tag information

func (*TagRequest) Descriptor deprecated 

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

Deprecated: Use TagRequest.ProtoReflect.Descriptor instead.

func (*TagRequest) GetIsObsolete 

func (x *TagRequest) GetIsObsolete() bool

func (*TagRequest) GetName 

func (x *TagRequest) GetName() string

func (*TagRequest) GetOntology 

func (x *TagRequest) GetOntology() string

func (*TagRequest) ProtoMessage 

func (*TagRequest) ProtoMessage()

func (*TagRequest) ProtoReflect 

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

func (*TagRequest) Reset 

func (x *TagRequest) Reset()

func (*TagRequest) String 

func (x *TagRequest) String() string

func (*TagRequest) Validate 

func (this *TagRequest) Validate() error

type TaggedAnnotation 

type TaggedAnnotation struct {
	Data *TaggedAnnotation_Data `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Definition of an tag value based biological annotation where the tag always represents a term from ontology.

func (*TaggedAnnotation) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotation.ProtoReflect.Descriptor instead.

func (*TaggedAnnotation) GetData 

func (x *TaggedAnnotation) GetData() *TaggedAnnotation_Data

func (*TaggedAnnotation) ProtoMessage 

func (*TaggedAnnotation) ProtoMessage()

func (*TaggedAnnotation) ProtoReflect 

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

func (*TaggedAnnotation) Reset 

func (x *TaggedAnnotation) Reset()

func (*TaggedAnnotation) String 

func (x *TaggedAnnotation) String() string

func (*TaggedAnnotation) Validate 

func (this *TaggedAnnotation) Validate() error

type TaggedAnnotationAttributes 

type TaggedAnnotationAttributes struct {

	// annotation in plain text format
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// serialized text content in a format recognized by frontend rich text
	// editor
	EditableValue string `protobuf:"bytes,2,opt,name=editable_value,json=editableValue,proto3" json:"editable_value,omitempty"`
	// Unique identifier(generally email) of the user who created the annotation
	CreatedBy string `protobuf:"bytes,3,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Timestamp for creation
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// An identifiable tagname for the annotation, primarily
	// a structured tag, generally an ontology term.
	Tag string `protobuf:"bytes,5,opt,name=tag,proto3" json:"tag,omitempty"`
	// version refers to the current version no
	Version int64 `protobuf:"varint,6,opt,name=version,proto3" json:"version,omitempty"`
	// unique identifier of a biological entity that is being annotated
	EntryId string `protobuf:"bytes,7,opt,name=entry_id,json=entryId,proto3" json:"entry_id,omitempty"`
	// Name of ontology in which the tag name is taken
	Ontology string `protobuf:"bytes,8,opt,name=ontology,proto3" json:"ontology,omitempty"`
	// Ordering of annotation when an entry has multiple annotations with
	// identical tag from the same ontology.
	Rank int64 `protobuf:"varint,9,opt,name=rank,proto3" json:"rank,omitempty"`
	// Status for active or retired annotation
	IsObsolete bool `protobuf:"varint,10,opt,name=is_obsolete,json=isObsolete,proto3" json:"is_obsolete,omitempty"`
	// contains filtered or unexported fields
}

Definition of various tagged annotation attributes

func (*TaggedAnnotationAttributes) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotationAttributes.ProtoReflect.Descriptor instead.

func (*TaggedAnnotationAttributes) GetCreatedAt 

func (x *TaggedAnnotationAttributes) GetCreatedAt() *timestamppb.Timestamp

func (*TaggedAnnotationAttributes) GetCreatedBy 

func (x *TaggedAnnotationAttributes) GetCreatedBy() string

func (*TaggedAnnotationAttributes) GetEditableValue 

func (x *TaggedAnnotationAttributes) GetEditableValue() string

func (*TaggedAnnotationAttributes) GetEntryId 

func (x *TaggedAnnotationAttributes) GetEntryId() string

func (*TaggedAnnotationAttributes) GetIsObsolete 

func (x *TaggedAnnotationAttributes) GetIsObsolete() bool

func (*TaggedAnnotationAttributes) GetOntology 

func (x *TaggedAnnotationAttributes) GetOntology() string

func (*TaggedAnnotationAttributes) GetRank 

func (x *TaggedAnnotationAttributes) GetRank() int64

func (*TaggedAnnotationAttributes) GetTag 

func (x *TaggedAnnotationAttributes) GetTag() string

func (*TaggedAnnotationAttributes) GetValue 

func (x *TaggedAnnotationAttributes) GetValue() string

func (*TaggedAnnotationAttributes) GetVersion 

func (x *TaggedAnnotationAttributes) GetVersion() int64

func (*TaggedAnnotationAttributes) ProtoMessage 

func (*TaggedAnnotationAttributes) ProtoMessage()

func (*TaggedAnnotationAttributes) ProtoReflect 

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

func (*TaggedAnnotationAttributes) Reset 

func (x *TaggedAnnotationAttributes) Reset()

func (*TaggedAnnotationAttributes) String 

func (x *TaggedAnnotationAttributes) String() string

func (*TaggedAnnotationAttributes) Validate 

func (this *TaggedAnnotationAttributes) Validate() error

type TaggedAnnotationCollection 

type TaggedAnnotationCollection struct {
	Data []*TaggedAnnotationCollection_Data `protobuf:"bytes,1,rep,name=data,proto3" json:"data,omitempty"`
	Meta *Meta                              `protobuf:"bytes,3,opt,name=meta,proto3" json:"meta,omitempty"`
	// contains filtered or unexported fields
}

List of paginated tagged annotations

func (*TaggedAnnotationCollection) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotationCollection.ProtoReflect.Descriptor instead.

func (*TaggedAnnotationCollection) GetData 

func (x *TaggedAnnotationCollection) GetData() []*TaggedAnnotationCollection_Data

func (*TaggedAnnotationCollection) GetMeta 

func (x *TaggedAnnotationCollection) GetMeta() *Meta

func (*TaggedAnnotationCollection) ProtoMessage 

func (*TaggedAnnotationCollection) ProtoMessage()

func (*TaggedAnnotationCollection) ProtoReflect 

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

func (*TaggedAnnotationCollection) Reset 

func (x *TaggedAnnotationCollection) Reset()

func (*TaggedAnnotationCollection) String 

func (x *TaggedAnnotationCollection) String() string

func (*TaggedAnnotationCollection) Validate 

func (this *TaggedAnnotationCollection) Validate() error

type TaggedAnnotationCollection_Data 

type TaggedAnnotationCollection_Data struct {

	// resource name, by default should be annotation
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// unique identifier for the annotation
	Id         string                      `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	Attributes *TaggedAnnotationAttributes `protobuf:"bytes,3,opt,name=attributes,proto3" json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

func (*TaggedAnnotationCollection_Data) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotationCollection_Data.ProtoReflect.Descriptor instead.

func (*TaggedAnnotationCollection_Data) GetAttributes 

func (x *TaggedAnnotationCollection_Data) GetAttributes() *TaggedAnnotationAttributes

func (*TaggedAnnotationCollection_Data) GetId 

func (x *TaggedAnnotationCollection_Data) GetId() string

func (*TaggedAnnotationCollection_Data) GetType 

func (x *TaggedAnnotationCollection_Data) GetType() string

func (*TaggedAnnotationCollection_Data) ProtoMessage 

func (*TaggedAnnotationCollection_Data) ProtoMessage()

func (*TaggedAnnotationCollection_Data) ProtoReflect 

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

func (*TaggedAnnotationCollection_Data) Reset 

func (x *TaggedAnnotationCollection_Data) Reset()

func (*TaggedAnnotationCollection_Data) String 

func (x *TaggedAnnotationCollection_Data) String() string

func (*TaggedAnnotationCollection_Data) Validate 

func (this *TaggedAnnotationCollection_Data) Validate() error

type TaggedAnnotationGroup 

type TaggedAnnotationGroup struct {
	Data []*TaggedAnnotationGroup_Data `protobuf:"bytes,1,rep,name=data,proto3" json:"data,omitempty"`
	// unique identifier for the annotation group
	GroupId string `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// Timestamp for creation an update
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// contains filtered or unexported fields
}

Group of tagged annotations

func (*TaggedAnnotationGroup) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotationGroup.ProtoReflect.Descriptor instead.

func (*TaggedAnnotationGroup) GetCreatedAt 

func (x *TaggedAnnotationGroup) GetCreatedAt() *timestamppb.Timestamp

func (*TaggedAnnotationGroup) GetData 

func (x *TaggedAnnotationGroup) GetData() []*TaggedAnnotationGroup_Data

func (*TaggedAnnotationGroup) GetGroupId 

func (x *TaggedAnnotationGroup) GetGroupId() string

func (*TaggedAnnotationGroup) GetUpdatedAt 

func (x *TaggedAnnotationGroup) GetUpdatedAt() *timestamppb.Timestamp

func (*TaggedAnnotationGroup) ProtoMessage 

func (*TaggedAnnotationGroup) ProtoMessage()

func (*TaggedAnnotationGroup) ProtoReflect 

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

func (*TaggedAnnotationGroup) Reset 

func (x *TaggedAnnotationGroup) Reset()

func (*TaggedAnnotationGroup) String 

func (x *TaggedAnnotationGroup) String() string

func (*TaggedAnnotationGroup) Validate 

func (this *TaggedAnnotationGroup) Validate() error

type TaggedAnnotationGroupCollection 

type TaggedAnnotationGroupCollection struct {
	Data []*TaggedAnnotationGroupCollection_Data `protobuf:"bytes,1,rep,name=data,proto3" json:"data,omitempty"`
	Meta *Meta                                   `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"`
	// contains filtered or unexported fields
}

List of tagged annotation groups

func (*TaggedAnnotationGroupCollection) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotationGroupCollection.ProtoReflect.Descriptor instead.

func (*TaggedAnnotationGroupCollection) GetData 

func (x *TaggedAnnotationGroupCollection) GetData() []*TaggedAnnotationGroupCollection_Data

func (*TaggedAnnotationGroupCollection) GetMeta 

func (x *TaggedAnnotationGroupCollection) GetMeta() *Meta

func (*TaggedAnnotationGroupCollection) ProtoMessage 

func (*TaggedAnnotationGroupCollection) ProtoMessage()

func (*TaggedAnnotationGroupCollection) ProtoReflect 

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

func (*TaggedAnnotationGroupCollection) Reset 

func (x *TaggedAnnotationGroupCollection) Reset()

func (*TaggedAnnotationGroupCollection) String 

func (x *TaggedAnnotationGroupCollection) String() string

func (*TaggedAnnotationGroupCollection) Validate 

func (this *TaggedAnnotationGroupCollection) Validate() error

type TaggedAnnotationGroupCollection_Data 

type TaggedAnnotationGroupCollection_Data struct {

	// resource name, by default it should be annotation group
	Type  string                 `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Group *TaggedAnnotationGroup `protobuf:"bytes,2,opt,name=group,proto3" json:"group,omitempty"`
	// contains filtered or unexported fields
}

func (*TaggedAnnotationGroupCollection_Data) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotationGroupCollection_Data.ProtoReflect.Descriptor instead.

func (*TaggedAnnotationGroupCollection_Data) GetGroup 

func (x *TaggedAnnotationGroupCollection_Data) GetGroup() *TaggedAnnotationGroup

func (*TaggedAnnotationGroupCollection_Data) GetType 

func (x *TaggedAnnotationGroupCollection_Data) GetType() string

func (*TaggedAnnotationGroupCollection_Data) ProtoMessage 

func (*TaggedAnnotationGroupCollection_Data) ProtoMessage()

func (*TaggedAnnotationGroupCollection_Data) ProtoReflect 

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

func (*TaggedAnnotationGroupCollection_Data) Reset 

func (x *TaggedAnnotationGroupCollection_Data) Reset()

func (*TaggedAnnotationGroupCollection_Data) String 

func (x *TaggedAnnotationGroupCollection_Data) String() string

func (*TaggedAnnotationGroupCollection_Data) Validate 

func (this *TaggedAnnotationGroupCollection_Data) Validate() error

type TaggedAnnotationGroup_Data 

type TaggedAnnotationGroup_Data struct {

	// resource name, by default should be annotation
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// unique identifier for the annotation
	Id         string                      `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	Attributes *TaggedAnnotationAttributes `protobuf:"bytes,3,opt,name=attributes,proto3" json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

func (*TaggedAnnotationGroup_Data) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotationGroup_Data.ProtoReflect.Descriptor instead.

func (*TaggedAnnotationGroup_Data) GetAttributes 

func (x *TaggedAnnotationGroup_Data) GetAttributes() *TaggedAnnotationAttributes

func (*TaggedAnnotationGroup_Data) GetId 

func (x *TaggedAnnotationGroup_Data) GetId() string

func (*TaggedAnnotationGroup_Data) GetType 

func (x *TaggedAnnotationGroup_Data) GetType() string

func (*TaggedAnnotationGroup_Data) ProtoMessage 

func (*TaggedAnnotationGroup_Data) ProtoMessage()

func (*TaggedAnnotationGroup_Data) ProtoReflect 

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

func (*TaggedAnnotationGroup_Data) Reset 

func (x *TaggedAnnotationGroup_Data) Reset()

func (*TaggedAnnotationGroup_Data) String 

func (x *TaggedAnnotationGroup_Data) String() string

func (*TaggedAnnotationGroup_Data) Validate 

func (this *TaggedAnnotationGroup_Data) Validate() error

type TaggedAnnotationServiceClient 

type TaggedAnnotationServiceClient interface {
	// Retrieves the specified tagged annotation
	GetAnnotation(ctx context.Context, in *AnnotationId, opts ...grpc.CallOption) (*TaggedAnnotation, error)
	// Retrieves a single tagged annotation associated with a specific entry
	GetEntryAnnotation(ctx context.Context, in *EntryAnnotationRequest, opts ...grpc.CallOption) (*TaggedAnnotation, error)
	// List tagged annotations using pagination, ten entries are retrieved by default
	ListAnnotations(ctx context.Context, in *ListParameters, opts ...grpc.CallOption) (*TaggedAnnotationCollection, error)
	// Create a tagged annotation
	CreateAnnotation(ctx context.Context, in *NewTaggedAnnotation, opts ...grpc.CallOption) (*TaggedAnnotation, error)
	// Update an existing annotation, in this case a new annotation entry is
	// created with a link to the previous annotation(copy on write).
	UpdateAnnotation(ctx context.Context, in *TaggedAnnotationUpdate, opts ...grpc.CallOption) (*TaggedAnnotation, error)
	// Delete an existing annotation
	DeleteAnnotation(ctx context.Context, in *DeleteAnnotationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Creates an annotation group from bunch of existing tagged annotations.
	CreateAnnotationGroup(ctx context.Context, in *AnnotationIdList, opts ...grpc.CallOption) (*TaggedAnnotationGroup, error)
	// Retrieves an annotation group
	GetAnnotationGroup(ctx context.Context, in *GroupEntryId, opts ...grpc.CallOption) (*TaggedAnnotationGroup, error)
	// Adds an existing annotation into an existing annotation group
	AddToAnnotationGroup(ctx context.Context, in *AnnotationGroupId, opts ...grpc.CallOption) (*TaggedAnnotationGroup, error)
	// Remove an annotation group
	DeleteAnnotationGroup(ctx context.Context, in *GroupEntryId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// List tagged annotation groups using pagination, ten entries are retrieved by default
	ListAnnotationGroups(ctx context.Context, in *ListGroupParameters, opts ...grpc.CallOption) (*TaggedAnnotationGroupCollection, error)
	// Retrieves tag information
	GetAnnotationTag(ctx context.Context, in *TagRequest, opts ...grpc.CallOption) (*AnnotationTag, error)
	// Upload obojson formatted file through client side streaming
	OboJSONFileUpload(ctx context.Context, opts ...grpc.CallOption) (TaggedAnnotationService_OboJSONFileUploadClient, error)
}

TaggedAnnotationServiceClient is the client API for TaggedAnnotationService 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 NewTaggedAnnotationServiceClient 

func NewTaggedAnnotationServiceClient(cc grpc.ClientConnInterface) TaggedAnnotationServiceClient

type TaggedAnnotationServiceServer 

type TaggedAnnotationServiceServer interface {
	// Retrieves the specified tagged annotation
	GetAnnotation(context.Context, *AnnotationId) (*TaggedAnnotation, error)
	// Retrieves a single tagged annotation associated with a specific entry
	GetEntryAnnotation(context.Context, *EntryAnnotationRequest) (*TaggedAnnotation, error)
	// List tagged annotations using pagination, ten entries are retrieved by default
	ListAnnotations(context.Context, *ListParameters) (*TaggedAnnotationCollection, error)
	// Create a tagged annotation
	CreateAnnotation(context.Context, *NewTaggedAnnotation) (*TaggedAnnotation, error)
	// Update an existing annotation, in this case a new annotation entry is
	// created with a link to the previous annotation(copy on write).
	UpdateAnnotation(context.Context, *TaggedAnnotationUpdate) (*TaggedAnnotation, error)
	// Delete an existing annotation
	DeleteAnnotation(context.Context, *DeleteAnnotationRequest) (*emptypb.Empty, error)
	// Creates an annotation group from bunch of existing tagged annotations.
	CreateAnnotationGroup(context.Context, *AnnotationIdList) (*TaggedAnnotationGroup, error)
	// Retrieves an annotation group
	GetAnnotationGroup(context.Context, *GroupEntryId) (*TaggedAnnotationGroup, error)
	// Adds an existing annotation into an existing annotation group
	AddToAnnotationGroup(context.Context, *AnnotationGroupId) (*TaggedAnnotationGroup, error)
	// Remove an annotation group
	DeleteAnnotationGroup(context.Context, *GroupEntryId) (*emptypb.Empty, error)
	// List tagged annotation groups using pagination, ten entries are retrieved by default
	ListAnnotationGroups(context.Context, *ListGroupParameters) (*TaggedAnnotationGroupCollection, error)
	// Retrieves tag information
	GetAnnotationTag(context.Context, *TagRequest) (*AnnotationTag, error)
	// Upload obojson formatted file through client side streaming
	OboJSONFileUpload(TaggedAnnotationService_OboJSONFileUploadServer) error
	// contains filtered or unexported methods
}

TaggedAnnotationServiceServer is the server API for TaggedAnnotationService service. All implementations must embed UnimplementedTaggedAnnotationServiceServer for forward compatibility

type TaggedAnnotationService_OboJSONFileUploadClient 

type TaggedAnnotationService_OboJSONFileUploadClient interface {
	Send(*upload.FileUploadRequest) error
	CloseAndRecv() (*upload.FileUploadResponse, error)
	grpc.ClientStream
}

type TaggedAnnotationService_OboJSONFileUploadServer 

type TaggedAnnotationService_OboJSONFileUploadServer interface {
	SendAndClose(*upload.FileUploadResponse) error
	Recv() (*upload.FileUploadRequest, error)
	grpc.ServerStream
}

type TaggedAnnotationUpdate 

type TaggedAnnotationUpdate struct {
	Data *TaggedAnnotationUpdate_Data `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Definition for updating an existing annotation

func (*TaggedAnnotationUpdate) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotationUpdate.ProtoReflect.Descriptor instead.

func (*TaggedAnnotationUpdate) GetData 

func (x *TaggedAnnotationUpdate) GetData() *TaggedAnnotationUpdate_Data

func (*TaggedAnnotationUpdate) ProtoMessage 

func (*TaggedAnnotationUpdate) ProtoMessage()

func (*TaggedAnnotationUpdate) ProtoReflect 

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

func (*TaggedAnnotationUpdate) Reset 

func (x *TaggedAnnotationUpdate) Reset()

func (*TaggedAnnotationUpdate) String 

func (x *TaggedAnnotationUpdate) String() string

func (*TaggedAnnotationUpdate) Validate 

func (this *TaggedAnnotationUpdate) Validate() error

type TaggedAnnotationUpdateAttributes 

type TaggedAnnotationUpdateAttributes struct {

	// annotation in plain text format
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// serialized text content in a format recognized by frontend rich text
	// editor
	EditableValue string `protobuf:"bytes,2,opt,name=editable_value,json=editableValue,proto3" json:"editable_value,omitempty"`
	// Unique identifier(generally email) of the user who created the annotation
	CreatedBy string `protobuf:"bytes,3,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// contains filtered or unexported fields
}

TaggedUpdateAnnotation defines attributes for updating an existing annotation

func (*TaggedAnnotationUpdateAttributes) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotationUpdateAttributes.ProtoReflect.Descriptor instead.

func (*TaggedAnnotationUpdateAttributes) GetCreatedBy 

func (x *TaggedAnnotationUpdateAttributes) GetCreatedBy() string

func (*TaggedAnnotationUpdateAttributes) GetEditableValue 

func (x *TaggedAnnotationUpdateAttributes) GetEditableValue() string

func (*TaggedAnnotationUpdateAttributes) GetValue 

func (x *TaggedAnnotationUpdateAttributes) GetValue() string

func (*TaggedAnnotationUpdateAttributes) ProtoMessage 

func (*TaggedAnnotationUpdateAttributes) ProtoMessage()

func (*TaggedAnnotationUpdateAttributes) ProtoReflect 

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

func (*TaggedAnnotationUpdateAttributes) Reset 

func (x *TaggedAnnotationUpdateAttributes) Reset()

func (*TaggedAnnotationUpdateAttributes) String 

func (x *TaggedAnnotationUpdateAttributes) String() string

func (*TaggedAnnotationUpdateAttributes) Validate 

func (this *TaggedAnnotationUpdateAttributes) Validate() error

type TaggedAnnotationUpdate_Data 

type TaggedAnnotationUpdate_Data struct {

	// resource name, by default should be annotation
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// unique identifier for the annotation
	Id         string                            `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	Attributes *TaggedAnnotationUpdateAttributes `protobuf:"bytes,3,opt,name=attributes,proto3" json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

func (*TaggedAnnotationUpdate_Data) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotationUpdate_Data.ProtoReflect.Descriptor instead.

func (*TaggedAnnotationUpdate_Data) GetAttributes 

func (x *TaggedAnnotationUpdate_Data) GetAttributes() *TaggedAnnotationUpdateAttributes

func (*TaggedAnnotationUpdate_Data) GetId 

func (x *TaggedAnnotationUpdate_Data) GetId() string

func (*TaggedAnnotationUpdate_Data) GetType 

func (x *TaggedAnnotationUpdate_Data) GetType() string

func (*TaggedAnnotationUpdate_Data) ProtoMessage 

func (*TaggedAnnotationUpdate_Data) ProtoMessage()

func (*TaggedAnnotationUpdate_Data) ProtoReflect 

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

func (*TaggedAnnotationUpdate_Data) Reset 

func (x *TaggedAnnotationUpdate_Data) Reset()

func (*TaggedAnnotationUpdate_Data) String 

func (x *TaggedAnnotationUpdate_Data) String() string

func (*TaggedAnnotationUpdate_Data) Validate 

func (this *TaggedAnnotationUpdate_Data) Validate() error

type TaggedAnnotation_Data 

type TaggedAnnotation_Data struct {

	// resource name, by default should be annotation
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// unique identifier for the annotation
	Id         string                      `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	Attributes *TaggedAnnotationAttributes `protobuf:"bytes,3,opt,name=attributes,proto3" json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

func (*TaggedAnnotation_Data) Descriptor deprecated 

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

Deprecated: Use TaggedAnnotation_Data.ProtoReflect.Descriptor instead.

func (*TaggedAnnotation_Data) GetAttributes 

func (x *TaggedAnnotation_Data) GetAttributes() *TaggedAnnotationAttributes

func (*TaggedAnnotation_Data) GetId 

func (x *TaggedAnnotation_Data) GetId() string

func (*TaggedAnnotation_Data) GetType 

func (x *TaggedAnnotation_Data) GetType() string

func (*TaggedAnnotation_Data) ProtoMessage 

func (*TaggedAnnotation_Data) ProtoMessage()

func (*TaggedAnnotation_Data) ProtoReflect 

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

func (*TaggedAnnotation_Data) Reset 

func (x *TaggedAnnotation_Data) Reset()

func (*TaggedAnnotation_Data) String 

func (x *TaggedAnnotation_Data) String() string

func (*TaggedAnnotation_Data) Validate 

func (this *TaggedAnnotation_Data) Validate() error

type UnimplementedTaggedAnnotationServiceServer 

type UnimplementedTaggedAnnotationServiceServer struct {
}

UnimplementedTaggedAnnotationServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedTaggedAnnotationServiceServer) AddToAnnotationGroup 

func (UnimplementedTaggedAnnotationServiceServer) AddToAnnotationGroup(context.Context, *AnnotationGroupId) (*TaggedAnnotationGroup, error)

func (UnimplementedTaggedAnnotationServiceServer) CreateAnnotation 

func (UnimplementedTaggedAnnotationServiceServer) CreateAnnotation(context.Context, *NewTaggedAnnotation) (*TaggedAnnotation, error)

func (UnimplementedTaggedAnnotationServiceServer) CreateAnnotationGroup 

func (UnimplementedTaggedAnnotationServiceServer) CreateAnnotationGroup(context.Context, *AnnotationIdList) (*TaggedAnnotationGroup, error)

func (UnimplementedTaggedAnnotationServiceServer) DeleteAnnotation 

func (UnimplementedTaggedAnnotationServiceServer) DeleteAnnotation(context.Context, *DeleteAnnotationRequest) (*emptypb.Empty, error)

func (UnimplementedTaggedAnnotationServiceServer) DeleteAnnotationGroup 

func (UnimplementedTaggedAnnotationServiceServer) DeleteAnnotationGroup(context.Context, *GroupEntryId) (*emptypb.Empty, error)

func (UnimplementedTaggedAnnotationServiceServer) GetAnnotation 

func (UnimplementedTaggedAnnotationServiceServer) GetAnnotation(context.Context, *AnnotationId) (*TaggedAnnotation, error)

func (UnimplementedTaggedAnnotationServiceServer) GetAnnotationGroup 

func (UnimplementedTaggedAnnotationServiceServer) GetAnnotationGroup(context.Context, *GroupEntryId) (*TaggedAnnotationGroup, error)

func (UnimplementedTaggedAnnotationServiceServer) GetAnnotationTag 

func (UnimplementedTaggedAnnotationServiceServer) GetAnnotationTag(context.Context, *TagRequest) (*AnnotationTag, error)

func (UnimplementedTaggedAnnotationServiceServer) GetEntryAnnotation 

func (UnimplementedTaggedAnnotationServiceServer) GetEntryAnnotation(context.Context, *EntryAnnotationRequest) (*TaggedAnnotation, error)

func (UnimplementedTaggedAnnotationServiceServer) ListAnnotationGroups 

func (UnimplementedTaggedAnnotationServiceServer) ListAnnotationGroups(context.Context, *ListGroupParameters) (*TaggedAnnotationGroupCollection, error)

func (UnimplementedTaggedAnnotationServiceServer) ListAnnotations 

func (UnimplementedTaggedAnnotationServiceServer) ListAnnotations(context.Context, *ListParameters) (*TaggedAnnotationCollection, error)

func (UnimplementedTaggedAnnotationServiceServer) OboJSONFileUpload 

func (UnimplementedTaggedAnnotationServiceServer) OboJSONFileUpload(TaggedAnnotationService_OboJSONFileUploadServer) error

func (UnimplementedTaggedAnnotationServiceServer) UpdateAnnotation 

func (UnimplementedTaggedAnnotationServiceServer) UpdateAnnotation(context.Context, *TaggedAnnotationUpdate) (*TaggedAnnotation, error)

type UnsafeTaggedAnnotationServiceServer 

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

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

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.