annotation_logs

Services

RPC methods exposed by this API.

AnnotationLogService

Method	Request	Response	Description
CreateAnnotationLog	CreateAnnotationLogRequest	CreateAnnotationLogResponse	Creates an annotation log on an annotation.
ListAnnotationLogs	ListAnnotationLogsRequest	ListAnnotationLogsResponse	Retrieves annotation logs using an optional filter.
DeleteAnnotationLog	DeleteAnnotationLogRequest	DeleteAnnotationLogResponse	Deletes an annotation log.

Messages

Data models used across requests/responses.

AnnotationCommentBodyElement

Field	Type	Label	Description
type	AnnotationCommentBodyElementType
text	string
user_mention	AnnotationCommentUserMention

AnnotationCommentUserMention

Field	Type	Label	Description
user_id	string
user_email	string

AnnotationLogAssignedProperties

Field	Type	Label	Description
assigned_to_user_id	string
assigned_to_user_email	string

AnnotationLogCommentProperties

Field	Type	Label	Description
body	AnnotationCommentBodyElement	repeated

AnnotationLogSearchResult

Field	Type	Label	Description
annotation_log_id	string
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
annotation_id	string
kind	AnnotationLogKind
created_by_user_id	string
created_by_user_name	string
oneof properties. assigned	AnnotationLogAssignedProperties
oneof properties. state_update	AnnotationLogStateUpdateProperties
oneof properties. comment	AnnotationLogCommentProperties

AnnotationLogStateUpdateProperties

Field	Type	Label	Description
state	AnnotationLogState

CreateAnnotationLogRequest

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

Field	Type	Description
annotation_id	string	The ID of the parent annotation associated to associate with the new annotation log.
kind	AnnotationLogKind	The kind of annotation log to create.
oneof properties. assigned	AnnotationLogAssignedProperties
oneof properties. state_update	AnnotationLogStateUpdateProperties
oneof properties. comment	AnnotationLogCommentProperties

CreateAnnotationLogResponse

The response of a call to AnnotationLogService_CreateAnnotationLog.

Field	Type	Label	Description
annotation_log	AnnotationLogSearchResult

DeleteAnnotationLogRequest

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

Field	Type	Label	Description
annotation_id	string		The ID of the parent annotation associated with the annotation log to be deleted.
annotation_log_id	string		ID of the annotation log to be deleted.

DeleteAnnotationLogResponse

The Response of a call to AnnotationLogService_DeleteAnnotationLog. This message has no fields.

ListAnnotationLogsRequest

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

Field	Type	Description
annotation_id	string	The ID of the parent annotation associated with the annotation logs.
page_size	uint32	The 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_token	string	A 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.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `annotation_log_id`, `annotation_id`, `created_by_user_id`, `annotation_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.

Field	Type	Label	Description
annotation_logs	AnnotationLogSearchResult	repeated
next_page_token	string

Enums

Allowed constant values used in message fields.

AnnotationCommentBodyElementType

Name	Number	Description
ANNOTATION_COMMENT_BODY_ELEMENT_TYPE_UNSPECIFIED	0
ANNOTATION_COMMENT_BODY_ELEMENT_TYPE_TEXT	1
ANNOTATION_COMMENT_BODY_ELEMENT_TYPE_USER_MENTION	2

AnnotationLogKind

Name	Number	Description
ANNOTATION_LOG_KIND_UNSPECIFIED	0
ANNOTATION_LOG_KIND_COMMENT	1
ANNOTATION_LOG_KIND_STATE_UPDATE	2
ANNOTATION_LOG_KIND_ASSIGNED	3

AnnotationLogState

Name	Number	Description
ANNOTATION_LOG_STATE_UNSPECIFIED	0
ANNOTATION_LOG_STATE_CREATED	1
ANNOTATION_LOG_STATE_OPEN	2
ANNOTATION_LOG_STATE_FLAGGED	3
ANNOTATION_LOG_STATE_RESOLVED	4

Authenticate

Clients

Review

Export

Reference

annotation_logs

Services

AnnotationLogService

Messages

AnnotationCommentBodyElement

AnnotationCommentUserMention

AnnotationLogAssignedProperties

AnnotationLogCommentProperties

AnnotationLogSearchResult

AnnotationLogStateUpdateProperties

CreateAnnotationLogRequest

CreateAnnotationLogResponse

DeleteAnnotationLogRequest

DeleteAnnotationLogResponse

ListAnnotationLogsRequest

ListAnnotationLogsResponse

Enums

AnnotationCommentBodyElementType

AnnotationLogKind

AnnotationLogState

​Services

​AnnotationLogService

​Messages

​AnnotationCommentBodyElement

​AnnotationCommentUserMention

​AnnotationLogAssignedProperties

​AnnotationLogCommentProperties

​AnnotationLogSearchResult

​AnnotationLogStateUpdateProperties

​CreateAnnotationLogRequest

​CreateAnnotationLogResponse

​DeleteAnnotationLogRequest

​DeleteAnnotationLogResponse

​ListAnnotationLogsRequest

​ListAnnotationLogsResponse

​Enums

​AnnotationCommentBodyElementType

​AnnotationLogKind

​AnnotationLogState

Services

AnnotationLogService

Messages

AnnotationCommentBodyElement

AnnotationCommentUserMention

AnnotationLogAssignedProperties

AnnotationLogCommentProperties

AnnotationLogSearchResult

AnnotationLogStateUpdateProperties

CreateAnnotationLogRequest

CreateAnnotationLogResponse

DeleteAnnotationLogRequest

DeleteAnnotationLogResponse

ListAnnotationLogsRequest

ListAnnotationLogsResponse

Enums

AnnotationCommentBodyElementType

AnnotationLogKind

AnnotationLogState