annotations

Protocol buffer definition for annotations

sift/annotations/v1/annotations.proto

Annotation

FieldTypeLabelDescription
annotation_idstring
namestring
descriptionstring
start_timegoogle.protobuf.Timestamp
end_timegoogle.protobuf.Timestamp
created_by_user_idstring
modified_by_user_idstring
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
run_idstringoptional
stateAnnotationStateoptional
organization_idstring
assigned_to_user_idstring
annotation_typeAnnotationType
tagsstringrepeated
legend_configstringoptional
created_by_condition_idstringoptional
created_by_rule_condition_version_idstringoptional
report_rule_version_idstringoptional

AnnotationLinkedChannel

FieldTypeLabelDescription
channelAnnotationLinkedChannelsChannel
bit_field_elementAnnotationLinkedChannelsBitFieldElement

AnnotationLinkedChannelsBitFieldElement

FieldTypeLabelDescription
channel_idstring
bit_field_namestring

AnnotationLinkedChannelsChannel

FieldTypeLabelDescription
channel_idstring

BatchDeleteAnnotationsRequest

FieldTypeLabelDescription
annotation_idsstringrepeatedLimit 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.

FieldTypeLabelDescription
namestringThe name assigned to the new annotation.
descriptionstringA short description about the new annotation.
start_timegoogle.protobuf.TimestampWhen the annotation starts.
end_timegoogle.protobuf.TimestampWhen the annotation ends.
assetsstringrepeatedThe names of the assets to associate with this annotation.
linked_channelsAnnotationLinkedChannelrepeatedThe channels to associate with this annotation.
tagsstringrepeatedThe names of the tags to associate with this annotation.
run_idstringoptionalThe ID of the run that this annotation is associated with.
assign_to_user_idstringoptionalThe ID of the user that this annotation is assigned to.
organization_idstringThe organization associated with this annotation. An organization ID is only required if the user belongs to multiple organizations.
stateAnnotationStateoptionalThe 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_typeAnnotationTypeThe type of the annotation.
created_by_condition_idstringoptionalThe ID of the rule condition that created this annotation.
legend_configstringoptionalA JSON string containing the axes configuration of the annotation's linked channels.
created_by_rule_condition_version_idstringoptionalThe ID of the rule condition version that created this annotation.

CreateAnnotationResponse

The result of a call to AnnotationService_CreateAnnotation.

FieldTypeLabelDescription
annotationAnnotation

DeleteAnnotationRequest

The request for a call to AnnotationService_DeleteAnnotation.

FieldTypeLabelDescription
annotation_idstring

DeleteAnnotationResponse

The response of a call to AnnotationService_DeleteAnnotation.

GetAnnotationRequest

The request for a call to AnnotationService_GetAnnotation.

FieldTypeLabelDescription
annotation_idstring

GetAnnotationResponse

The response of a call to AnnotationService_GetAnnotation.

FieldTypeLabelDescription
annotationAnnotation

ListAnnotationsRequest

The request for a call to AnnotationService_ListAnnotations to retrieve annotations.

FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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.
filterstringA 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, and assignee. 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_idstringThis field is only required if your user belongs to multiple organizations.
order_bystringHow 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, and end_time. If left empty, items are ordered by created_date in ascending order (oldest-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.

FieldTypeLabelDescription
annotationsAnnotationrepeated
next_page_tokenstringOops, 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.

FieldTypeLabelDescription
annotationAnnotationThe annotation to update.
update_maskgoogle.protobuf.FieldMaskThe list of fields to be updated. The fields available to be updated are name, description, start_time, end_time, assigned_to_user_id, state, and tags. 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.

FieldTypeLabelDescription
annotationAnnotation

AnnotationState

NameNumberDescription
ANNOTATION_STATE_UNSPECIFIED0
ANNOTATION_STATE_OPEN1
ANNOTATION_STATE_FLAGGED2
ANNOTATION_STATE_RESOLVED3

AnnotationType

NameNumberDescription
ANNOTATION_TYPE_UNSPECIFIED0
ANNOTATION_TYPE_DATA_REVIEW1
ANNOTATION_TYPE_PHASE2

AnnotationService

Method NameRequest TypeResponse TypeDescription
CreateAnnotationCreateAnnotationRequestCreateAnnotationResponseCreates an annotation.
DeleteAnnotationDeleteAnnotationRequestDeleteAnnotationResponseDeletes an annotation.
BatchDeleteAnnotationsBatchDeleteAnnotationsRequestBatchDeleteAnnotationsResponseBatch deletes annotations.
ListAnnotationsListAnnotationsRequestListAnnotationsResponseRetrieves annotations using an optional filter.
GetAnnotationGetAnnotationRequestGetAnnotationResponseRetrieves an annotation
UpdateAnnotationUpdateAnnotationRequestUpdateAnnotationResponseUpdates an existing annotation using using the list of fields specified in update_mask.

On this page