annotation_logs

Protocol buffer definition for annotation_logs

sift/annotation_logs/v1/annotation_logs.proto

AnnotationCommentBodyElement

FieldTypeLabelDescription
typeAnnotationCommentBodyElementType
textstring
user_mentionAnnotationCommentUserMention

AnnotationCommentUserMention

FieldTypeLabelDescription
user_idstring
user_emailstring

AnnotationLogAssignedProperties

FieldTypeLabelDescription
assigned_to_user_idstring
assigned_to_user_emailstring

AnnotationLogCommentProperties

FieldTypeLabelDescription
bodyAnnotationCommentBodyElementrepeated

AnnotationLogSearchResult

FieldTypeLabelDescription
annotation_log_idstring
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
annotation_idstring
kindAnnotationLogKind
created_by_user_idstring
created_by_user_namestring
assignedAnnotationLogAssignedProperties
state_updateAnnotationLogStateUpdateProperties
commentAnnotationLogCommentProperties

AnnotationLogStateUpdateProperties

FieldTypeLabelDescription
stateAnnotationLogState

CreateAnnotationLogRequest

The request for a call to AnnotationLogService_CreateAnnotationLog to create an annotation log.

FieldTypeLabelDescription
annotation_idstringThe ID of the parent annotation associated to associate with the new annotation log.
kindAnnotationLogKindThe kind of annotation log to create.
assignedAnnotationLogAssignedProperties
state_updateAnnotationLogStateUpdateProperties
commentAnnotationLogCommentProperties

CreateAnnotationLogResponse

The response of a call to AnnotationLogService_CreateAnnotationLog.

FieldTypeLabelDescription
annotation_logAnnotationLogSearchResult

DeleteAnnotationLogRequest

The request for a call to AnnotationLogService_DeleteAnnotationLog to delete an annotation log.

FieldTypeLabelDescription
annotation_idstringThe ID of the parent annotation associated with the annotation log to be deleted.
annotation_log_idstringID of the annotation log to be deleted.

DeleteAnnotationLogResponse

The Response of a call to AnnotationLogService_DeleteAnnotationLog.

ListAnnotationLogsRequest

The request for a call to AnnotationLogService_ListAnnotationLogs to retrieve annotation logs.

FieldTypeLabelDescription
annotation_idstringThe ID of the parent annotation associated with the annotation logs.
page_sizeuint32The maximum number of annotation logs to return. The service may return fewer than this value. If unspecified, at most 50 annotation logs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_tokenstringA page token, received from a previous ListAnnotationLogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAnnotationLogs must match the call that provided the page token.
filterstringA Common Expression Language (CEL) filter string. Available fields to filter by are annotation_log_id, annotation_id, created_by_user_id, created_date, modified_date, and kind. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

ListAnnotationLogsResponse

The response of a call to AnnotationLogService_ListAnnotationLogs.

FieldTypeLabelDescription
annotation_logsAnnotationLogSearchResultrepeated
next_page_tokenstring

AnnotationCommentBodyElementType

NameNumberDescription
ANNOTATION_COMMENT_BODY_ELEMENT_TYPE_UNSPECIFIED0
ANNOTATION_COMMENT_BODY_ELEMENT_TYPE_TEXT1
ANNOTATION_COMMENT_BODY_ELEMENT_TYPE_USER_MENTION2

AnnotationLogKind

NameNumberDescription
ANNOTATION_LOG_KIND_UNSPECIFIED0
ANNOTATION_LOG_KIND_COMMENT1
ANNOTATION_LOG_KIND_STATE_UPDATE2
ANNOTATION_LOG_KIND_ASSIGNED3

AnnotationLogState

NameNumberDescription
ANNOTATION_LOG_STATE_UNSPECIFIED0
ANNOTATION_LOG_STATE_CREATED1
ANNOTATION_LOG_STATE_OPEN2
ANNOTATION_LOG_STATE_FLAGGED3
ANNOTATION_LOG_STATE_RESOLVED4

AnnotationLogService

Method NameRequest TypeResponse TypeDescription
CreateAnnotationLogCreateAnnotationLogRequestCreateAnnotationLogResponseCreates an annotation log on an annotation.
ListAnnotationLogsListAnnotationLogsRequestListAnnotationLogsResponseRetrieves annotation logs using an optional filter.
DeleteAnnotationLogDeleteAnnotationLogRequestDeleteAnnotationLogResponseDeletes an annotation log.

On this page