annotations

sift/annotations/v1/annotations.proto

Annotation

Field	Type	Label	Description
annotation_id	string
name	string
description	string
start_time	google.protobuf.Timestamp
end_time	google.protobuf.Timestamp
created_by_user_id	string
modified_by_user_id	string
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
run_id	string	optional
state	AnnotationState	optional
organization_id	string
assigned_to_user_id	string
annotation_type	AnnotationType
tags	string	repeated
legend_config	string	optional
created_by_condition_id	string	optional
created_by_rule_condition_version_id	string	optional
report_rule_version_id	string	optional
pending	bool		An annotation is pending if it is part of an ongoing violation of a rule condition. The `end_time` of a pending annotation might be set, but is not yet finalized.
assigned_to_user	sift.common.type.v1.User
deleted_date	google.protobuf.Timestamp
linked_channels	AnnotationLinkedChannel	repeated
asset_ids	string	repeated
metadata	sift.metadata.v1.MetadataValue	repeated

AnnotationLinkedChannel

Field	Type	Label	Description
oneof type.channel	AnnotationLinkedChannelsChannel
oneof type.bit_field_element	AnnotationLinkedChannelsBitFieldElement

AnnotationLinkedChannelsBitFieldElement

Field	Type	Label	Description
channel_id	string
bit_field_name	string

AnnotationLinkedChannelsChannel

Field	Type	Label	Description
channel_id	string

BatchDeleteAnnotationsRequest

Field	Type	Label	Description
annotation_ids	string	repeated	Limit of 1000 annotations per batch

BatchDeleteAnnotationsResponse

CreateAnnotationRequest

The request for a call to AnnotationService_CreateAnnotation to create a new annotation. At least 1 asset, tag, or channel must be specified.

Field	Type	Label	Description
name	string		The name assigned to the new annotation.
description	string		A short description about the new annotation.
start_time	google.protobuf.Timestamp		When the annotation starts.
end_time	google.protobuf.Timestamp		When the annotation ends.
assets	string	repeated	The names of the assets to associate with this annotation.
linked_channels	AnnotationLinkedChannel	repeated	The channels to associate with this annotation.
tags	string	repeated	The names of the tags to associate with this annotation.
run_id	string	optional	The ID of the run that this annotation is associated with.
assign_to_user_id	string	optional	The ID of the user that this annotation is assigned to.
organization_id	string		The organization associated with this annotation. An organization ID is only required if the user belongs to multiple organizations.
state	AnnotationState	optional	The state of the annotation. If an annotation has an `annotation_type` of `ANNOTATION_TYPE_PHASE`, then state must be unset, otherwise an error will be returned.
annotation_type	AnnotationType		The type of the annotation.
created_by_condition_id	string	optional	The ID of the rule condition that created this annotation.
legend_config	string	optional	A JSON string containing the axes configuration of the annotation's linked channels.
created_by_rule_condition_version_id	string	optional	The ID of the rule condition version that created this annotation.
metadata	sift.metadata.v1.MetadataValue	repeated	The metadata associated with this annotation.

CreateAnnotationResponse

The result of a call to AnnotationService_CreateAnnotation.

Field	Type	Label	Description
annotation	Annotation

DeleteAnnotationRequest

The request for a call to AnnotationService_DeleteAnnotation.

Field	Type	Label	Description
annotation_id	string

DeleteAnnotationResponse

The response of a call to AnnotationService_DeleteAnnotation.

GetAnnotationRequest

The request for a call to AnnotationService_GetAnnotation.

Field	Type	Label	Description
annotation_id	string

GetAnnotationResponse

The response of a call to AnnotationService_GetAnnotation.

Field	Type	Label	Description
annotation	Annotation

ListAnnotationsRequest

The request for a call to AnnotationService_ListAnnotations to retrieve annotations.

Field	Type	Description
page_size	uint32	The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListAnnotations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnnotations` must match the call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `annotation_id`, `start_time`, `end_time`, `created_date`, `modified_date`, `run_id`, `name`, `description`, `state`, `created_by_user_id`, `created_by_rule_condition_version_id`, `annotation_type`, `tag_name`, `report_id`, `asset_id`, `asset_name`, `pending`, `assignee`, `campaign_reports`, and `metadata`. 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.
organization_id	string	This field is only required if your user belongs to multiple organizations.
order_by	string	How to order the retrieved annotations. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are `created_date`, `modified_date`, `start_time`, `end_time`, `name`, and `description`. If left empty, items are ordered by `created_date` in descending order (newest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

ListAnnotationsResponse

The result of a call to AnnotationService_ListAnnotations.

Field	Type	Label	Description
annotations	Annotation	repeated
next_page_token	string		Oops, we skipped to index 5! No reason for that; the indices between aren't reserved or anything.

UpdateAnnotationRequest

The request for a call to AnnotationService_UpdateAnnotation to update an annotation.

Field	Type	Label	Description
annotation	Annotation		The annotation to update.
update_mask	google.protobuf.FieldMask		The list of fields to be updated. The fields available to be updated are `name`, `description`, `start_time`, `end_time`, `assigned_to_user_id`, `state`, `tags`, `legend_config`, `linked_channels`, and `metadata`. Important Note: if `tags` is specified in the update mask and `annotation.tags` is an empty list then all associated tags on the annotation will be removed.

UpdateAnnotationResponse

The response of a call to AnnotationService_UpdateAnnotation.

Field	Type	Label	Description
annotation	Annotation

AnnotationState

Name	Number	Description
ANNOTATION_STATE_UNSPECIFIED	0
ANNOTATION_STATE_OPEN	1
ANNOTATION_STATE_FLAGGED	2
ANNOTATION_STATE_RESOLVED	3

AnnotationType

Name	Number	Description
ANNOTATION_TYPE_UNSPECIFIED	0
ANNOTATION_TYPE_DATA_REVIEW	1
ANNOTATION_TYPE_PHASE	2

AnnotationService

Method Name	Request Type	Response Type	Description
CreateAnnotation	CreateAnnotationRequest	CreateAnnotationResponse	Creates an annotation.
DeleteAnnotation	DeleteAnnotationRequest	DeleteAnnotationResponse	Delete Annotation is deprecated. Calling this will archive the annotation, which should be done using the UpdateAnnotation method with the delete date set to a non-null value. Restoring an annotation can be done by calling UpdateAnnotation with the delete date set to a null value.
BatchDeleteAnnotations	BatchDeleteAnnotationsRequest	BatchDeleteAnnotationsResponse	BatchDeleteAnnotations will archive the annotations specified in the request. These can be restored by calling UpdateAnnotation with the delete date set to a null value.
ListAnnotations	ListAnnotationsRequest	ListAnnotationsResponse	Retrieves annotations using an optional filter.
GetAnnotation	GetAnnotationRequest	GetAnnotationResponse	Retrieves an annotation
UpdateAnnotation	UpdateAnnotationRequest	UpdateAnnotationResponse	Updates an existing annotation using using the list of fields specified in `update_mask`.

On this page